| Home | Trees | Index | Help |  | 
|---|
| Package epydoc :: Module html :: Class HTMLFormatter | 
 | 
HTMLFormatter consists of a set of HTML files. Two 
subdirectories are created for the public and private documentation. 
Within each subdirectories, every class and module is documented in its 
own file. An index file, a trees file, a help file, and a frames-based 
table of contents are also created. In particular, 
HTMLFormatter generates the following files:
| Method Summary | |
|---|---|
| Construct a new HTML formatter, using the given documentation map. | |
| Return a string containing the HTML documentation for the given object. (Static method) | |
| int | Return the number of files that this HTMLFormatterwill 
generate. | 
| None | Write the documentation to the given directory. | 
| string | Return the HTML code for a class's base tree. | 
| string | Return the HTML code for a series of links to the ancestors of uid. | 
| Return the HTML code for a list of description items. | |
| markup.ParsedDocstring | Return a string containing the HTML encoding for the given ParsedDocstring | 
| boolean | Return true if the given UID is documented by the documentation map for this HTMLFormatter. | 
| listofUID | Return a list of the UIDs of all objects and variables 
documented by_docmap. | 
| listof(string,  | Extract the set of terms that should be indexed from all documented docstrings. | 
| string | Find the top page for the API documentation. | 
| UIDorNone | Return the UID of the top-level module or package, or | 
| int | Helper function for _base_tree. | 
| string | Return the HTML code for the footer of a page. | 
| string | Return hTML code for the frames/noframes selector. | 
| Return the HTML code for an entry in the function details section. | |
| Return the HTML code for the function signature of the function with the given name and documentation. | |
| A helper function for _extract_term_index. | |
| _group_header(self,
          group) | |
| string | Return the HTML code for the header of a page with the given name. | 
| Add line-wrapping to the HTML string str. | |
| string | Return the HTML code for the given link. | 
| None | If the given directory does not exist, then attempt to create it. | 
| Return the HTML code for a single parameter. | |
| _parameter_list(self,
          parameters,
          container,
          heading) | |
| Return a string representation of the value of the variable var, 
suitable for use in a<pre>...</pre>HTML 
block. | |
| Return true if the given property should be shown in the public version of the property details section. | |
| string | Return hTML code for the show/hide private selector. | 
| pairoflistofuid.Link | Divide the classes fromt the given module into exceptions and non-exceptions. | 
| listofmarkup.ParsedDocstring | Return a list of epytext field values that includes all fields that are common to all ObjDocs. | 
| string | Return hTML code containing descriptions of the epytext fields that are common to all ObjDocs (except fordescr). | 
| string | Return the HTML code for a 'start-of' comment. | 
| string | Return the HTML code for the summary description of the object documented by doc. | 
| string | Return the HTML code for the start of a table. | 
| Given the name of an inline index item, construct a URI anchor. | |
| _uid_to_filename(self,
          uid) | |
| string | Return the HTML code to link to the given UID. | 
| string | Return a URI that points to the description of the object identified by uid. | 
| Return the HTML code for an entry in the variable details section. | |
| Return a string representation of the value of the variable var, 
suitable for use in a tooltip. | |
| None | A helper for write, that creates new public and private 
streams for a given filename, and delegates writing towrite_func. | 
| Write the HTML code for the breadcrumbs line to the given streams. | |
| Write an HTML page describing the given module to the given streams. | |
| Write HTML code for a class summary table. | |
| Write HTML code for a row in the class summary table. | |
| Write HTML code for a nested list showing the base/subclass relationships between all documented classes. | |
| Write HTML code for a list item describing a class and all of its subclasses. | |
| None | Write the CSS stylesheet in the given directory. | 
| Write the frames index file for the frames-based table of contents to the given streams. | |
| Write HTML code for a function details section. | |
| Write HTML code for a function summary table. | |
| Write HTML code for a row in the function summary table. | |
| Write an HTML help file to the given streams. | |
| _write_imports(self,
          public,
          private,
          doc) | |
| Write an index.htmlfile in the given directory. | |
| Write an HTML page containing the term and identifier indices to the given streams. | |
| Return a string containing HTML that lists all objects from that were inherited from a base ancestor of cls. | |
| Write an HTML page describing the given module to the given streams. | |
| Write HTML code for a list of the submodules to the given streams. | |
| Write an HTML page containing the table of contents page for the given module to the given streams. | |
| Write HTML code for a nested list showing the submodule relationships between all documented packages and modules. | |
| Write HTML for a list item describing a package/module and all of its submodules. | |
| Write the HTML code for the navigation bar to the given streams. | |
| Write an HTML page containing the table of contents page for the whole project to the given streams. | |
| Write HTML code for a properties details section. | |
| Write HTML code for an individual property in the properties details section. | |
| Write HTML code for a property summary table. | |
| Write HTML code for a row in the property summary table. | |
| Write an HTML page containing the top-level table of contents. | |
| _write_toc_section(self,
          public,
          private,
          section,
          links) | |
| Write an HTML page containing the module and class hierarchies to the given streams. | |
| Write HTML code for a variable details section. | |
| Write HTML code for a variable summary table. | |
| Write HTML code for a row in the variable summary table. | |
| Instance Variable Summary | |
|---|---|
| _create_private_docs: Whether or not to create documentation pages that include information 
about private objects. | |
| _css: The name of a file containing a CSS stylesheet; or the name of a CSS 
stylesheet. | |
| DocMap | _docmap: The documentation map, encoding the objects that should be 
documented. | 
| _frames_index: Whether or not to create a frames-based table of contents for the 
documentation. | |
| string | _prj_name: A name for the documentation (for the navbar). | 
| string | _prj_url: A URL for the documentation (for the navpar). | 
| _top_page: The URI of the top page. | |
| _variable_linelen: The maximum line length used for displaying the values of variables in 
the variable details sections. | |
| _variable_maxlines: The maximum number of lines that should be displayed for the value of 
a variable in the variable details section. | |
| _variable_tooltip_linelen: The maximum line length for variable value tooltips. | |
| Instance Method Details | 
|---|
| __init__(self,
          docmap,
          **kwargs)
    Construct a new HTML formatter, using the given documentation 
  map. | 
| num_files(self)
 | 
| write(self, directory=None, progress_callback=None)Write the documentation to the given directory.
 | 
| _base_tree(self, uid, width=None, postfix='')
 | 
| _breadcrumbs(self, uid)
 | 
| _descrlist(self, items, singular, plural=None, short=0)
 | 
| _docstring_to_html(self, docstring, uid, indent=0)
 | 
| _documented(self, uid)
 | 
| _extract_identifier_index(self)
 | 
| _extract_term_index(self)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_indicesto construct the term 
  index.
 | 
| _find_top_page(self, pagename)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, a redirect page is created fromindex.htmlto the top page.
 | 
| _find_toplevel(self)
 | 
| _find_tree_width(self, uid)Helper function for_base_tree.
 | 
| _footer(self)
 | 
| _frames_link(self, where)
 | 
| _func_details_entry(self, function, container)
 | 
| _func_signature(self, fname, fuid, fdoc, href=0, show_defaults=1, css_class='sig')
 | 
| _get_index_terms(self, parsed_docstring, link, terms, links)A helper function for  parsed_docstring, modifytermsandlinksas follows:
 | 
| _header(self, name)
 | 
| _linewrap_html(self, str, linelen, maxlines)Add line-wrapping to the HTML stringstr. Line length 
  is determined bylinelen; and the maximum number of lines 
  to display is determined bymaxlines. This function treats 
  HTML entities (e.g.,&) as single characters; and 
  ignores HTML tags (e.g.,<p>). | 
| _link_to_html(self, link)
 | 
| _mkdir(self, directory)If the given directory does not exist, then attempt to create it.
 | 
| _param_to_html(self, param, show_defaults, css_class)
 | 
| _pprint_var_value(self, var, multiline=1, summary_linelen=0)
 | 
| _property_in_public_details(self, puid)
 | 
| _public_private_link(self, where, toc=0, from_private=0)
 | 
| _split_classes(self, classes_and_excepts)Divide the classes fromt the given module into exceptions and non-exceptions. This is used by_write_moduleto list exceptions and 
  non-exceptions separately. | 
| _standard_field_values(self, doc)
 | 
| _standard_fields(self, doc)
 | 
| _start_of(self, heading)
 | 
| _summary(self, doc, uid, indent=0)
 | 
| _table_header(self, heading, css_class)
 | 
| _term_index_to_anchor(self, term)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. | 
| _uid_to_href(self, uid, label=None, css_class=None, code=1)
 | 
| _uid_to_uri(self, uid)
 | 
| _var_details_entry(self, var, container)
 | 
| _var_value_tooltip(self, var)
 | 
| _write(self, write_func, directory, filename, progress_callback, is_public, *args)A helper forwrite, that creates new public and 
  private streams for a given filename, and delegates writing towrite_func. If_create_private_docsis true, then the 
  streams are created in the'public'and'private'subdirectories ofdirectory. If 
  it's false, then the public stream is created indirectory, and a_DevNullis used for the private 
  stream.
 | 
| _write_breadcrumbs(self, public, private, where=None)Write the HTML code for the breadcrumbs line to the given streams. 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.
 | 
| _write_class(self, public, private, uid, doc, body_only=0)Write an HTML page describing the given module to the given streams.
 | 
| _write_class_summary(self, public, private, container, classes, heading='Class Summary')Write HTML code for a class summary table. This is used by_write_moduleto list the classes in a 
  module.
 | 
| _write_class_summary_row(self, public, private, link)Write HTML code for a row in the class summary table. Each row gives the name and summary of a single class.
 | 
| _write_class_tree(self, public, private)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_treesto write the class 
  hierarchy.
 | 
| _write_class_tree_item(self, public, private, uid, depth=2, public_base=1)Write HTML code for a list item describing a class and all of its subclasses. This is used by_write_class_treeto write the class 
  hierarchy.
 | 
| _write_css(self, directory, cssname)Write the CSS stylesheet in the given directory. Ifcssnamecontains a stylesheet file or name (fromepydoc.css), then use that stylesheet; 
  otherwise, if a stylesheet file already exists, use that stylesheet. 
  Otherwise, use the default stylesheet.
 | 
| _write_frames(self, public, private)Write the frames index file for the frames-based table of contents to the given streams.
 | 
| _write_func_details(self, public, private, container, functions, heading='Function Details')Write HTML code for a function details section. This is used by_write_moduleto describe the functions 
  in a module; and by_write_classto describe the methods in a 
  class.
 | 
| _write_func_summary(self, public, private, container, functions, heading='Function Summary')Write HTML code for a function summary table. This is used by_write_moduleto list the functions in a 
  module; and by_write_classto list the methods in a 
  class.
 | 
| _write_func_summary_row(self, public, private, function, container)Write HTML code for a row in the function summary table. Each row gives a breif description of a single function.
 | 
| _write_help(self, public, private)Write an HTML help file to the given streams. Ifself._helpfilecontains a help file, then use it; 
  otherwise, use the default helpfile fromepydoc.help.
 | 
| _write_index(self, directory, frombase)Write anindex.htmlfile in the given directory. The 
  contents of this file are copied or linked from an existing page. The 
  page used is determined by_frames_indexand_top_page:
 
 | 
| _write_indices(self, public, private)Write an HTML page containing the term and identifier indices to the given streams.
 | 
| _write_inheritance_list(self, public, private, links, cls)
 | 
| _write_module(self, public, private, uid, doc, body_only=0)Write an HTML page describing the given module to the given streams.
 | 
| _write_module_list(self, public, private, container, modules)Write HTML code for a list of the submodules to the given streams. This is used by_write_moduleto list the submodules in a 
  package.
 | 
| _write_module_toc(self, public, private, uid, doc)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.
 | 
| _write_module_tree(self, public, private)Write HTML code for a nested list showing the submodule relationships between all documented packages and modules. This is used by_write_treesto write the module 
  hierarchy.
 | 
| _write_module_tree_item(self, public, private, uid, depth=0)Write HTML for a list item describing a package/module and all of its submodules. This is used by both_write_module_treeand_write_module_listto write package 
  hierarchies.
 | 
| _write_navbar(self, public, private, where=None)Write the HTML code for the navigation bar to the given streams. The navigation bar typically looks like:
       [ Home Trees Index Help            Project ]
 | 
| _write_project_toc(self, public, private)Write an HTML page containing the table of contents page for the whole project to the given streams. This page lists the classes, exceptions, functions, and variables defined by any module or package in the project.
 | 
| _write_property_details(self, public, private, container, properties, heading='Property Details')Write HTML code for a properties details section. This is used by_write_classto describe the properties 
  in a class.
 | 
| _write_property_details_entry(self, public, private, property, container)Write HTML code for an individual property in the properties details section. This is used by_write_property_details.
 | 
| _write_property_summary(self, public, private, container, properties, heading='Property Summary')Write HTML code for a property summary table. This is used by_write_classto list the properties in a 
  class.
 | 
| _write_property_summary_row(self, public, private, property, container)Write HTML code for a row in the property summary table. Each row gives a brief description of a single property.
 | 
| _write_toc(self, public, private)Write an HTML page containing the top-level table of contents. This page is used to select a module table of contents page, or the "everything" table of contents page.
 | 
| _write_trees(self, public, private)Write an HTML page containing the module and class hierarchies to the given streams.
 | 
| _write_var_details(self, public, private, container, vars, heading='Variable Details')Write HTML code for a variable details section. This is used by_write_moduleto describe the variables 
  in a module; and by_write_classto describe the instance and 
  class variables in a class.
 | 
| _write_var_summary(self, public, private, container, variables, heading='Variable Summary')Write HTML code for a variable summary table. This is used by_write_moduleto list the variables in a 
  module; and by_write_classto list the instance and 
  class variables in a class.
 | 
| _write_var_summary_row(self, public, private, var, container)Write HTML code for a row in the variable summary table. Each row gives a brief description of a single variable.
 | 
| Static Method Details | 
|---|
| format(object, error_stream=None, show_private=1, body_only=1, **options)
 | 
| Instance Variable Details | 
|---|
| _create_private_docsWhether or not to create documentation pages that include information about private objects. | 
| _cssThe name of a file containing a CSS stylesheet; or the name of a CSS stylesheet. | 
| _docmapThe documentation map, encoding the objects that should be documented.
 | 
| _frames_indexWhether or not to create a frames-based table of contents for the documentation. | 
| _prj_nameA name for the documentation (for the navbar).
 | 
| _prj_urlA URL for the documentation (for the navpar).
 | 
| _top_pageThe URI of the top page. This is the page shown in the main frame by the frames index; and the page that is used as the noframes index. | 
| _variable_linelenThe maximum line length used for displaying the values of variables in the variable details sections. | 
| _variable_maxlinesThe maximum number of lines that should be displayed for the value of a variable in the variable details section. | 
| _variable_tooltip_linelenThe maximum line length for variable value tooltips. | 
| Home | Trees | Index | Help |  | 
|---|
| Generated by Epydoc 2.1 on Sat Mar 20 17:46:11 2004 | http://epydoc.sf.net |