ClassType HTMLWriter

Call Graph

Construct a new HTML writer, using the given documentation index.

Parameters:

• docindex - The documentation index.
• prj_name (string) - The name of the project. Defaults to none.
• prj_url (string) - The target for the project hopeage link on the navigation bar. If prj_url is not specified, then no hyperlink is created.
• prj_link (string) - The label for the project link on the navigation bar. This link can contain arbitrary HTML code (e.g. images). By default, a label is constructed from prj_name.
• top_page (string) - The top page for the documentation. This is the default page shown main frame, when frames are enabled. top can be a URL, the name of a module, the name of a class, or one of the special strings "trees.html", "indices.html", or "help.html". By default, the top-level package or module is used, if there is one; otherwise, "trees" is used.
• css (string) - The CSS stylesheet file. If css is a file name, then the specified file's conents will be used. Otherwise, if css is the name of a CSS stylesheet in epydoc.docwriter.html_css, then that stylesheet will be used. Otherwise, an error is reported. If no stylesheet is specified, then the default stylesheet is used.
• help_file (string) - The name of the help file. If no help file is specified, then the default help file will be used.
• show_private (boolean) - Whether to create documentation for private objects. By default, private objects are documented.
• show_frames (boolean)) - Whether to create a frames-based table of contents. By default, it is produced.
• show_imports (boolean) - Whether or not to display lists of imported functions and classes. By default, they are not shown.
• variable_maxlines (int) - The maximum number of lines that should be displayed for the value of a variable in the variable details section. By default, 8 lines are displayed.
• variable_linelength (int) - The maximum line length used for displaying the values of variables in the variable details sections. If a line is longer than this length, then it will be wrapped to the next line. The default line length is 70 characters.
• variable_summary_linelength (int) - The maximum line length used for displaying the values of variables in the summary section. If a line is longer than this length, then it will be truncated. The default is 40 characters.
• variable_tooltip_linelength (int) - The maximum line length used for tooltips for the values of variables. If a line is longer than this length, then it will be truncated. The default is 600 characters.
• property_function_linelength (int) - The maximum line length used to dispaly property functions (fget, fset, and fdel) that contain something other than a function object. The default length is 40 characters.
• inheritance (string) - How inherited objects should be displayed. If inheritance='grouped', then inherited objects are gathered into groups; if inheritance='listed', then inherited objects are listed in a short list at the end of their group; if inheritance='included', then inherited objects are mixed in with non-inherited objects. The default is 'grouped'.
• include_source_code (boolean) - If true, then generate colorized source code files for each python module.
• include_log (boolean) - If true, the the footer will include an href to the page 'epydoc-log.html'.
• include_timestamp (boolean) - If true, then include a timestamp in the footer.
• src_code_tab_width (int) - Number of spaces to replace each tab with in source code listings.

Call Graph

Write the documentation to the given directory.

Parameters:

• directory (string) - The directory to which output should be written. If no directory is specified, output will be written to the current directory. If the directory does not exist, it will be created.

Returns: None

Raises:

• OSError - If directory cannot be created.
• OSError - If any file cannot be created or written to.

Call Graph

Write an HTML page containing the API documentation for the given module to out.

Parameters:

• doc - A ModuleDoc containing the API documentation for the module that should be described.

Call Graph

Write an HTML page containing the API documentation for the given class to out.

Parameters:

• doc - A ClassDoc containing the API documentation for the class that should be described.

Call Graph

Write HTML code for a class tree graph of doc (a classdoc), using graphmaker to draw the actual graph. graphmaker should be class_tree_graph(), or uml_class_tree_graph(), or any other function with a compatible signature.

If the given class has any private sublcasses (including recursive subclasses), then two graph images will be generated -- one to display when private values are shown, and the other to display when private values are hidden.

Call Graph

Write HTML code for a nested list showing the base/subclass relationships between all documented classes. Each element of the top-level list is a class with no (documented) bases; and under each class is listed all of its subclasses. Note that in the case of multiple inheritance, a class may appear multiple times.

Call Graph

Write an HTML help file to the given stream. If self._helpfile contains a help file, then use it; otherwise, use the default helpfile from epydoc.docwriter.html_help.

Call Graph

Write an HTML page containing the table of contents page for the given module to the given streams. This page lists the modules, classes, exceptions, functions, and variables defined by the module.

Call Graph

Write an index.html file in the given directory. The contents of this file are copied or linked from an existing page, so this method must be called after all pages have been written. The page used is determined by _frames_index and _top_page:

• If _frames_index is true, then frames.html is copied.
• Otherwise, the page specified by _top_page is copied.

Call Graph

