| Instance Methods |
| __init__(self,
docindex,
**kwargs) Construct a new HTML writer, using the given documentation index. |
source code
call graph |
string
| _find_top_page(self,
pagename) Find the top page for the API documentation. |
source code
call graph |
None
| write(self,
directory=None) Write the documentation to the given directory. |
source code
call graph |
| _write(self, write_func, directory, filename, *args) |
source code
call graph |
None
| _mkdir(self,
directory) If the given directory does not exist, then attempt to create it. |
source code
call graph |
| write_module(self,
out,
doc) Write an HTML page containing the API documentation for the given module to out. |
source code
call graph |
| write_sourcecode(self, out, doc, name_to_docs) |
source code
call graph |
| write_class(self,
out,
doc) Write an HTML page containing the API documentation for the given class to out. |
source code
call graph |
| write_class_tree_graph(self,
out,
doc,
graphmaker) Write HTML code for a class tree graph of doc (a
classdoc), using graphmaker to draw the actual graph. |
source code
call graph |
| write_module_tree(self, out) |
source code
call graph |
| write_class_tree(self,
out) Write HTML code for a nested list showing the base/subclass relationships between all documented classes. |
source code
call graph |
| write_treepage_header(self, out, title, url) |
source code
call graph |
write_link_index(self,
out,
indices,
title,
url,
index_by_section,
sections='ABCDEFGHIJKLMNOPQRSTUVWXYZ_',
section_url='#%s') |
source code
call graph |
| write_metadata_index(self,
out,
indices,
field,
title,
typ) Write an HTML page containing a metadata index. |
source code
call graph |
| write_indexpage_header(self,
out,
indices,
title,
url) A helper for the index page generation functions, which generates a header that can be used to navigate between the different indices. |
source code
call graph |
| write_index_section(self, out, items, add_blankline=False) |
source code
call graph |
| write_help(self,
out) Write an HTML help file to the given stream. |
source code
call graph |
| write_frames_index(self,
out) Write the frames index file for the frames-based table of contents to the given streams. |
source code |
| write_toc(self, out) | source code |
| write_toc_section(self, out, name, docs, fullname=True) |
source code
call graph |
| write_project_toc(self, out) |
source code
call graph |
| write_module_toc(self,
out,
doc) Write an HTML page containing the table of contents page for the given module to the given streams. |
source code
call graph |
| write_homepage(self,
directory) Write an index.html file in the given directory. |
source code
call graph |
| write_redirect_index(self, out, top, name) | source code |
None
| write_css(self,
directory,
cssname) Write the CSS stylesheet in the given directory. |
source code
call graph |
| write_javascript(self, directory) |
source code
call graph |
| render_graph(self, graph) |
source code
call graph |
str
render_callgraph(self,
callgraph,
token='')Render the HTML chunk of a callgraph. |
source code |
str
callgraph_link(self,
callgraph,
token='')Render the HTML chunk of a callgraph link. |
source code |
| write_images(self, directory) |
source code
call graph |
| write_header(self,
out,
title) Generate HTML code for the standard page header, and write it to out. |
source code |
| write_footer(self,
out,
short=False) Generate HTML code for the standard page footer, and write it to out. |
source code |
| write_navbar(self,
out,
context) Generate HTML code for the navigation bar, and write it to out. |
source code |
| write_breadcrumbs(self,
out,
context,
context_url) Generate HTML for the breadcrumbs line, and write it to out. |
source code |
| breadcrumbs(self, doc) |
source code
call graph |
| _crumb(self, doc) |
source code
call graph |
| write_summary_table(self,
out,
heading,
doc,
value_type) Generate HTML code for a summary table, and write it to out. |
source code
call graph |
| write_summary_group(self, out, doc, name, var_docs, grouped_inh_vars) |
source code
call graph |
| write_inheritance_list(self, out, doc, listed_inh_vars) |
source code
call graph |
| write_var_list(self, out, vardocs) |
source code
call graph |
| write_summary_line(self,
out,
var_doc,
container) Generate HTML code for a single line of a summary table, and write it to out. |
source code
call graph |
| _write_summary_line(self, out, typ, description, tr_class, pysrc_link, callgraph) | source code |
| write_details_list(self, out, heading, doc, value_type) |
source code
call graph |
| write_details_entry(self, out, var_doc) |
source code
call graph |
| labelled_list_item(self, lhs, rhs) | source code |
| property_accessor_to_html(self, val_doc, context=None) |
source code
call graph |
| 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. |
source code
call graph |
| 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
call graph |
| pprint_value(self, val_doc) |
source code
call graph |
string
base_tree(self,
doc,
width=None,
postfix='',
context=None)Returns: The HTML code for a class's base tree. |
source code |
int
| find_tree_width(self,
doc,
context) Helper function for base_tree. |
source code |
| contextual_label(self,
doc,
context) Return the label for doc to be shown in
context. |
source code |
str
| function_signature(self,
api_doc,
is_summary=False,
link_name=False,
anchor=False,
context=None) Render a function signature in HTML. |
source code
call graph |
str
summary_name(self,
api_doc,
css_class='summary-name',
link_name=False,
anchor=False)Render an object name in HTML. |
source code
call graph |
| func_arg(self, name, default, css_class) |
source code
call graph |
| _arg_name(self, arg) |
source code
call graph |
| write_imports(self, out, doc) | source code |
| _import(self, var_doc, context) | source code |
| write_module_list(self, out, doc) |
source code
call graph |
| write_module_tree_item(self, out, doc, package=None) |
source code
call graph |
| write_class_tree_item(self, out, doc, class_set) | source code |
| 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). |
source code
call graph |
