Home       Trees       Index       Help   

epydoc 3.0alpha2

Package epydoc :: Package docwriter :: Module html :: Class HTMLWriter
[hide private]
[frames] | no frames]

Class HTMLWriter
source code

Instance Methods [hide private]
  __init__(self, docindex, **kwargs)
Construct a new HTML writer, using the given documentation index.
string _find_top_page(self, pagename)
Find the top page for the API documentation.
    1. Interface Methods
None write(self, directory=None)
Write the documentation to the given directory.
  _write(self, write_func, directory, filename, *args)
None _mkdir(self, directory)
If the given directory does not exist, then attempt to create it.
    2.1. Module Pages
  write_module(self, out, doc)
Write an HTML page containing the API documentation for the given module to out.
    2.??. Source Code Pages
  write_sourcecode(self, out, doc)
    2.2. Class Pages
  write_class(self, out, doc)
Write an HTML page containing the API documentation for the given class to out.
    2.3. Trees page
  write_trees(self, out)
Write an HTML page containing the module and class hierarchies to the given streams.
    2.4. Indices page
  write_indices(self, out)
Write an HTML page containing the term and identifier indices to the given streams.
  write_identifier_index_header(self, out)
  write_identifier_index(self, out, index)
  write_term_index(self, out, index)
    2.5. Help Page
  write_help(self, out)
Write an HTML help file to the given stream.
    2.6. Frames-based Table of Contents
  write_frames_index(self, out)
Write the frames index file for the frames-based table of contents to the given streams.
  write_toc(self, out)
  write_toc_section(self, out, name, docs, fullname=True)
  write_project_toc(self, out)
  write_module_toc(self, out, doc)
Write an HTML page containing the table of contents page for the given module to the given streams.
    2.7. Project homepage (index.html)
  write_homepage(self, directory)
Write an index.html file in the given directory.
  write_redirect_index(self, out, top, name)
    2.8. Stylesheet (epydoc.css)
None write_css(self, directory, cssname)
Write the CSS stylesheet in the given directory.
    2.9. Javascript (epydoc.js)
  write_javascript(self, directory)
    2.10. Graphs
  render_graph(self, graph, css='graph-without-title')
  render_callgraph(self, callgraph)
  callgraph_link(self, callgraph)
    3.1. Page Header
  write_header(self, out, title)
Generate HTML code for the standard page header, and write it to out.
    3.2. Page Footer
  write_footer(self, out, short=False)
Generate HTML code for the standard page footer, and write it to out.
    3.3. Navigation Bar
  write_navbar(self, out, context)
Generate HTML code for the navigation bar, and write it to out.
    3.4. Breadcrumbs
  write_breadcrumbs(self, out, context, context_url)
Generate HTML for the breadcrumbs line, and write it to out.
  breadcrumbs(self, doc)
  _crumb(self, doc)
    3.5. Summary Tables
  write_summary_table(self, out, heading, doc, value_type)
Generate HTML code for a summary table, and write it to out.
  write_summary_group(self, out, doc, name, var_docs, grouped_inh_vars)
  write_inheritance_list(self, out, doc, listed_inh_vars)
  write_var_list(self, out, vardocs)
  write_summary_line(self, out, var_doc, container)
Generate HTML code for a single line of a summary table, and write it to out.
  write_function_summary_line(self, out, var_doc, tr_class, summary)
Generate HTML code for a single line of a summary table, describing a variable whose value is a function, and write it to out.
  write_variable_summary_line(self, out, var_doc, tr_class, summary)
    3.6. Details Lists
  write_details_list(self, out, heading, doc, value_type)
  write_details_entry(self, out, var_doc)
  labelled_list_item(self, lhs, rhs)
  property_accessor_to_html(self, val_doc)
  arg_name_to_html(self, func_doc, arg_name)
A helper function used to format an argument name, for use in the argument description list under a routine's details entry.
  write_function_details_entry(self, out, var_doc, descr, callgraph, rtype, rdescr, arg_descrs, div_class)
  write_property_details_entry(self, out, var_doc, descr, accessors, div_class)
  write_variable_details_entry(self, out, var_doc, descr, div_class)
  variable_tooltip(self, var_doc)
  pprint_value(self, val_doc, multiline=True, summary_linelen=0)
  pprint_pyval(self, pyval, multiline=True, summary_linelen=0)
  _linewrap_html(self, s, linelen, maxlines)