Write the CSS stylesheet in the given directory. If cssname contains a stylesheet file or name (from epydoc.docwriter.html_css), then use that stylesheet; otherwise, use the default stylesheet.

Returns: None

Render the HTML chunk of a callgraph.

If callgraph is a string, use the _callgraph_cache to return a pre-rendered HTML chunk. This mostly avoids to run dot twice for the same callgraph. Else, run the graph and store its HTML output in the cache.

Parameters:

• callgraph (DotGraph or str) - The graph to render or its uid.
• token (str) - A string that can be used to make the <div> id unambiguous, if the callgraph is used more than once in a page.

Returns: str

The HTML representation of the graph.

Render the HTML chunk of a callgraph link.

The link can toggles the visibility of the callgraph rendered using render_callgraph with matching parameters.

Parameters:

• callgraph (DotGraph or str) - The graph to render or its uid.
• token (str) - A string that can be used to make the <div> id unambiguous, if the callgraph is used more than once in a page.

Returns: str

The HTML representation of the graph link.

Generate HTML code for the standard page header, and write it to out. title is a string containing the page title. It should be appropriately escaped/encoded.

Generate HTML code for the navigation bar, and write it to out. The navigation bar typically looks like:

    [ Home Trees Index Help             Project ]

Parameters:

• context - A value indicating what page we're generating a navigation bar for. If we're generating an API documentation page for an object, then context is a ValueDoc containing the documentation for that object; otherwise, context is a string name for the page. The following string names are recognized: 'tree', 'index', and 'help'.

Generate HTML for the breadcrumbs line, and write it to out. The breadcrumbs line is an invisible table with a list of pointers to the current object's ancestors on the left; and the show/hide private selector and the frames/noframes selector on the right.

Parameters:

• context (ValueDoc) - The API documentation for the object whose breadcrumbs we should generate.

Call Graph

Generate HTML code for a summary table, and write it to out. A summary table is a table that includes a one-row description for each variable (of a given type) in a module or class.

Parameters:

• heading - The heading for the summary table; typically, this indicates what kind of value the table describes (e.g., functions or classes).
• doc - A ValueDoc object containing the API documentation for the module or class whose variables we should summarize.
• value_type - A string indicating what type of value should be listed in this summary table. This value is passed on to doc's select_variables() method.

Call Graph

Generate HTML code for a single line of a summary table, and write it to out. See write_summary_table for more information.

Parameters:

• var_doc - The API documentation for the variable that should be described by this line of the summary table.
• container - The API documentation for the class or module whose summary table we're writing.

Call Graph

A helper function used to format an argument name, for use in the argument description list under a routine's details entry. This just wraps strong & code tags around the arg name; and if the arg name is associated with a type, then adds it parenthetically after the name.

Returns: string

The HTML code for a class's base tree. The tree is drawn 'upside-down' and right justified, to allow for multiple inheritance.

Helper function for base_tree.

Returns: int

The width of a base tree, when drawn right-justified. This is used by base_tree to determine how far to indent lines of the base tree.

Call Graph

Render a function signature in HTML.

Parameters:

• api_doc (VariableDoc or RoutineDoc) - The object whose name is to be rendered. If a VariableDoc, its value should be a RoutineDoc
• is_summary - True if the fuction is to be rendered in the summary. type css_class: bool
• link_name (bool) - If True, the name is a link to the object anchor.
• anchor (bool) - If True, the name is the object anchor.
• context (DottedName) - If set, represent the function name from this context. Only useful when api_doc is a RoutineDoc.

Returns: str

The HTML code for the object.

Call Graph

Render an object name in HTML.

Parameters:

• api_doc (APIDoc) - The object whose name is to be rendered
• css_class - The CSS class to assign to the rendered name type css_class: str
• link_name (bool) - If True, the name is a link to the object anchor.
• anchor (bool) - If True, the name is the object anchor.

Returns: str

The HTML code for the object.

Call Graph

Write HTML code containing descriptions of any standard markup fields that are defined by the given APIDoc object (such as @author and @todo fields).

Parameters:

• doc - The APIDoc object containing the API documentation for the object whose standard markup fields should be described.

Call Graph

Build the auto-redirect page, which translates dotted names to URLs using javascript. When the user visits <redirect.html#dotted.name>, they will automatically get redirected to the page for the object with the given fully-qualified dotted name. E.g., for epydoc, <redirect.html#epydoc.apidoc.UNKNOWN> redirects the user to <epydoc.apidoc-module.html#UNKNOWN>.

Call Graph

Return the HTML code for an HREF link to the given target (which can be a VariableDoc, a ValueDoc, or a DottedName. If a NamespaceDoc context is specified, the target label is contextualized to it.

TOGGLE_PRIVATE_JS

A javascript that is used to show or hide the API documentation for private objects. In order for this to work correctly, all documentation for private objects should be enclosed in <div class="private">...</div> elements.

Value:

'''function toggle_private() { // Search for any private/public links on this page. Store // their old text in "cmd," so we will know what action to // take; and change their text to the opposite action. var cmd = "?"; var elts = document.getElementsByTagName("a"); for(var i=0; i<elts.length; i++) { if (elts[i].className == "privatelink") { ...

GET_COOKIE_JS

A javascript that is used to read the value of a cookie. This is used to remember whether private variables should be shown or hidden.

Value:

'''function getCookie(name) { var dc = document.cookie; var prefix = name + "="; var begin = dc.indexOf("; " + prefix); if (begin == -1) { begin = dc.indexOf(prefix); if (begin != 0) return null; } else ...

SET_FRAME_JS

A javascript that is used to set the contents of two frames at once. This is used by the project table-of-contents frame to set both the module table-of-contents frame and the main frame when the user clicks on a module.

Value:

'''function setFrame(url1, url2) { parent.frames[1].location.href = url1; parent.frames[2].location.href = url2; }'''

HIDE_PRIVATE_JS

A javascript that is used to hide private variables, unless either: (a) the cookie says not to; or (b) we appear to be linking to a private variable.

Value:

'''function checkCookie() { var cmd=getCookie("EpydocPrivate"); if (cmd && cmd.substr(0,4)!="show" && location.href.indexOf("# _") < 0) toggle_private(); }'''

TOGGLE_CALLGRAPH_JS

Value:

'''function toggleCallGraph(id) { var elt = document.getElementById(id); if (elt.style.display == "none") elt.style.display = "block"; else elt.style.display = "none"; }'''

SHOW_PRIVATE_JS

Value:

'''function show_private() { var elts = document.getElementsByTagName("a"); for(var i=0; i<elts.length; i++) { if (elts[i].className == "privatelink") { cmd = elts[i].innerHTML; if (cmd && cmd.substr(0,4)=="show") toggle_private(); } ...

GET_ANCHOR_JS

Value:

'''function get_anchor() { var href = location.href; var start = href.indexOf("#")+1; if ((start != 0) && (start != href.length)) return href.substring(start, href.length); }'''

REDIRECT_URL_JS

A javascript that is used to implement the auto-redirect page. When the user visits <redirect.html#dotted.name>, they will automatically get redirected to the page for the object with the given fully-qualified dotted name. E.g., for epydoc, <redirect.html#epydoc.apidoc.UNKNOWN> redirects the user to <epydoc.apidoc-module.html#UNKNOWN>.

Value:

'''function redirect_url(dottedName) { // Scan through each element of the "pages" list, and check // if "name" matches with any of them. for (var i=0; i<pages.length; i++) { // Each page has the form "<pagename>-m" or "<pagename>- c"; // extract the <pagename> portion & compare it to dotted ...

IMAGES

Value:

{'crarr.png': '''iVBORw0KGgoAAAANSUhEUgAAABEAAAAKCAMAAABlokWQAAAALHRFW HRDcmVhdGlvbiBUaW1lAFR1 ZSAyMiBBdWcgMjAwNiAwMDo0MzoxMCAtMDUwMGAMEFgAAAAHdElNRQfWCBYFASkQ033WAA AACXBI WXMAAB7CAAAewgFu0HU+AAAABGdBTUEAALGPC/xhBQAAAEVQTFRF////zcOw18/AgGY0c1 cg4dvQ inJEYEAAYkME3NXI6eTcloFYe2Asr5+AbE4Uh29A9fPwqpl4ZEUI8O3onopk0Ma0lH5U1n fFdgAA ...

SPECIAL_METHODS

Value:

{'__add__': 'Addition operator', '__and__': 'And operator', '__call__': 'Call operator', '__cmp__': 'Comparison operator', '__contains__': 'In operator', '__del__': 'Destructor', '__delitem__': 'Index deletion operator', '__delslice__': 'Slice deletion operator', ...

METADATA_INDICES

A list of metadata indices that should be generated. Each entry in this list is a tuple (tag, label, short_label), where tag is the cannonical tag of a metadata field; label is a label for the index page; and short_label is a shorter label, used in the index selector.

Value:

[('bug', 'Bug List', 'Bugs'), ('todo', 'To Do List', 'To Do'), ('change', 'Change Log', 'Changes'), ('deprecated', 'Deprecation List', 'Deprecations'), ('since', 'Introductions List', 'Introductions')]

PRIVATE_LINK

Value:

'''<span class="options">[<a href="javascript:void(0);" class="private link" onclick="toggle_private();">hide&nbsp;private</a>]</span>'''