Add line-wrapping to the HTML string s.
    Base Tree
string base_tree(self, doc, width=None, postfix='', context=None)
int find_tree_width(self, doc, context)
Helper function for base_tree.
  contextual_label(self, doc, context)
Return the label for doc to be shown in context.
    Function Signatures
  function_signature(self, api_doc, css_class='sig', link_name=False)
  func_arg(self, name, default, css_class)
  _arg_name(self, arg)
    Import Lists
  write_imports(self, out, doc)
  _import(self, var_doc, context)
    Module Trees
  write_module_tree(self, out)
  write_module_list(self, out, doc)
  write_module_tree_item(self, out, doc, package=None)
    Class trees
  write_class_tree(self, out)
Write HTML code for a nested list showing the base/subclass relationships between all documented classes.
  write_class_tree_item(self, out, doc, class_set)
    Standard Fields
  write_standard_fields(self, out, doc)
Write HTML code containing descriptions of any standard markup fields that are defined by the given APIDoc object (such as @author and @todo fields).
  write_standard_field(self, out, doc, field, descrs, arg='')
    Term index generation
  _get_index_terms(self, parsed_docstring, link, terms, links)
A helper function for _extract_term_index.
  _term_index_to_anchor(self, term)
Given the name of an inline index item, construct a URI anchor.
list of (string, ParsedDocstring, list of ValueDoc) _extract_term_index(self)
Extract the set of terms that should be indexed from all documented docstrings.
    Helper functions
  write_table_header(self, out, css_class, heading=None, private_link=True)
  write_group_header(self, out, group, tr_class='')
  url(self, obj)
Return the URL for the given object, which can be a VariableDoc, a ValueDoc, or a DottedName.
  pysrc_link(self, api_doc)
  pysrc_url(self, api_doc)
  href(self, target, label=None, css_class=None, context=None)
Return the HTML code for an HREF link to the given target (which can be a VariableDoc, a ValueDoc, or a DottedName.
  summary(self, api_doc, indent=0)
  descr(self, api_doc, indent=0)
  type_descr(self, api_doc, indent=0)
  rtype(self, api_doc, indent=0)
  return_descr(self, api_doc, indent=0)
  docstring_to_html(self, parsed_docstring, where=None, indent=0)
  description(self, parsed_docstring, where=None, indent=0)
  doc_kind(self, doc)
  _doc_or_ancestor_is_private(self, api_doc)

Class Variables [hide private]
    2.9. Javascript (epydoc.js)
TOGGLE_PRIVATE_JS A javascript that is used to show or hide the API documentation for private objects.
GET_COOKIE_JS A javascript that is used to read the value of a cookie.
SET_FRAME_JS A javascript that is used to set the contents of two frames at once.
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.
TOGGLE_CALLGRAPH_JS  
    3.6. Details Lists
SPECIAL_METHODS  
_variable_linelen Max line length for variable values
_variable_maxlines Max lines for variable values
_variable_tooltip_linelen Max length for variable tooltips
    Helper functions
TABLE_FOOTER  
PRIVATE_LINK  

Instance Variables [hide private]
_show_private Should private docs be included?
_prj_name The project's name (for the project link in the navbar)
_prj_url URL for the project link in the navbar
_prj_link HTML code for the project link in the navbar
_top_page The 'main' page
_css CSS stylesheet to use
_helpfile Filename of file to extract help contents from
_frames_index Should a frames index be created?
_show_imports Should imports be listed?
_propfunc_linelen [XXX] Not used!
_variable_summary_linelen Max length for variable value summaries
_inheritance How should inheritance be displayed? 'listed', 'included', or 'grouped'
_incl_sourcecode Should pages be generated for source code of modules?
_mark_docstrings Wrap <span class='docstring'>...</span> around docstrings?
_graph_types Graphs that we should include in our output.
module_list The list of ModuleDocs for the documented modules.
module_set The set of ModuleDocs for the documented modules.
class_list The list of ClassDocs for the documented classes.
class_set The set of ClassDocs for the documented classes.
routine_list The list of RoutineDocs for the documented routines.
indexed_docs The list of APIDocs for variables and values that should be included in the index.

Method Details [hide private]

__init__(self, docindex, **kwargs)
(Constructor)

source code 
call graph 
Construct a new HTML writer, using the given documentation index.
Parameters:
  • docmap - 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_sourcecode (boolean) - If true, then generate colorized source code files for each python module.

_find_top_page(self, pagename)

source code 
call graph 
Find the top page for the API documentation. This page is used as the default page shown in the main frame, when frames are used. When frames are not used, this page is copied to index.html.
Parameters:
  • pagename (string) - The name of the page, as specified by the keyword argument top to the constructor.
Returns: string
The URL of the top page.

write(self, directory=None)

source code 
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.

_write(self, write_func, directory, filename, *args)

source code 
call graph 

_mkdir(self, directory)

source code 
call graph 
If the given directory does not exist, then attempt to create it.
Returns: None

write_module(self, out, doc)

source code 
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.

write_sourcecode(self, out, doc)

source code 
call graph 

write_class(self, out, doc)

source code 
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.

write_trees(self, out)

source code 
Write an HTML page containing the module and class hierarchies to the given streams.
Parameters:
  • public - The output stream for the public version of the page.
  • private - The output stream for the private version of the page.

write_indices(self, out)

source code 
Write an HTML page containing the term and identifier indices to the given streams.
Parameters:
  • public - The output stream for the public version of the page.
  • private - The output stream for the private version of the page.

Bug: If there are private indexed terms, but no public indexed terms, then this function will still write a header for the Term Index to the public stream.

write_identifier_index_header(self, out)

source code 

write_identifier_index(self, out, index)

source code 

write_term_index(self, out, index)

source code 

write_help(self, out)

source code 
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.
Parameters:
  • public - The output stream for the public version of the page.
  • private - The output stream for the private version of the page.

write_frames_index(self, out)

source code 
Write the frames index file for the frames-based table of contents to the given streams.

write_toc(self, out)

source code 

write_toc_section(self, out, name, docs, fullname=True)

source code 

write_project_toc(self, out)

source code 

write_module_toc(self, out, doc)

source code 
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.
Parameters:
  • public - The output stream for the public version of the page.
  • private - The output stream for the private version of the page.

write_homepage(self, directory)

source code 
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:

write_redirect_index(self, out, top, name)

source code 

write_css(self, directory, cssname)

source code 
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

write_javascript(self, directory)

source code 

render_graph(self, graph, css='graph-without-title')

source code 

render_callgraph(self, callgraph)

source code 

callgraph_link(self, callgraph)

source code 

write_header(self, out, title)

source code 
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.

write_footer(self, out, short=False)

source code 
Generate HTML code for the standard page footer, and write it to out.

write_navbar(self, out, context)

source code 
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'.

write_breadcrumbs(self, out, context, context_url)

source code 
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.

breadcrumbs(self, doc)

source code 

_crumb(self, doc)

source code 

write_summary_table(self, out, heading, doc, value_type)

source code 
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.

write_summary_group(self, out, doc, name, var_docs, grouped_inh_vars)

source code 

write_inheritance_list(self, out, doc, listed_inh_vars)

source code 

write_var_list(self, out, vardocs)

source code 

write_summary_line(self, out, var_doc, container)

source code 
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.

write_function_summary_line(self, out, var_doc, tr_class, summary)

source code 
Generate HTML code for a single line of a summary table, describing a variable whose value is a function, and write it to out.
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.

write_variable_summary_line(self, out, var_doc, tr_class, summary)

source code 

write_details_list(self, out, heading, doc, value_type)

source code 

write_details_entry(self, out, var_doc)

source code 

labelled_list_item(self, lhs, rhs)

source code 

property_accessor_to_html(self, val_doc)

source code 

arg_name_to_html(self, func_doc, arg_name)

source code 
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.

write_function_details_entry(self, out, var_doc, descr, callgraph, rtype, rdescr, arg_descrs, div_class)

source code 

write_property_details_entry(self, out, var_doc, descr, accessors, div_class)

source code 

write_variable_details_entry(self, out, var_doc, descr, div_class)

source code 

variable_tooltip(self, var_doc)

source code 

pprint_value(self, val_doc, multiline=True, summary_linelen=0)

source code 

pprint_pyval(self, pyval, multiline=True, summary_linelen=0)

source code 

_linewrap_html(self, s, linelen, maxlines)

source code 
Add line-wrapping to the HTML string s. Line length is determined by linelen; and the maximum number of lines to display is determined by maxlines. This function treats HTML entities (e.g., &amp;) as single characters; and ignores HTML tags (e.g., <p>).

base_tree(self, doc, width=None, postfix='', context=None)

source code 
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.

find_tree_width(self, doc, context)

source code 
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.

contextual_label(self, doc, context)

source code 
Return the label for doc to be shown in context.

function_signature(self, api_doc, css_class='sig', link_name=False)

source code 

func_arg(self, name, default, css_class)

source code 

_arg_name(self, arg)

source code 

write_imports(self, out, doc)

source code 

_import(self, var_doc, context)

source code 

write_module_tree(self, out)

source code 

write_module_list(self, out, doc)

source code 

write_module_tree_item(self, out, doc, package=None)

source code 

write_class_tree(self, out)

source code 
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. This is used by write_trees to write the class hierarchy.

To Do: For multiple inheritance, don't repeat subclasses the second time a class is mentioned; instead, link to the first mention.

write_class_tree_item(self, out, doc, class_set)

source code 

write_standard_fields(self, out, doc)

source code 
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.

write_standard_field(self, out, doc, field, descrs, arg='')

source code 

_get_index_terms(self, parsed_docstring, link, terms, links)

source code 

A helper function for _extract_term_index.

For each index term t with key k in parsed_docstring, modify terms and links as follows:
  • Set terms[k] = t (if terms[k] doesn't exist).
  • Append link to links[k].

_term_index_to_anchor(self, term)

source code 
Given the name of an inline index item, construct a URI anchor. These anchors are used to create links from the index page to each index item.

_extract_term_index(self)

source code 
Extract the set of terms that should be indexed from all documented docstrings. Return the extracted set as a list of tuples of the form (key, term, [links]). This list is used by write_indices() to construct the term index.
Returns: list of (string, ParsedDocstring, list of ValueDoc)

write_table_header(self, out, css_class, heading=None, private_link=True)

source code 

write_group_header(self, out, group, tr_class='')

source code 

url(self, obj)

source code 
Return the URL for the given object, which can be a VariableDoc, a ValueDoc, or a DottedName.

pysrc_link(self, api_doc)

source code 

pysrc_url(self, api_doc)

source code 

href(self, target, label=None, css_class=None, context=None)

source code 
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.

summary(self, api_doc, indent=0)

source code 

descr(self, api_doc, indent=0)

source code 

type_descr(self, api_doc, indent=0)

source code 

rtype(self, api_doc, indent=0)

source code 

return_descr(self, api_doc, indent=0)

source code 

docstring_to_html(self, parsed_docstring, where=None, indent=0)

source code 

description(self, parsed_docstring, where=None, indent=0)

source code 

doc_kind(self, doc)

source code 

_doc_or_ancestor_is_private(self, api_doc)

source code 

Class Variable Details [hide private]

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!="show private" && 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";
      }'''

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',
...

_variable_linelen

Max line length for variable values
Value:
70                                                                    

_variable_maxlines

Max lines for variable values
Value:
3                                                                     

_variable_tooltip_linelen

Max length for variable tooltips
Value:
70                                                                    

TABLE_FOOTER

Value:
'''</table>
'''

PRIVATE_LINK

Value:
'''<span class="options">[<a href="javascript: void(0);" class="privat\
elink"
    onclick="toggle_private();">hide private</a>]</span>'''

Instance Variable Details [hide private]

_show_private

Should private docs be included?

_prj_name

The project's name (for the project link in the navbar)

_prj_url

URL for the project link in the navbar

_prj_link

HTML code for the project link in the navbar

_top_page

The 'main' page

_css

CSS stylesheet to use

_helpfile

Filename of file to extract help contents from

_frames_index

Should a frames index be created?

_show_imports

Should imports be listed?

_propfunc_linelen

[XXX] Not used!

_variable_summary_linelen

Max length for variable value summaries

_inheritance

How should inheritance be displayed? 'listed', 'included', or 'grouped'

_incl_sourcecode

Should pages be generated for source code of modules?

_mark_docstrings

Wrap <span class='docstring'>...</span> around docstrings?

_graph_types

Graphs that we should include in our output.

module_list

The list of ModuleDocs for the documented modules.

module_set

The set of ModuleDocs for the documented modules.

class_list

The list of ClassDocs for the documented classes.

class_set

The set of ClassDocs for the documented classes.

routine_list

The list of RoutineDocs for the documented routines.

indexed_docs

The list of APIDocs for variables and values that should be included in the index.

   Home       Trees       Index       Help   

epydoc 3.0alpha2

Generated by Epydoc 3.0alpha2 on Tue Apr 11 17:34:56 2006 http://epydoc.sf.net