<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>epydoc.docwriter.html.HTMLWriter</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="epydoc-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="epydoc-module.html">Package epydoc</a> ::
<a href="epydoc.docwriter-module.html">Package docwriter</a> ::
<a href="epydoc.docwriter.html-module.html">Module html</a> ::
Class HTMLWriter
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="epydoc.docwriter.html.HTMLWriter-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class HTMLWriter</h1><p class="nomargin-top"><span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter">source code</a></span></p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docwriter.html.HTMLWriter-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">docindex</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Construct a new HTML writer, using the given documentation index.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.__init__">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for___init___21-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for___init___21-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for___init___21" name="call_graph_for___init___21">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="apidoc.APIDoc.__cmp__()" alt="" coords="192,6,416,38" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__hash__" title="apidoc.APIDoc.__hash__()" alt="" coords="192,62,416,94" />
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#reachable_valdocs" title="apidoc.DocIndex.reachable_valdocs()" alt="" coords="152,118,456,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#__init__" title="__init__()" alt="" coords="7,118,103,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_find_top_page" title="_find_top_page()" alt="" coords="228,174,380,206" />
<area shape="rect" href="epydoc.util-module.html#is_src_filename" title="util.is_src_filename()" alt="" coords="213,230,395,262" />
</map>
<img src="call_graph_for___init___21.gif" alt='' usemap="#call_graph_for___init___21" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>string</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docwriter.html.HTMLWriter-class.html#_find_top_page" class="summary-sig-name" onclick="show_private();">_find_top_page</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">pagename</span>)</span><br />
Find the top page for the API documentation.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter._find_top_page">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__find_top_page-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__find_top_page-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__find_top_page" name="call_graph_for__find_top_page">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#dominates" title="apidoc.DottedName.dominates()" alt="" coords="353,6,617,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#__init__" title="__init__()" alt="" coords="7,34,103,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_find_top_page" title="_find_top_page()" alt="" coords="152,34,304,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#url" title="url()" alt="" coords="457,62,513,94" />
</map>
<img src="call_graph_for__find_top_page.gif" alt='' usemap="#call_graph_for__find_top_page" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> 1. Interface Methods</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>None</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docwriter.html.HTMLWriter-class.html#write" class="summary-sig-name">write</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">directory</span>=<span class="summary-sig-default">None</span>)</span><br />
Write the documentation to the given directory.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_3-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_write_3-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_3" name="call_graph_for_write_3">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="apidoc.DottedName.__getitem__()" alt="" coords="127,6,407,38" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__str__" title="apidoc.DottedName.__str__()" alt="" coords="145,62,388,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_group_by_letter" title="_group_by_letter()" alt="" coords="185,118,348,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_mkdir" title="_mkdir()" alt="" coords="223,174,311,206" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_write" title="_write()" alt="" coords="225,230,308,262" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#build_identifier_index" title="build_identifier_index()" alt="" coords="167,286,367,318" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#build_metadata_index" title="build_metadata_index()" alt="" coords="167,342,367,374" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#build_term_index" title="build_term_index()" alt="" coords="183,398,351,430" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#pysrc_url" title="pysrc_url()" alt="" coords="215,454,319,486" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#url" title="url()" alt="" coords="239,510,295,542" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write" title="write()" alt="" coords="5,426,77,458" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_css" title="write_css()" alt="" coords="215,566,319,598" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_homepage" title="write_homepage()" alt="" coords="188,622,345,654" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_images" title="write_images()" alt="" coords="200,678,333,710" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_javascript" title="write_javascript()" alt="" coords="189,734,344,766" />
<area shape="rect" href="epydoc.log-module.html#docstring_warning" title="log.docstring_warning()" alt="" coords="165,790,368,822" />
<area shape="rect" href="epydoc.log-module.html#progress" title="log.progress()" alt="" coords="204,846,329,878" />
</map>
<img src="call_graph_for_write_3.gif" alt='' usemap="#call_graph_for_write_3" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_write"></a><span class="summary-sig-name">_write</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">write_func</span>,
<span class="summary-sig-arg">directory</span>,
<span class="summary-sig-arg">filename</span>,
<span class="summary-sig-arg">*args</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter._write">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__write-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__write-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__write" name="call_graph_for__write">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_write" title="_write()" alt="" coords="125,342,208,374" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_api_list" title="write_api_list()" alt="" coords="288,6,424,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_class" title="write_class()" alt="" coords="297,62,415,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_class_tree" title="write_class_tree()" alt="" coords="279,118,433,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_help" title="write_help()" alt="" coords="300,174,412,206" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_link_index" title="write_link_index()" alt="" coords="276,230,436,262" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_metadata_index" title="write_metadata_index()" alt="" coords="256,286,456,318" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module" title="write_module()" alt="" coords="288,342,424,374" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module_toc" title="write_module_toc()" alt="" coords="272,398,440,430" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module_tree" title="write_module_tree()" alt="" coords="269,454,443,486" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_project_toc" title="write_project_toc()" alt="" coords="273,510,439,542" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_redirect_page" title="write_redirect_page()" alt="" coords="265,566,447,598" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_sourcecode" title="write_sourcecode()" alt="" coords="273,622,439,654" />
<area shape="rect" href="epydoc.log-module.html#progress" title="log.progress()" alt="" coords="293,678,419,710" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write" title="write()" alt="" coords="5,342,77,374" />
</map>
<img src="call_graph_for__write.gif" alt='' usemap="#call_graph_for__write" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>None</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_mkdir"></a><span class="summary-sig-name">_mkdir</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">directory</span>)</span><br />
If the given directory does not exist, then attempt to create it.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter._mkdir">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__mkdir-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__mkdir-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__mkdir" name="call_graph_for__mkdir">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_mkdir" title="_mkdir()" alt="" coords="127,6,215,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write" title="write()" alt="" coords="5,6,77,38" />
</map>
<img src="call_graph_for__mkdir.gif" alt='' usemap="#call_graph_for__mkdir" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> 2.1. Module Pages</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docwriter.html.HTMLWriter-class.html#write_module" class="summary-sig-name">write_module</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">doc</span>)</span><br />
Write an HTML page containing the API documentation for the given
module to <code>out</code>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_module">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_module-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_write_module-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_module" name="call_graph_for_write_module">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="apidoc.DottedName.__getitem__()" alt="" coords="324,6,604,38" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__str__" title="apidoc.DottedName.__str__()" alt="" coords="343,62,586,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_write" title="_write()" alt="" coords="6,230,88,262" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module" title="write_module()" alt="" coords="138,230,274,262" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#descr" title="descr()" alt="" coords="428,118,500,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#pysrc_link" title="pysrc_link()" alt="" coords="407,174,522,206" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#url" title="url()" alt="" coords="436,230,492,262" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_details_list" title="write_details_list()" alt="" coords="383,286,546,318" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module_list" title="write_module_list()" alt="" coords="380,342,548,374" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_standard_fields" title="write_standard_fields()" alt="" coords="367,398,562,430" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_table" title="write_summary_table()" alt="" coords="367,454,562,486" />
</map>
<img src="call_graph_for_write_module.gif" alt='' usemap="#call_graph_for_write_module" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> 2.??. Source Code Pages</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="write_sourcecode"></a><span class="summary-sig-name">write_sourcecode</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">doc</span>,
<span class="summary-sig-arg">name_to_docs</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_sourcecode">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_sourcecod-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_write_sourcecod-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_sourcecod" name="call_graph_for_write_sourcecod">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__str__" title="apidoc.DottedName.__str__()" alt="" coords="420,6,663,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_write" title="_write()" alt="" coords="6,146,88,178" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_sourcecode" title="write_sourcecode()" alt="" coords="136,146,302,178" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#doc_kind" title="doc_kind()" alt="" coords="490,62,594,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#href" title="href()" alt="" coords="510,118,574,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#pysrc_url" title="pysrc_url()" alt="" coords="490,174,594,206" />
<area shape="rect" href="epydoc.docwriter.html_colorize.PythonSourceColorizer-class.html#__init__" title="html_colorize.PythonSourceColorizer.__init__()" alt="" coords="350,230,734,262" />
<area shape="rect" href="epydoc.docwriter.html_colorize.PythonSourceColorizer-class.html#colorize" title="html_colorize.PythonSourceColorizer.colorize()" alt="" coords="351,286,732,318" />
</map>
<img src="call_graph_for_write_sourcecod.gif" alt='' usemap="#call_graph_for_write_sourcecod" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> 2.2. Class Pages</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docwriter.html.HTMLWriter-class.html#write_class" class="summary-sig-name">write_class</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">doc</span>)</span><br />
Write an HTML page containing the API documentation for the given
class to <code>out</code>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_class">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_class-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_write_class-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_class" name="call_graph_for_write_class">
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#is_exception" title="apidoc.ClassDoc.is_exception()" alt="" coords="316,6,575,38" />
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#is_type" title="apidoc.ClassDoc.is_type()" alt="" coords="336,62,555,94" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="apidoc.DottedName.__getitem__()" alt="" coords="305,118,585,150" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__str__" title="apidoc.DottedName.__str__()" alt="" coords="324,174,567,206" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_write" title="_write()" alt="" coords="5,286,88,318" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_class" title="write_class()" alt="" coords="137,286,255,318" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#descr" title="descr()" alt="" coords="409,230,481,262" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#pysrc_link" title="pysrc_link()" alt="" coords="388,286,503,318" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#url" title="url()" alt="" coords="417,342,473,374" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_class_tree_graph" title="write_class_tree_graph()" alt="" coords="343,398,548,430" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_details_list" title="write_details_list()" alt="" coords="364,454,527,486" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_standard_fields" title="write_standard_fields()" alt="" coords="348,510,543,542" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_table" title="write_summary_table()" alt="" coords="348,566,543,598" />
</map>
<img src="call_graph_for_write_class.gif" alt='' usemap="#call_graph_for_write_class" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docwriter.html.HTMLWriter-class.html#write_class_tree_graph" class="summary-sig-name">write_class_tree_graph</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">doc</span>,
<span class="summary-sig-arg">graphmaker</span>)</span><br />
Write HTML code for a class tree graph of <code>doc</code> (a
classdoc), using <code>graphmaker</code> to draw the actual graph.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_class_tree_graph">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_class_tre-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_write_class_tre-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_class_tre" name="call_graph_for_write_class_tre">
<area shape="rect" href="epydoc.docwriter.dotgraph-module.html#uml_class_tree_graph" title="dotgraph.uml_class_tree_graph()" alt="" coords="440,6,707,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_private_subclasses" title="_private_subclasses()" alt="" coords="482,62,666,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#render_graph" title="render_graph()" alt="" coords="507,118,640,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_class" title="write_class()" alt="" coords="7,90,124,122" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_class_tree_graph" title="write_class_tree_graph()" alt="" coords="175,90,380,122" />
<area shape="rect" href="epydoc.docwriter.html._HTMLDocstringLinker-class.html#__init__" title="_HTMLDocstringLinker.__init__()" alt="" coords="430,174,718,206" />
</map>
<img src="call_graph_for_write_class_tre.gif" alt='' usemap="#call_graph_for_write_class_tre" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> 2.3. Trees pages</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="write_module_tree"></a><span class="summary-sig-name">write_module_tree</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_module_tree">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_module_tr-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_write_module_tr-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_module_tr" name="call_graph_for_write_module_tr">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="apidoc.APIDoc.__cmp__()" alt="" coords="361,6,585,38" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__hash__" title="apidoc.APIDoc.__hash__()" alt="" coords="361,62,585,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_write" title="_write()" alt="" coords="5,90,88,122" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module_tree" title="write_module_tree()" alt="" coords="137,90,311,122" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module_tree_item" title="write_module_tree_item()" alt="" coords="365,118,581,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_treepage_header" title="write_treepage_header()" alt="" coords="372,174,575,206" />
</map>
<img src="call_graph_for_write_module_tr.gif" alt='' usemap="#call_graph_for_write_module_tr" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docwriter.html.HTMLWriter-class.html#write_class_tree" class="summary-sig-name">write_class_tree</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>)</span><br />
Write HTML code for a nested list showing the base/subclass
relationships between all documented classes.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_class_tree">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_class_tre_2-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_write_class_tre_2-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_class_tre_2" name="call_graph_for_write_class_tre_2">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__hash__" title="apidoc.APIDoc.__hash__()" alt="" coords="340,6,564,38" />
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#mro" title="apidoc.ClassDoc.mro()" alt="" coords="355,62,550,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_write" title="_write()" alt="" coords="6,62,88,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_class_tree" title="write_class_tree()" alt="" coords="136,62,291,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_treepage_header" title="write_treepage_header()" alt="" coords="351,118,554,150" />
</map>
<img src="call_graph_for_write_class_tre_2.gif" alt='' usemap="#call_graph_for_write_class_tre_2" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="write_treepage_header"></a><span class="summary-sig-name">write_treepage_header</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">title</span>,
<span class="summary-sig-arg">url</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_treepage_header">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_treepage_-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_write_treepage_-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_treepage_" name="call_graph_for_write_treepage_">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_class_tree" title="write_class_tree()" alt="" coords="16,6,171,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_treepage_header" title="write_treepage_header()" alt="" coords="231,34,433,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module_tree" title="write_module_tree()" alt="" coords="7,62,180,94" />
</map>
<img src="call_graph_for_write_treepage_.gif" alt='' usemap="#call_graph_for_write_treepage_" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> 2.4. Index pages</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="write_link_index"></a><span class="summary-sig-name">write_link_index</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">indices</span>,
<span class="summary-sig-arg">title</span>,
<span class="summary-sig-arg">url</span>,
<span class="summary-sig-arg">index_by_section</span>,
<span class="summary-sig-arg">sections</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">ABCDEFGHIJKLMNOPQRSTUVWXYZ_</code><code class="variable-quote">'</code></span>,
<span class="summary-sig-arg">section_url</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">#%s</code><code class="variable-quote">'</code></span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_link_index">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_link_inde-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_write_link_inde-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_link_inde" name="call_graph_for_write_link_inde">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_write" title="_write()" alt="" coords="6,34,88,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_link_index" title="write_link_index()" alt="" coords="138,34,298,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_index_section" title="write_index_section()" alt="" coords="364,6,548,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_indexpage_header" title="write_indexpage_header()" alt="" coords="348,62,564,94" />
</map>
<img src="call_graph_for_write_link_inde.gif" alt='' usemap="#call_graph_for_write_link_inde" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="write_metadata_index"></a><span class="summary-sig-name">write_metadata_index</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">indices</span>,
<span class="summary-sig-arg">field</span>,
<span class="summary-sig-arg">title</span>,
<span class="summary-sig-arg">typ</span>)</span><br />
Write an HTML page containing a metadata index.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_metadata_index">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_metadata_-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_write_metadata_-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_metadata_" name="call_graph_for_write_metadata_">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_doc_or_ancestor_is_private" title="_doc_or_ancestor_is_private()" alt="" coords="384,6,635,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_write" title="_write()" alt="" coords="5,90,88,122" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_metadata_index" title="write_metadata_index()" alt="" coords="136,90,336,122" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#docstring_to_html" title="docstring_to_html()" alt="" coords="424,62,595,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#href" title="href()" alt="" coords="477,118,541,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_indexpage_header" title="write_indexpage_header()" alt="" coords="401,174,617,206" />
</map>
<img src="call_graph_for_write_metadata_.gif" alt='' usemap="#call_graph_for_write_metadata_" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="write_indexpage_header"></a><span class="summary-sig-name">write_indexpage_header</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">indices</span>,
<span class="summary-sig-arg">title</span>,
<span class="summary-sig-arg">url</span>)</span><br />
A helper for the index page generation functions, which generates a
header that can be used to navigate between the different indices.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_indexpage_header">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_indexpage-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_write_indexpage-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_indexpage" name="call_graph_for_write_indexpage">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_indexpage_header" title="write_indexpage_header()" alt="" coords="255,34,471,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_link_index" title="write_link_index()" alt="" coords="25,6,185,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_metadata_index" title="write_metadata_index()" alt="" coords="5,62,205,94" />
</map>
<img src="call_graph_for_write_indexpage.gif" alt='' usemap="#call_graph_for_write_indexpage" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="write_index_section"></a><span class="summary-sig-name">write_index_section</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">items</span>,
<span class="summary-sig-arg">add_blankline</span>=<span class="summary-sig-default">False</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_index_section">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_index_sec-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_write_index_sec-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_index_sec" name="call_graph_for_write_index_sec">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="apidoc.DottedName.__getitem__()" alt="" coords="452,6,732,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#href" title="href()" alt="" coords="560,62,624,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_index_section" title="write_index_section()" alt="" coords="218,34,402,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_link_index" title="write_link_index()" alt="" coords="7,34,167,66" />
</map>
<img src="call_graph_for_write_index_sec.gif" alt='' usemap="#call_graph_for_write_index_sec" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> 2.5. Help Page</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docwriter.html.HTMLWriter-class.html#write_help" class="summary-sig-name">write_help</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>)</span><br />
Write an HTML help file to the given stream.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_help">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_help-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_write_help-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_help" name="call_graph_for_write_help">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_write" title="_write()" alt="" coords="5,6,88,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_help" title="write_help()" alt="" coords="137,6,249,38" />
</map>
<img src="call_graph_for_write_help.gif" alt='' usemap="#call_graph_for_write_help" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> 2.6. Frames-based Table of Contents</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="write_frames_index"></a><span class="summary-sig-name">write_frames_index</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>)</span><br />
Write the frames index file for the frames-based table of contents to
the given streams.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_frames_index">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="write_toc"></a><span class="summary-sig-name">write_toc</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_toc">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="write_toc_section"></a><span class="summary-sig-name">write_toc_section</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">docs</span>,
<span class="summary-sig-arg">fullname</span>=<span class="summary-sig-default">True</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_toc_section">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_toc_secti-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_write_toc_secti-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_toc_secti" name="call_graph_for_write_toc_secti">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="apidoc.DottedName.__getitem__()" alt="" coords="441,6,721,38" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__str__" title="apidoc.DottedName.__str__()" alt="" coords="460,62,703,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_doc_or_ancestor_is_private" title="_doc_or_ancestor_is_private()" alt="" coords="456,118,707,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#url" title="url()" alt="" coords="553,174,609,206" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module_toc" title="write_module_toc()" alt="" coords="7,62,175,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_toc_section" title="write_toc_section()" alt="" coords="225,90,391,122" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_project_toc" title="write_project_toc()" alt="" coords="8,118,173,150" />
</map>
<img src="call_graph_for_write_toc_secti.gif" alt='' usemap="#call_graph_for_write_toc_secti" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="write_project_toc"></a><span class="summary-sig-name">write_project_toc</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_project_toc">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_project_t-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_write_project_t-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_project_t" name="call_graph_for_write_project_t">
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#container" title="apidoc.DocIndex.container()" alt="" coords="383,6,617,38" />
<area shape="rect" href="epydoc.apidoc.ModuleDoc-class.html#select_variables" title="apidoc.ModuleDoc.select_variables()" alt="" coords="349,62,651,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_write" title="_write()" alt="" coords="5,62,88,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_project_toc" title="write_project_toc()" alt="" coords="136,62,301,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_toc_section" title="write_toc_section()" alt="" coords="417,118,583,150" />
</map>
<img src="call_graph_for_write_project_t.gif" alt='' usemap="#call_graph_for_write_project_t" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docwriter.html.HTMLWriter-class.html#write_module_toc" class="summary-sig-name">write_module_toc</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">doc</span>)</span><br />
Write an HTML page containing the table of contents page for the
given module to the given streams.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_module_toc">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_module_to-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_write_module_to-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_module_to" name="call_graph_for_write_module_to">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="apidoc.DottedName.__getitem__()" alt="" coords="365,6,645,38" />
<area shape="rect" href="epydoc.apidoc.ModuleDoc-class.html#select_variables" title="apidoc.ModuleDoc.select_variables()" alt="" coords="355,62,656,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_write" title="_write()" alt="" coords="5,62,88,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module_toc" title="write_module_toc()" alt="" coords="137,62,305,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_toc_section" title="write_toc_section()" alt="" coords="423,118,588,150" />
</map>
<img src="call_graph_for_write_module_to.gif" alt='' usemap="#call_graph_for_write_module_to" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> 2.7. Project homepage (index.html)</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docwriter.html.HTMLWriter-class.html#write_homepage" class="summary-sig-name">write_homepage</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">directory</span>)</span><br />
Write an <code>index.html</code> file in the given directory.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_homepage">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_homepage-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_write_homepage-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_homepage" name="call_graph_for_write_homepage">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write" title="write()" alt="" coords="6,6,78,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_homepage" title="write_homepage()" alt="" coords="127,6,284,38" />
</map>
<img src="call_graph_for_write_homepage.gif" alt='' usemap="#call_graph_for_write_homepage" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="write_redirect_index"></a><span class="summary-sig-name">write_redirect_index</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">top</span>,
<span class="summary-sig-arg">name</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_redirect_index">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> 2.8. Stylesheet (epydoc.css)</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>None</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docwriter.html.HTMLWriter-class.html#write_css" class="summary-sig-name">write_css</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">directory</span>,
<span class="summary-sig-arg">cssname</span>)</span><br />
Write the CSS stylesheet in the given directory.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_css">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_css-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_write_css-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_css" name="call_graph_for_write_css">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write" title="write()" alt="" coords="5,6,77,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_css" title="write_css()" alt="" coords="127,6,231,38" />
</map>
<img src="call_graph_for_write_css.gif" alt='' usemap="#call_graph_for_write_css" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> 2.9. Javascript (epydoc.js)</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="write_javascript"></a><span class="summary-sig-name">write_javascript</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">directory</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_javascript">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_javascrip-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_write_javascrip-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_javascrip" name="call_graph_for_write_javascrip">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write" title="write()" alt="" coords="5,6,77,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_javascript" title="write_javascript()" alt="" coords="125,6,280,38" />
</map>
<img src="call_graph_for_write_javascrip.gif" alt='' usemap="#call_graph_for_write_javascrip" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> 2.10. Graphs</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="render_graph"></a><span class="summary-sig-name">render_graph</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">graph</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.render_graph">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_render_graph-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_render_graph-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_render_graph" name="call_graph_for_render_graph">
<area shape="rect" href="epydoc.docwriter.dotgraph.DotGraph-class.html#to_html" title="dotgraph.DotGraph.to_html()" alt="" coords="447,6,687,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#render_graph" title="render_graph()" alt="" coords="263,6,396,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_class_tree_graph" title="write_class_tree_graph()" alt="" coords="7,6,212,38" />
</map>
<img src="call_graph_for_render_graph.gif" alt='' usemap="#call_graph_for_render_graph" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>str</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docwriter.html.HTMLWriter-class.html#render_callgraph" class="summary-sig-name">render_callgraph</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">callgraph</span>,
<span class="summary-sig-arg">token</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span><br />
Render the HTML chunk of a callgraph.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.render_callgraph">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>str</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docwriter.html.HTMLWriter-class.html#callgraph_link" class="summary-sig-name">callgraph_link</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">callgraph</span>,
<span class="summary-sig-arg">token</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span><br />
Render the HTML chunk of a callgraph link.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.callgraph_link">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> 2.11. Images</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="write_images"></a><span class="summary-sig-name">write_images</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">directory</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_images">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_images-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_write_images-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_images" name="call_graph_for_write_images">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write" title="write()" alt="" coords="6,6,78,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_images" title="write_images()" alt="" coords="127,6,260,38" />
</map>
<img src="call_graph_for_write_images.gif" alt='' usemap="#call_graph_for_write_images" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> 3.1. Page Header</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docwriter.html.HTMLWriter-class.html#write_header" class="summary-sig-name">write_header</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">title</span>)</span><br />
Generate HTML code for the standard page header, and write it to
<code>out</code>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_header">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> 3.2. Page Footer</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="write_footer"></a><span class="summary-sig-name">write_footer</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">short</span>=<span class="summary-sig-default">False</span>)</span><br />
Generate HTML code for the standard page footer, and write it to
<code>out</code>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_footer">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> 3.3. Navigation Bar</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docwriter.html.HTMLWriter-class.html#write_navbar" class="summary-sig-name">write_navbar</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">context</span>)</span><br />
Generate HTML code for the navigation bar, and write it to
<code>out</code>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_navbar">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> 3.4. Breadcrumbs</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docwriter.html.HTMLWriter-class.html#write_breadcrumbs" class="summary-sig-name">write_breadcrumbs</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">context</span>,
<span class="summary-sig-arg">context_url</span>)</span><br />
Generate HTML for the breadcrumbs line, and write it to
<code>out</code>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_breadcrumbs">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="breadcrumbs"></a><span class="summary-sig-name">breadcrumbs</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">doc</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.breadcrumbs">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_breadcrumbs-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_breadcrumbs-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_breadcrumbs" name="call_graph_for_breadcrumbs">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="apidoc.APIDoc.__cmp__()" alt="" coords="216,6,440,38" />
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#container" title="apidoc.DocIndex.container()" alt="" coords="211,62,446,94" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="apidoc.DottedName.__getitem__()" alt="" coords="188,118,468,150" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__len__" title="apidoc.DottedName.__len__()" alt="" coords="204,174,452,206" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_crumb" title="_crumb()" alt="" coords="283,230,374,262" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#breadcrumbs" title="breadcrumbs()" alt="" coords="7,146,138,178" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#href" title="href()" alt="" coords="296,286,360,318" />
</map>
<img src="call_graph_for_breadcrumbs.gif" alt='' usemap="#call_graph_for_breadcrumbs" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_crumb"></a><span class="summary-sig-name">_crumb</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">doc</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter._crumb">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__crumb-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__crumb-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__crumb" name="call_graph_for__crumb">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="apidoc.DottedName.__getitem__()" alt="" coords="329,6,609,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_crumb" title="_crumb()" alt="" coords="188,34,279,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#doc_kind" title="doc_kind()" alt="" coords="417,62,521,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#breadcrumbs" title="breadcrumbs()" alt="" coords="7,34,137,66" />
</map>
<img src="call_graph_for__crumb.gif" alt='' usemap="#call_graph_for__crumb" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> 3.5. Summary Tables</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_table" class="summary-sig-name">write_summary_table</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">heading</span>,
<span class="summary-sig-arg">doc</span>,
<span class="summary-sig-arg">value_type</span>)</span><br />
Generate HTML code for a summary table, and write it to
<code>out</code>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_summary_table">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_summary_t-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_write_summary_t-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_summary_t" name="call_graph_for_write_summary_t">
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#select_variables" title="apidoc.ClassDoc.select_variables()" alt="" coords="452,6,735,38" />
<area shape="rect" href="epydoc.apidoc.ModuleDoc-class.html#select_variables" title="apidoc.ModuleDoc.select_variables()" alt="" coords="443,62,744,94" />
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#group_names" title="apidoc.NamespaceDoc.group_names()" alt="" coords="439,118,748,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_class" title="write_class()" alt="" coords="16,90,134,122" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_table" title="write_summary_table()" alt="" coords="194,118,388,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module" title="write_module()" alt="" coords="7,146,143,178" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_group" title="write_summary_group()" alt="" coords="492,174,695,206" />
<area shape="rect" href="epydoc.util-module.html#plaintext_to_html" title="util.plaintext_to_html()" alt="" coords="495,230,692,262" />
</map>
<img src="call_graph_for_write_summary_t.gif" alt='' usemap="#call_graph_for_write_summary_t" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="write_summary_group"></a><span class="summary-sig-name">write_summary_group</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">doc</span>,
<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">var_docs</span>,
<span class="summary-sig-arg">grouped_inh_vars</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_summary_group">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_summary_g-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_write_summary_g-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_summary_g" name="call_graph_for_write_summary_g">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="apidoc.APIDoc.__cmp__()" alt="" coords="503,6,727,38" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__hash__" title="apidoc.APIDoc.__hash__()" alt="" coords="503,62,727,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_inheritance_list" title="write_inheritance_list()" alt="" coords="517,118,712,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_group" title="write_summary_group()" alt="" coords="251,90,453,122" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_line" title="write_summary_line()" alt="" coords="521,174,708,206" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_table" title="write_summary_table()" alt="" coords="7,90,201,122" />
</map>
<img src="call_graph_for_write_summary_g.gif" alt='' usemap="#call_graph_for_write_summary_g" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="write_inheritance_list"></a><span class="summary-sig-name">write_inheritance_list</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">doc</span>,
<span class="summary-sig-arg">listed_inh_vars</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_inheritance_list">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_inheritan-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_write_inheritan-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_inheritan" name="call_graph_for_write_inheritan">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="apidoc.APIDoc.__cmp__()" alt="" coords="503,6,727,38" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__hash__" title="apidoc.APIDoc.__hash__()" alt="" coords="503,62,727,94" />
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#mro" title="apidoc.ClassDoc.mro()" alt="" coords="517,118,712,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#href" title="href()" alt="" coords="583,174,647,206" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_inheritance_list" title="write_inheritance_list()" alt="" coords="257,118,452,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_var_list" title="write_var_list()" alt="" coords="547,230,683,262" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_group" title="write_summary_group()" alt="" coords="5,118,208,150" />
</map>
<img src="call_graph_for_write_inheritan.gif" alt='' usemap="#call_graph_for_write_inheritan" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="write_var_list"></a><span class="summary-sig-name">write_var_list</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">vardocs</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_var_list">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_var_list-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_write_var_list-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_var_list" name="call_graph_for_write_var_list">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#href" title="href()" alt="" coords="439,6,503,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_inheritance_list" title="write_inheritance_list()" alt="" coords="7,6,201,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_var_list" title="write_var_list()" alt="" coords="252,6,388,38" />
</map>
<img src="call_graph_for_write_var_list.gif" alt='' usemap="#call_graph_for_write_var_list" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_line" class="summary-sig-name">write_summary_line</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">var_doc</span>,
<span class="summary-sig-arg">container</span>)</span><br />
Generate HTML code for a single line of a summary table, and write it
to <code>out</code>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_summary_line">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_summary_l-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_write_summary_l-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_summary_l" name="call_graph_for_write_summary_l">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="apidoc.APIDoc.__cmp__()" alt="" coords="582,6,806,38" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#summary_pyval_repr" title="apidoc.ValueDoc.summary_pyval_repr()" alt="" coords="530,62,858,94" />
<area shape="rect" href="epydoc.apidoc.VariableDoc-class.html#is_detailed" title="apidoc.VariableDoc.is_detailed()" alt="" coords="559,118,828,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#function_signature" title="function_signature()" alt="" coords="607,174,780,206" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#pysrc_link" title="pysrc_link()" alt="" coords="636,230,751,262" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#return_type" title="return_type()" alt="" coords="634,286,754,318" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#summary" title="summary()" alt="" coords="642,342,746,374" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#summary_name" title="summary_name()" alt="" coords="618,398,770,430" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#type_descr" title="type_descr()" alt="" coords="636,454,751,486" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#variable_tooltip" title="variable_tooltip()" alt="" coords="618,510,770,542" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_group" title="write_summary_group()" alt="" coords="6,286,208,318" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_line" title="write_summary_line()" alt="" coords="258,286,444,318" />
<area shape="rect" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#to_html" title="markup.epytext.ParsedEpytextDocstring.to_html()" alt="" coords="495,566,892,598" />
</map>
<img src="call_graph_for_write_summary_l.gif" alt='' usemap="#call_graph_for_write_summary_l" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_write_summary_line"></a><span class="summary-sig-name">_write_summary_line</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">typ</span>,
<span class="summary-sig-arg">description</span>,
<span class="summary-sig-arg">tr_class</span>,
<span class="summary-sig-arg">pysrc_link</span>,
<span class="summary-sig-arg">callgraph</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter._write_summary_line">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> 3.6. Details Lists</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="write_details_list"></a><span class="summary-sig-name">write_details_list</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">heading</span>,
<span class="summary-sig-arg">doc</span>,
<span class="summary-sig-arg">value_type</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_details_list">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_details_l-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_write_details_l-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_details_l" name="call_graph_for_write_details_l">
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#select_variables" title="apidoc.ClassDoc.select_variables()" alt="" coords="412,6,695,38" />
<area shape="rect" href="epydoc.apidoc.ModuleDoc-class.html#select_variables" title="apidoc.ModuleDoc.select_variables()" alt="" coords="403,62,704,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_class" title="write_class()" alt="" coords="16,34,133,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_details_list" title="write_details_list()" alt="" coords="192,62,355,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_details_entry" title="write_details_entry()" alt="" coords="465,118,641,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module" title="write_module()" alt="" coords="7,90,143,122" />
</map>
<img src="call_graph_for_write_details_l.gif" alt='' usemap="#call_graph_for_write_details_l" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="write_details_entry"></a><span class="summary-sig-name">write_details_entry</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">var_doc</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_details_entry">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_details_e-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_write_details_e-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_details_e" name="call_graph_for_write_details_e">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="apidoc.APIDoc.__cmp__()" alt="" coords="449,6,673,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#arg_name_to_html" title="arg_name_to_html()" alt="" coords="475,62,648,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#descr" title="descr()" alt="" coords="525,118,597,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#docstring_to_html" title="docstring_to_html()" alt="" coords="476,174,647,206" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#property_accessor_to_html" title="property_accessor_to_html()" alt="" coords="443,230,680,262" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#return_descr" title="return_descr()" alt="" coords="497,286,625,318" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#return_type" title="return_type()" alt="" coords="501,342,621,374" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#summary" title="summary()" alt="" coords="509,398,613,430" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_details_entry" title="write_details_entry()" alt="" coords="217,202,393,234" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_details_list" title="write_details_list()" alt="" coords="5,202,168,234" />
</map>
<img src="call_graph_for_write_details_e.gif" alt='' usemap="#call_graph_for_write_details_e" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="labelled_list_item"></a><span class="summary-sig-name">labelled_list_item</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">lhs</span>,
<span class="summary-sig-arg">rhs</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.labelled_list_item">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="property_accessor_to_html"></a><span class="summary-sig-name">property_accessor_to_html</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">val_doc</span>,
<span class="summary-sig-arg">context</span>=<span class="summary-sig-default">None</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.property_accessor_to_html">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_property_access-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_property_access-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_property_access" name="call_graph_for_property_access">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="apidoc.APIDoc.__cmp__()" alt="" coords="518,6,742,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#function_signature" title="function_signature()" alt="" coords="543,62,716,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#property_accessor_to_html" title="property_accessor_to_html()" alt="" coords="232,34,470,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_details_entry" title="write_details_entry()" alt="" coords="7,34,183,66" />
</map>
<img src="call_graph_for_property_access.gif" alt='' usemap="#call_graph_for_property_access" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docwriter.html.HTMLWriter-class.html#arg_name_to_html" class="summary-sig-name">arg_name_to_html</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">func_doc</span>,
<span class="summary-sig-arg">arg_name</span>)</span><br />
A helper function used to format an argument name, for use in the
argument description list under a routine's details entry.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.arg_name_to_html">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_arg_name_to_htm-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_arg_name_to_htm-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_arg_name_to_htm" name="call_graph_for_arg_name_to_htm">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#arg_name_to_html" title="arg_name_to_html()" alt="" coords="233,6,407,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#docstring_to_html" title="docstring_to_html()" alt="" coords="456,6,627,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_details_entry" title="write_details_entry()" alt="" coords="7,6,183,38" />
</map>
<img src="call_graph_for_arg_name_to_htm.gif" alt='' usemap="#call_graph_for_arg_name_to_htm" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="write_function_details_entry"></a><span class="summary-sig-name">write_function_details_entry</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">var_doc</span>,
<span class="summary-sig-arg">descr</span>,
<span class="summary-sig-arg">callgraph</span>,
<span class="summary-sig-arg">rtype</span>,
<span class="summary-sig-arg">rdescr</span>,
<span class="summary-sig-arg">arg_descrs</span>,
<span class="summary-sig-arg">div_class</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_function_details_entry">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="write_property_details_entry"></a><span class="summary-sig-name">write_property_details_entry</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">var_doc</span>,
<span class="summary-sig-arg">descr</span>,
<span class="summary-sig-arg">accessors</span>,
<span class="summary-sig-arg">div_class</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_property_details_entry">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="write_variable_details_entry"></a><span class="summary-sig-name">write_variable_details_entry</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">var_doc</span>,
<span class="summary-sig-arg">descr</span>,
<span class="summary-sig-arg">div_class</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_variable_details_entry">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="variable_tooltip"></a><span class="summary-sig-name">variable_tooltip</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">var_doc</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.variable_tooltip">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_variable_toolti-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_variable_toolti-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_variable_toolti" name="call_graph_for_variable_toolti">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="apidoc.APIDoc.__cmp__()" alt="" coords="545,6,769,38" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#pyval_repr" title="apidoc.ValueDoc.pyval_repr()" alt="" coords="533,62,781,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#variable_tooltip" title="variable_tooltip()" alt="" coords="243,90,395,122" />
<area shape="rect" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#to_plaintext" title="markup.epytext.ParsedEpytextDocstring.to_plaintext()" alt="" coords="443,118,872,150" />
<area shape="rect" href="epydoc.util-module.html#plaintext_to_html" title="util.plaintext_to_html()" alt="" coords="559,174,756,206" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_line" title="write_summary_line()" alt="" coords="7,90,193,122" />
</map>
<img src="call_graph_for_variable_toolti.gif" alt='' usemap="#call_graph_for_variable_toolti" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="pprint_value"></a><span class="summary-sig-name">pprint_value</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">val_doc</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.pprint_value">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_pprint_value-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_pprint_value-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_pprint_value" name="call_graph_for_pprint_value">
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#pyval_repr" title="apidoc.ValueDoc.pyval_repr()" alt="" coords="260,6,508,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#pprint_value" title="pprint_value()" alt="" coords="7,34,135,66" />
<area shape="rect" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#to_html" title="markup.epytext.ParsedEpytextDocstring.to_html()" alt="" coords="185,62,583,94" />
</map>
<img src="call_graph_for_pprint_value.gif" alt='' usemap="#call_graph_for_pprint_value" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Base Tree</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>string</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docwriter.html.HTMLWriter-class.html#base_tree" class="summary-sig-name">base_tree</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">doc</span>,
<span class="summary-sig-arg">width</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">postfix</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
<span class="summary-sig-arg">context</span>=<span class="summary-sig-default">None</span>)</span><br />
Returns:
The HTML code for a class's base tree.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.base_tree">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>int</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docwriter.html.HTMLWriter-class.html#find_tree_width" class="summary-sig-name">find_tree_width</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">doc</span>,
<span class="summary-sig-arg">context</span>)</span><br />
Helper function for <a
href="epydoc.docwriter.html.HTMLWriter-class.html#base_tree"
class="link">base_tree</a>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.find_tree_width">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="contextual_label"></a><span class="summary-sig-name">contextual_label</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">doc</span>,
<span class="summary-sig-arg">context</span>)</span><br />
Return the label for <code>doc</code> to be shown in
<code>context</code>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.contextual_label">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Function Signatures</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>str</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docwriter.html.HTMLWriter-class.html#function_signature" class="summary-sig-name">function_signature</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">api_doc</span>,
<span class="summary-sig-arg">is_summary</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">link_name</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">anchor</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">context</span>=<span class="summary-sig-default">None</span>)</span><br />
Render a function signature in HTML.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.function_signature">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_function_signat-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_function_signat-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_function_signat" name="call_graph_for_function_signat">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="apidoc.APIDoc.__cmp__()" alt="" coords="512,6,736,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#func_arg" title="func_arg()" alt="" coords="575,62,673,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#function_signature" title="function_signature()" alt="" coords="291,90,464,122" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#href" title="href()" alt="" coords="592,118,656,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#summary_name" title="summary_name()" alt="" coords="548,174,700,206" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#property_accessor_to_html" title="property_accessor_to_html()" alt="" coords="5,62,243,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_line" title="write_summary_line()" alt="" coords="31,118,217,150" />
</map>
<img src="call_graph_for_function_signat.gif" alt='' usemap="#call_graph_for_function_signat" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>str</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docwriter.html.HTMLWriter-class.html#summary_name" class="summary-sig-name">summary_name</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">api_doc</span>,
<span class="summary-sig-arg">css_class</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">summary-name</code><code class="variable-quote">'</code></span>,
<span class="summary-sig-arg">link_name</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">anchor</span>=<span class="summary-sig-default">False</span>)</span><br />
Render an object name in HTML.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.summary_name">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_summary_name-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_summary_name-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_summary_name" name="call_graph_for_summary_name">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#function_signature" title="function_signature()" alt="" coords="13,6,187,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#summary_name" title="summary_name()" alt="" coords="244,34,396,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#href" title="href()" alt="" coords="447,34,511,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_line" title="write_summary_line()" alt="" coords="7,62,193,94" />
</map>
<img src="call_graph_for_summary_name.gif" alt='' usemap="#call_graph_for_summary_name" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="func_arg"></a><span class="summary-sig-name">func_arg</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">default</span>,
<span class="summary-sig-arg">css_class</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.func_arg">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_func_arg-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_func_arg-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_func_arg" name="call_graph_for_func_arg">
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#summary_pyval_repr" title="apidoc.ValueDoc.summary_pyval_repr()" alt="" coords="412,6,740,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_arg_name" title="_arg_name()" alt="" coords="517,62,635,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#func_arg" title="func_arg()" alt="" coords="228,62,327,94" />
<area shape="rect" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#to_html" title="markup.epytext.ParsedEpytextDocstring.to_html()" alt="" coords="377,118,775,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#function_signature" title="function_signature()" alt="" coords="5,62,179,94" />
</map>
<img src="call_graph_for_func_arg.gif" alt='' usemap="#call_graph_for_func_arg" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_arg_name"></a><span class="summary-sig-name">_arg_name</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">arg</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter._arg_name">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__arg_name-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__arg_name-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__arg_name" name="call_graph_for__arg_name">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_arg_name" title="_arg_name()" alt="" coords="156,30,273,62" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#func_arg" title="func_arg()" alt="" coords="7,30,105,62" />
</map>
<img src="call_graph_for__arg_name.gif" alt='' usemap="#call_graph_for__arg_name" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Import Lists</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="write_imports"></a><span class="summary-sig-name">write_imports</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">doc</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_imports">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_import"></a><span class="summary-sig-name">_import</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">var_doc</span>,
<span class="summary-sig-arg">context</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter._import">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Module Trees</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="write_module_list"></a><span class="summary-sig-name">write_module_list</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">doc</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_module_list">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_module_li-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_write_module_li-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_module_li" name="call_graph_for_write_module_li">
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#group_names" title="apidoc.NamespaceDoc.group_names()" alt="" coords="412,6,721,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module" title="write_module()" alt="" coords="7,34,143,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module_list" title="write_module_list()" alt="" coords="193,34,361,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module_tree_item" title="write_module_tree_item()" alt="" coords="459,62,675,94" />
</map>
<img src="call_graph_for_write_module_li.gif" alt='' usemap="#call_graph_for_write_module_li" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="write_module_tree_item"></a><span class="summary-sig-name">write_module_tree_item</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">doc</span>,
<span class="summary-sig-arg">package</span>=<span class="summary-sig-default">None</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_module_tree_item">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_module_tr_2-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_write_module_tr_2-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_module_tr_2" name="call_graph_for_write_module_tr_2">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="apidoc.DottedName.__getitem__()" alt="" coords="497,6,777,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#description" title="description()" alt="" coords="579,62,696,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#href" title="href()" alt="" coords="605,118,669,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module_list" title="write_module_list()" alt="" coords="9,34,177,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module_tree_item" title="write_module_tree_item()" alt="" coords="231,62,447,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module_tree" title="write_module_tree()" alt="" coords="7,90,180,122" />
</map>
<img src="call_graph_for_write_module_tr_2.gif" alt='' usemap="#call_graph_for_write_module_tr_2" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Class trees</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="write_class_tree_item"></a><span class="summary-sig-name">write_class_tree_item</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">doc</span>,
<span class="summary-sig-arg">class_set</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_class_tree_item">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Standard Fields</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docwriter.html.HTMLWriter-class.html#write_standard_fields" class="summary-sig-name">write_standard_fields</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">doc</span>)</span><br />
Write HTML code containing descriptions of any standard markup fields
that are defined by the given <a
href="epydoc.apidoc.APIDoc-class.html" class="link">APIDoc</a> object
(such as <code>@author</code> and <code>@todo</code> fields).</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_standard_fields">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_standard_-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_write_standard_-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_standard_" name="call_graph_for_write_standard_">
<area shape="rect" href="epydoc.docstringparser.DocstringField-class.html#__hash__" title="docstringparser.DocstringField.__hash__()" alt="" coords="435,34,776,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_class" title="write_class()" alt="" coords="16,6,133,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_standard_fields" title="write_standard_fields()" alt="" coords="192,34,387,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module" title="write_module()" alt="" coords="7,62,143,94" />
</map>
<img src="call_graph_for_write_standard_.gif" alt='' usemap="#call_graph_for_write_standard_" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="write_standard_field"></a><span class="summary-sig-name">write_standard_field</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">doc</span>,
<span class="summary-sig-arg">field</span>,
<span class="summary-sig-arg">descrs</span>,
<span class="summary-sig-arg">arg</span>=<span class="summary-sig-default">''</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_standard_field">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Index generation</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="build_identifier_index"></a><span class="summary-sig-name">build_identifier_index</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.build_identifier_index">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_build_identifie-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_build_identifie-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_build_identifie" name="call_graph_for_build_identifie">
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#container" title="apidoc.DocIndex.container()" alt="" coords="400,6,635,38" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="apidoc.DottedName.__getitem__()" alt="" coords="377,62,657,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#build_identifier_index" title="build_identifier_index()" alt="" coords="127,90,327,122" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#url" title="url()" alt="" coords="489,118,545,150" />
<area shape="rect" href="epydoc.util-module.html#plaintext_to_html" title="util.plaintext_to_html()" alt="" coords="419,174,616,206" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write" title="write()" alt="" coords="5,90,77,122" />
</map>
<img src="call_graph_for_build_identifie.gif" alt='' usemap="#call_graph_for_build_identifie" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_group_by_letter"></a><span class="summary-sig-name">_group_by_letter</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">items</span>)</span><br />
Preserves sort order of the input.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter._group_by_letter">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__group_by_lette-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__group_by_lette-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__group_by_lette" name="call_graph_for__group_by_lette">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_group_by_letter" title="_group_by_letter()" alt="" coords="127,6,289,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write" title="write()" alt="" coords="5,6,77,38" />
</map>
<img src="call_graph_for__group_by_lette.gif" alt='' usemap="#call_graph_for__group_by_lette" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="build_term_index"></a><span class="summary-sig-name">build_term_index</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.build_term_index">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_build_term_inde-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_build_term_inde-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_build_term_inde" name="call_graph_for_build_term_inde">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_terms_from_docstring" title="_terms_from_docstring()" alt="" coords="343,6,551,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#build_term_index" title="build_term_index()" alt="" coords="125,34,293,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#url" title="url()" alt="" coords="419,62,475,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write" title="write()" alt="" coords="5,34,77,66" />
</map>
<img src="call_graph_for_build_term_inde.gif" alt='' usemap="#call_graph_for_build_term_inde" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_terms_from_docstring"></a><span class="summary-sig-name">_terms_from_docstring</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">base_url</span>,
<span class="summary-sig-arg">container</span>,
<span class="summary-sig-arg">parsed_docstring</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter._terms_from_docstring">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__terms_from_doc-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__terms_from_doc-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__terms_from_doc" name="call_graph_for__terms_from_doc">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_term_index_to_anchor" title="_term_index_to_anchor()" alt="" coords="604,6,818,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_terms_from_docstring" title="_terms_from_docstring()" alt="" coords="223,146,431,178" />
<area shape="rect" href="epydoc.markup.ConcatenatedDocstring-class.html#index_terms" title="markup.ConcatenatedDocstring.index_terms()" alt="" coords="528,62,894,94" />
<area shape="rect" href="epydoc.markup.ParsedDocstring-class.html#index_terms" title="markup.ParsedDocstring.index_terms()" alt="" coords="554,118,868,150" />
<area shape="rect" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#index_terms" title="markup.epytext.ParsedEpytextDocstring.index_terms()" alt="" coords="495,174,927,206" />
<area shape="rect" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#to_plaintext" title="markup.epytext.ParsedEpytextDocstring.to_plaintext()" alt="" coords="496,230,926,262" />
<area shape="rect" href="epydoc.markup.restructuredtext.ParsedRstDocstring-class.html#index_terms" title="markup.restructuredtext.ParsedRstDocstring.index_terms()" alt="" coords="480,286,942,318" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#build_term_index" title="build_term_index()" alt="" coords="6,146,174,178" />
</map>
<img src="call_graph_for__terms_from_doc.gif" alt='' usemap="#call_graph_for__terms_from_doc" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="build_metadata_index"></a><span class="summary-sig-name">build_metadata_index</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">field_name</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.build_metadata_index">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_build_metadata_-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_build_metadata_-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_build_metadata_" name="call_graph_for_build_metadata_">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#build_metadata_index" title="build_metadata_index()" alt="" coords="127,6,327,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write" title="write()" alt="" coords="5,6,77,38" />
</map>
<img src="call_graph_for_build_metadata_.gif" alt='' usemap="#call_graph_for_build_metadata_" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docwriter.html.HTMLWriter-class.html#_term_index_to_anchor" class="summary-sig-name" onclick="show_private();">_term_index_to_anchor</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">term</span>)</span><br />
Given the name of an inline index item, construct a URI anchor.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter._term_index_to_anchor">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__term_index_to_-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__term_index_to_-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__term_index_to_" name="call_graph_for__term_index_to_">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_term_index_to_anchor" title="_term_index_to_anchor()" alt="" coords="427,34,640,66" />
<area shape="rect" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#to_plaintext" title="markup.epytext.ParsedEpytextDocstring.to_plaintext()" alt="" coords="688,34,1118,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_terms_from_docstring" title="_terms_from_docstring()" alt="" coords="88,6,296,38" />
<area shape="rect" href="epydoc.docwriter.html._HTMLDocstringLinker-class.html#translate_indexterm" title="_HTMLDocstringLinker.translate_indexterm()" alt="" coords="6,62,379,94" />
</map>
<img src="call_graph_for__term_index_to_.gif" alt='' usemap="#call_graph_for__term_index_to_" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Redirect page</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docwriter.html.HTMLWriter-class.html#write_redirect_page" class="summary-sig-name">write_redirect_page</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>)</span><br />
Build the auto-redirect page, which translates dotted names to URLs
using javascript.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_redirect_page">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_redirect__2-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_write_redirect__2-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_redirect__2" name="call_graph_for_write_redirect__2">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__str__" title="apidoc.DottedName.__str__()" alt="" coords="370,6,612,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_write" title="_write()" alt="" coords="6,6,88,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_redirect_page" title="write_redirect_page()" alt="" coords="138,6,319,38" />
</map>
<img src="call_graph_for_write_redirect__2.gif" alt='' usemap="#call_graph_for_write_redirect__2" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_write_redirect_page"></a><span class="summary-sig-name">_write_redirect_page</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">pages</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter._write_redirect_page">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> URLs list</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="write_api_list"></a><span class="summary-sig-name">write_api_list</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>)</span><br />
Write a list of mapping name->url for all the documented objects.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_api_list">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_api_list-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_write_api_list-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_api_list" name="call_graph_for_write_api_list">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_write" title="_write()" alt="" coords="5,6,88,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_api_list" title="write_api_list()" alt="" coords="136,6,272,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_url_record" title="write_url_record()" alt="" coords="321,6,479,38" />
</map>
<img src="call_graph_for_write_api_list.gif" alt='' usemap="#call_graph_for_write_api_list" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="write_url_record"></a><span class="summary-sig-name">write_url_record</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">obj</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_url_record">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_url_recor-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_write_url_recor-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_url_recor" name="call_graph_for_write_url_recor">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__str__" title="apidoc.DottedName.__str__()" alt="" coords="399,6,641,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#url" title="url()" alt="" coords="492,62,548,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_api_list" title="write_api_list()" alt="" coords="5,34,141,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_url_record" title="write_url_record()" alt="" coords="191,34,348,66" />
</map>
<img src="call_graph_for_write_url_recor.gif" alt='' usemap="#call_graph_for_write_url_recor" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Helper functions</th></tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_val_is_public"></a><span class="summary-sig-name">_val_is_public</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">valdoc</span>)</span><br />
Make a best-guess as to whether the given class is public.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter._val_is_public">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__val_is_public-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__val_is_public-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__val_is_public" name="call_graph_for__val_is_public">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="apidoc.APIDoc.__cmp__()" alt="" coords="439,6,663,38" />
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#container" title="apidoc.DocIndex.container()" alt="" coords="434,62,668,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_private_subclasses" title="_private_subclasses()" alt="" coords="6,6,190,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_val_is_public" title="_val_is_public()" alt="" coords="239,34,383,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#href" title="href()" alt="" coords="66,62,130,94" />
</map>
<img src="call_graph_for__val_is_public.gif" alt='' usemap="#call_graph_for__val_is_public" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="write_table_header"></a><span class="summary-sig-name">write_table_header</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">css_class</span>,
<span class="summary-sig-arg">heading</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">private_link</span>=<span class="summary-sig-default">True</span>,
<span class="summary-sig-arg">colspan</span>=<span class="summary-sig-default">2</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_table_header">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="write_group_header"></a><span class="summary-sig-name">write_group_header</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">out</span>,
<span class="summary-sig-arg">group</span>,
<span class="summary-sig-arg">tr_class</span>=<span class="summary-sig-default">''</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_group_header">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="url"></a><span class="summary-sig-name">url</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">obj</span>)</span><br />
Return the URL for the given object, which can be a
<code>VariableDoc</code>, a <code>ValueDoc</code>, or a
<code>DottedName</code>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.url">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_url-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_url-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_url" name="call_graph_for_url">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_find_top_page" title="_find_top_page()" alt="" coords="119,6,271,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#url" title="url()" alt="" coords="432,286,488,318" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_url" title="_url()" alt="" coords="537,286,601,318" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#build_identifier_index" title="build_identifier_index()" alt="" coords="95,62,295,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#build_term_index" title="build_term_index()" alt="" coords="111,118,279,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#href" title="href()" alt="" coords="163,174,227,206" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write" title="write()" alt="" coords="159,230,231,262" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_class" title="write_class()" alt="" coords="136,286,253,318" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module" title="write_module()" alt="" coords="127,342,263,374" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_toc_section" title="write_toc_section()" alt="" coords="112,398,277,430" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_url_record" title="write_url_record()" alt="" coords="116,454,273,486" />
<area shape="rect" href="epydoc.docwriter.html._HTMLDocstringLinker-class.html#url_for" title="_HTMLDocstringLinker.url_for()" alt="" coords="56,510,333,542" />
<area shape="rect" href="epydoc.docwriter.html_colorize.PythonSourceColorizer-class.html#doclink" title="html_colorize.PythonSourceColorizer.doclink()" alt="" coords="5,566,384,598" />
</map>
<img src="call_graph_for_url.gif" alt='' usemap="#call_graph_for_url" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_url"></a><span class="summary-sig-name">_url</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">obj</span>)</span><br />
Internal helper for <a
href="epydoc.docwriter.html.HTMLWriter-class.html#url"
class="link">url</a>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter._url">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__url-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__url-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__url" name="call_graph_for__url">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="apidoc.APIDoc.__cmp__()" alt="" coords="149,6,373,38" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__hash__" title="apidoc.APIDoc.__hash__()" alt="" coords="149,62,373,94" />
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#container" title="apidoc.DocIndex.container()" alt="" coords="144,118,379,150" />
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#get_valdoc" title="apidoc.DocIndex.get_valdoc()" alt="" coords="137,174,385,206" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="apidoc.DottedName.__getitem__()" alt="" coords="121,230,401,262" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__str__" title="apidoc.DottedName.__str__()" alt="" coords="140,286,383,318" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_url" title="_url()" alt="" coords="7,202,71,234" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#url" title="url()" alt="" coords="233,342,289,374" />
</map>
<img src="call_graph_for__url.gif" alt='' usemap="#call_graph_for__url" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="pysrc_link"></a><span class="summary-sig-name">pysrc_link</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">api_doc</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.pysrc_link">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_pysrc_link-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_pysrc_link-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_pysrc_link" name="call_graph_for_pysrc_link">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#pysrc_link" title="pysrc_link()" alt="" coords="243,62,357,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#pysrc_url" title="pysrc_url()" alt="" coords="407,62,511,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_class" title="write_class()" alt="" coords="41,6,159,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module" title="write_module()" alt="" coords="32,62,168,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_line" title="write_summary_line()" alt="" coords="7,118,193,150" />
</map>
<img src="call_graph_for_pysrc_link.gif" alt='' usemap="#call_graph_for_pysrc_link" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="pysrc_url"></a><span class="summary-sig-name">pysrc_url</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">api_doc</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.pysrc_url">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_pysrc_url-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_pysrc_url-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_pysrc_url" name="call_graph_for_pysrc_url">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="apidoc.APIDoc.__cmp__()" alt="" coords="403,6,627,38" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__hash__" title="apidoc.APIDoc.__hash__()" alt="" coords="403,62,627,94" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="apidoc.DottedName.__getitem__()" alt="" coords="375,118,655,150" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__str__" title="apidoc.DottedName.__str__()" alt="" coords="393,174,636,206" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#dominates" title="apidoc.DottedName.dominates()" alt="" coords="383,230,647,262" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#pysrc_link" title="pysrc_link()" alt="" coords="31,62,145,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#pysrc_url" title="pysrc_url()" alt="" coords="220,118,324,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write" title="write()" alt="" coords="52,118,124,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_sourcecode" title="write_sourcecode()" alt="" coords="5,174,171,206" />
</map>
<img src="call_graph_for_pysrc_url.gif" alt='' usemap="#call_graph_for_pysrc_url" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docwriter.html.HTMLWriter-class.html#href" class="summary-sig-name">href</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">target</span>,
<span class="summary-sig-arg">label</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">css_class</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">context</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">tooltip</span>=<span class="summary-sig-default">None</span>)</span><br />
Return the HTML code for an HREF link to the given target (which can
be a <code>VariableDoc</code>, a <code>ValueDoc</code>, or a
<code>DottedName</code>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.href">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_href-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_href-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_href" name="call_graph_for_href">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__str__" title="apidoc.DottedName.__str__()" alt="" coords="596,118,839,150" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#container" title="apidoc.DottedName.container()" alt="" coords="590,174,846,206" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#contextualize" title="apidoc.DottedName.contextualize()" alt="" coords="574,230,862,262" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_val_is_public" title="_val_is_public()" alt="" coords="646,286,790,318" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#breadcrumbs" title="breadcrumbs()" alt="" coords="143,6,274,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#href" title="href()" alt="" coords="460,258,524,290" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#function_signature" title="function_signature()" alt="" coords="122,62,295,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#url" title="url()" alt="" coords="690,342,746,374" />
<area shape="rect" href="epydoc.util-module.html#plaintext_to_html" title="util.plaintext_to_html()" alt="" coords="619,398,816,430" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#summary_name" title="summary_name()" alt="" coords="132,118,284,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_index_section" title="write_index_section()" alt="" coords="116,174,300,206" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_inheritance_list" title="write_inheritance_list()" alt="" coords="111,230,306,262" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_metadata_index" title="write_metadata_index()" alt="" coords="108,286,308,318" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module_tree_item" title="write_module_tree_item()" alt="" coords="100,342,316,374" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_sourcecode" title="write_sourcecode()" alt="" coords="126,398,291,430" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_var_list" title="write_var_list()" alt="" coords="140,454,276,486" />
<area shape="rect" href="epydoc.docwriter.html._HTMLDocstringLinker-class.html#translate_identifier_xref" title="_HTMLDocstringLinker.translate_identifier_xref()" alt="" coords="6,510,411,542" />
</map>
<img src="call_graph_for_href.gif" alt='' usemap="#call_graph_for_href" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_attr_to_html"></a><span class="summary-sig-name">_attr_to_html</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">attr</span>,
<span class="summary-sig-arg">api_doc</span>,
<span class="summary-sig-arg">indent</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter._attr_to_html">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__attr_to_html-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__attr_to_html-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__attr_to_html" name="call_graph_for__attr_to_html">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="apidoc.APIDoc.__cmp__()" alt="" coords="366,90,590,122" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_attr_to_html" title="_attr_to_html()" alt="" coords="182,118,318,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#docstring_to_html" title="docstring_to_html()" alt="" coords="392,146,563,178" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#descr" title="descr()" alt="" coords="34,6,106,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#return_descr" title="return_descr()" alt="" coords="6,62,134,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#return_type" title="return_type()" alt="" coords="10,118,130,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#summary" title="summary()" alt="" coords="18,174,122,206" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#type_descr" title="type_descr()" alt="" coords="12,230,127,262" />
</map>
<img src="call_graph_for__attr_to_html.gif" alt='' usemap="#call_graph_for__attr_to_html" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="summary"></a><span class="summary-sig-name">summary</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">api_doc</span>,
<span class="summary-sig-arg">indent</span>=<span class="summary-sig-default">0</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.summary">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_summary-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_summary-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_summary" name="call_graph_for_summary">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_attr_to_html" title="_attr_to_html()" alt="" coords="395,34,531,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#summary" title="summary()" alt="" coords="243,34,347,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_details_entry" title="write_details_entry()" alt="" coords="12,6,188,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_line" title="write_summary_line()" alt="" coords="7,62,193,94" />
</map>
<img src="call_graph_for_summary.gif" alt='' usemap="#call_graph_for_summary" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="descr"></a><span class="summary-sig-name">descr</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">api_doc</span>,
<span class="summary-sig-arg">indent</span>=<span class="summary-sig-default">0</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.descr">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_descr-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_descr-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_descr" name="call_graph_for_descr">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_attr_to_html" title="_attr_to_html()" alt="" coords="355,62,491,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#descr" title="descr()" alt="" coords="233,62,305,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_class" title="write_class()" alt="" coords="36,6,153,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_details_entry" title="write_details_entry()" alt="" coords="7,62,183,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module" title="write_module()" alt="" coords="27,118,163,150" />
</map>
<img src="call_graph_for_descr.gif" alt='' usemap="#call_graph_for_descr" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="type_descr"></a><span class="summary-sig-name">type_descr</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">api_doc</span>,
<span class="summary-sig-arg">indent</span>=<span class="summary-sig-default">0</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.type_descr">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_type_descr-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_type_descr-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_type_descr" name="call_graph_for_type_descr">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_attr_to_html" title="_attr_to_html()" alt="" coords="406,6,542,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#type_descr" title="type_descr()" alt="" coords="243,6,358,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_line" title="write_summary_line()" alt="" coords="7,6,194,38" />
</map>
<img src="call_graph_for_type_descr.gif" alt='' usemap="#call_graph_for_type_descr" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="return_type"></a><span class="summary-sig-name">return_type</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">api_doc</span>,
<span class="summary-sig-arg">indent</span>=<span class="summary-sig-default">0</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.return_type">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_return_type-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_return_type-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_return_type" name="call_graph_for_return_type">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_attr_to_html" title="_attr_to_html()" alt="" coords="414,34,550,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#return_type" title="return_type()" alt="" coords="244,34,364,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_details_entry" title="write_details_entry()" alt="" coords="12,6,188,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_line" title="write_summary_line()" alt="" coords="7,62,194,94" />
</map>
<img src="call_graph_for_return_type.gif" alt='' usemap="#call_graph_for_return_type" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="return_descr"></a><span class="summary-sig-name">return_descr</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">api_doc</span>,
<span class="summary-sig-arg">indent</span>=<span class="summary-sig-default">0</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.return_descr">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_return_descr-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_return_descr-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_return_descr" name="call_graph_for_return_descr">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_attr_to_html" title="_attr_to_html()" alt="" coords="408,6,544,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#return_descr" title="return_descr()" alt="" coords="232,6,360,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_details_entry" title="write_details_entry()" alt="" coords="7,6,183,38" />
</map>
<img src="call_graph_for_return_descr.gif" alt='' usemap="#call_graph_for_return_descr" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="docstring_to_html"></a><span class="summary-sig-name">docstring_to_html</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">parsed_docstring</span>,
<span class="summary-sig-arg">where</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">indent</span>=<span class="summary-sig-default">0</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.docstring_to_html">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_docstring_to_ht-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_docstring_to_ht-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_docstring_to_ht" name="call_graph_for_docstring_to_ht">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_attr_to_html" title="_attr_to_html()" alt="" coords="37,34,173,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#docstring_to_html" title="docstring_to_html()" alt="" coords="253,118,424,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#arg_name_to_html" title="arg_name_to_html()" alt="" coords="19,90,192,122" />
<area shape="rect" href="epydoc.docwriter.html._HTMLDocstringLinker-class.html#__init__" title="_HTMLDocstringLinker.__init__()" alt="" coords="541,6,829,38" />
<area shape="rect" href="epydoc.markup.ConcatenatedDocstring-class.html#to_html" title="markup.ConcatenatedDocstring.to_html()" alt="" coords="519,62,852,94" />
<area shape="rect" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#to_html" title="markup.epytext.ParsedEpytextDocstring.to_html()" alt="" coords="487,118,884,150" />
<area shape="rect" href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#to_html" title="markup.plaintext.ParsedPlaintextDocstring.to_html()" alt="" coords="477,174,893,206" />
<area shape="rect" href="epydoc.markup.restructuredtext.ParsedRstDocstring-class.html#to_html" title="markup.restructuredtext.ParsedRstDocstring.to_html()" alt="" coords="472,230,899,262" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_details_entry" title="write_details_entry()" alt="" coords="17,146,193,178" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_metadata_index" title="write_metadata_index()" alt="" coords="5,202,205,234" />
</map>
<img src="call_graph_for_docstring_to_ht.gif" alt='' usemap="#call_graph_for_docstring_to_ht" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="description"></a><span class="summary-sig-name">description</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">parsed_docstring</span>,
<span class="summary-sig-arg">where</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">indent</span>=<span class="summary-sig-default">0</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.description">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_description-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_description-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_description" name="call_graph_for_description">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#description" title="description()" alt="" coords="272,90,389,122" />
<area shape="rect" href="epydoc.docwriter.html._HTMLDocstringLinker-class.html#__init__" title="_HTMLDocstringLinker.__init__()" alt="" coords="507,6,795,38" />
<area shape="rect" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#to_html" title="markup.epytext.ParsedEpytextDocstring.to_html()" alt="" coords="452,62,849,94" />
<area shape="rect" href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#to_html" title="markup.plaintext.ParsedPlaintextDocstring.to_html()" alt="" coords="443,118,859,150" />
<area shape="rect" href="epydoc.markup.restructuredtext.ParsedRstDocstring-class.html#to_html" title="markup.restructuredtext.ParsedRstDocstring.to_html()" alt="" coords="437,174,864,206" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module_tree_item" title="write_module_tree_item()" alt="" coords="7,90,223,122" />
</map>
<img src="call_graph_for_description.gif" alt='' usemap="#call_graph_for_description" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="doc_kind"></a><span class="summary-sig-name">doc_kind</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">doc</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.doc_kind">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_doc_kind-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_doc_kind-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_doc_kind" name="call_graph_for_doc_kind">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="apidoc.DottedName.__getitem__()" alt="" coords="372,34,652,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_crumb" title="_crumb()" alt="" coords="43,6,134,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#doc_kind" title="doc_kind()" alt="" coords="219,34,323,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_sourcecode" title="write_sourcecode()" alt="" coords="6,62,171,94" />
</map>
<img src="call_graph_for_doc_kind.gif" alt='' usemap="#call_graph_for_doc_kind" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_doc_or_ancestor_is_private"></a><span class="summary-sig-name">_doc_or_ancestor_is_private</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">api_doc</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter._doc_or_ancestor_is_private">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__doc_or_ancesto-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__doc_or_ancesto-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__doc_or_ancesto" name="call_graph_for__doc_or_ancesto">
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#get_valdoc" title="apidoc.DocIndex.get_valdoc()" alt="" coords="569,6,817,38" />
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#get_vardoc" title="apidoc.DocIndex.get_vardoc()" alt="" coords="569,62,817,94" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="apidoc.DottedName.__getitem__()" alt="" coords="553,118,833,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_doc_or_ancestor_is_private" title="_doc_or_ancestor_is_private()" alt="" coords="253,62,504,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_metadata_index" title="write_metadata_index()" alt="" coords="5,34,205,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_toc_section" title="write_toc_section()" alt="" coords="23,90,188,122" />
</map>
<img src="call_graph_for__doc_or_ancesto.gif" alt='' usemap="#call_graph_for__doc_or_ancesto" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docwriter.html.HTMLWriter-class.html#_private_subclasses" class="summary-sig-name" onclick="show_private();">_private_subclasses</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">class_doc</span>)</span><br />
Return a list of all subclasses of the given class that are private,
as determined by <code class="link">_val_is_private</code>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter._private_subclasses">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__private_subcla-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__private_subcla-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__private_subcla" name="call_graph_for__private_subcla">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_private_subclasses" title="_private_subclasses()" alt="" coords="261,6,445,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_val_is_public" title="_val_is_public()" alt="" coords="495,6,639,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_class_tree_graph" title="write_class_tree_graph()" alt="" coords="7,6,212,38" />
</map>
<img src="call_graph_for__private_subcla.gif" alt='' usemap="#call_graph_for__private_subcla" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Class Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassVariables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> 2.4. Index pages</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="SPLIT_IDENT_INDEX_SIZE"></a><span class="summary-name">SPLIT_IDENT_INDEX_SIZE</span> = <code title="3000">3000</code><br />
If the identifier index has more than this number of entries, then it
will be split into separate pages, one for each alphabetical section.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="LETTERS"></a><span class="summary-name">LETTERS</span> = <code title="'ABCDEFGHIJKLMNOPQRSTUVWXYZ_'"><code class="variable-quote">'</code><code class="variable-string">ABCDEFGHIJKLMNOPQRSTUVWXYZ_</code><code class="variable-quote">'</code></code><br />
The alphabetical sections that are used for link index pages.
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> 2.9. Javascript (epydoc.js)</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.docwriter.html.HTMLWriter-class.html#TOGGLE_PRIVATE_JS" class="summary-name">TOGGLE_PRIVATE_JS</a> = <code title="'''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") {
..."><code class="variable-quote">'</code><code class="variable-string">function toggle_private() {\n // S</code><code class="variable-ellipsis">...</code></code><br />
A javascript that is used to show or hide the API documentation for
private objects.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.docwriter.html.HTMLWriter-class.html#GET_COOKIE_JS" class="summary-name">GET_COOKIE_JS</a> = <code title="'''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
..."><code class="variable-quote">'</code><code class="variable-string">function getCookie(name) {\n var dc = </code><code class="variable-ellipsis">...</code></code><br />
A javascript that is used to read the value of a cookie.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.docwriter.html.HTMLWriter-class.html#SET_FRAME_JS" class="summary-name">SET_FRAME_JS</a> = <code title="'''function setFrame(url1, url2) {
parent.frames[1].location.href = url1;
parent.frames[2].location.href = url2;
}'''"><code class="variable-quote">'</code><code class="variable-string">function setFrame(url1, url2) {\n par</code><code class="variable-ellipsis">...</code></code><br />
A javascript that is used to set the contents of two frames at once.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.docwriter.html.HTMLWriter-class.html#HIDE_PRIVATE_JS" class="summary-name">HIDE_PRIVATE_JS</a> = <code title="'''function checkCookie() {
var cmd=getCookie("EpydocPrivate");
if (cmd && cmd.substr(0,4)!="show" && location.href.indexOf("#\
_") < 0)
toggle_private();
}'''"><code class="variable-quote">'</code><code class="variable-string">function checkCookie() {\n var cmd=g</code><code class="variable-ellipsis">...</code></code><br />
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.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.docwriter.html.HTMLWriter-class.html#TOGGLE_CALLGRAPH_JS" class="summary-name">TOGGLE_CALLGRAPH_JS</a> = <code title="'''function toggleCallGraph(id) {
var elt = document.getElementById(id);
if (elt.style.display == "none")
elt.style.display = "block";
else
elt.style.display = "none";
}'''"><code class="variable-quote">'</code><code class="variable-string">function toggleCallGraph(id) {\n </code><code class="variable-ellipsis">...</code></code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.docwriter.html.HTMLWriter-class.html#SHOW_PRIVATE_JS" class="summary-name">SHOW_PRIVATE_JS</a> = <code title="'''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();
}
..."><code class="variable-quote">'</code><code class="variable-string">function show_private() {\n var elts</code><code class="variable-ellipsis">...</code></code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.docwriter.html.HTMLWriter-class.html#GET_ANCHOR_JS" class="summary-name">GET_ANCHOR_JS</a> = <code title="'''function get_anchor() {
var href = location.href;
var start = href.indexOf("#")+1;
if ((start != 0) && (start != href.length))
return href.substring(start, href.length);
}'''"><code class="variable-quote">'</code><code class="variable-string">function get_anchor() {\n var href =</code><code class="variable-ellipsis">...</code></code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.docwriter.html.HTMLWriter-class.html#REDIRECT_URL_JS" class="summary-name">REDIRECT_URL_JS</a> = <code title="'''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\
..."><code class="variable-quote">'</code><code class="variable-string">function redirect_url(dottedName) {\n </code><code class="variable-ellipsis">...</code></code><br />
A javascript that is used to implement the auto-redirect page.
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> 2.10. Graphs</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="RE_CALLGRAPH_ID"></a><span class="summary-name">RE_CALLGRAPH_ID</span> = <code title="re.compile(r'["\'](.+-div)[\'"]')">re.compile(r'<code class="re-group">[</code>"\'<code class="re-group">]</code><code class="re-group">(</code>.<code class="re-op">+</code>-div<code class="re-group">)</code><code class="re-group">[</code>\'"<code class="re-group">]</code>')</code>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> 2.11. Images</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.docwriter.html.HTMLWriter-class.html#IMAGES" class="summary-name">IMAGES</a> = <code title="{'crarr.png': '''iVBORw0KGgoAAAANSUhEUgAAABEAAAAKCAMAAABlokWQAAAALHRFW\
HRDcmVhdGlvbiBUaW1lAFR1
ZSAyMiBBdWcgMjAwNiAwMDo0MzoxMCAtMDUwMGAMEFgAAAAHdElNRQfWCBYFASkQ033WAA\
AACXBI
WXMAAB7CAAAewgFu0HU+AAAABGdBTUEAALGPC/xhBQAAAEVQTFRF////zcOw18/AgGY0c1\
cg4dvQ
inJEYEAAYkME3NXI6eTcloFYe2Asr5+AbE4Uh29A9fPwqpl4ZEUI8O3onopk0Ma0lH5U1n\
fFdgAA
..."><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">crarr.png</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">iVBORw0KGgoAAAANSUhEUgAAABEAAAAKCAMAAA</code><code class="variable-ellipsis">...</code></code>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> 3.6. Details Lists</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.docwriter.html.HTMLWriter-class.html#SPECIAL_METHODS" class="summary-name">SPECIAL_METHODS</a> = <code title="{'__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',
..."><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">__add__</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">Addition operator</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">__and__</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-ellipsis">...</code></code>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Index generation</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.docwriter.html.HTMLWriter-class.html#METADATA_INDICES" class="summary-name">METADATA_INDICES</a> = <code title="[('bug', 'Bug List', 'Bugs'),
('todo', 'To Do List', 'To Do'),
('change', 'Change Log', 'Changes'),
('deprecated', 'Deprecation List', 'Deprecations'),
('since', 'Introductions List', 'Introductions')]"><code class="variable-group">[</code><code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">bug</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">Bug List</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">Bugs</code><code class="variable-quote">'</code><code class="variable-group">)</code><code class="variable-op">, </code><code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">todo</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">To </code><code class="variable-ellipsis">...</code></code><br />
A list of metadata indices that should be generated.
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Helper functions</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="TABLE_FOOTER"></a><span class="summary-name">TABLE_FOOTER</span> = <code title="'''</table>
'''"><code class="variable-quote">'</code><code class="variable-string"></table>\n</code><code class="variable-quote">'</code></code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.docwriter.html.HTMLWriter-class.html#PRIVATE_LINK" class="summary-name">PRIVATE_LINK</a> = <code title="'''<span class="options">[<a href="javascript:void(0);" class="private\
link"
onclick="toggle_private();">hide&nbsp;private</a>]</span>'''"><code class="variable-quote">'</code><code class="variable-string"><span class="options">[<a href="javascript:voi</code><code class="variable-ellipsis">...</code></code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.docwriter.html.HTMLWriter-class.html#_url_cache" class="summary-name" onclick="show_private();">_url_cache</a> = <code title="{1078260780: 'epydoc-module.html',
1078260940: 'epydoc-module.html',
1078261708: 'epydoc-module.html#DEBUG',
1078261804: 'epydoc-module.html#__author__',
1078261868: 'epydoc-module.html#__license__',
1078261932: 'epydoc-module.html#__url__',
1078261996: 'epydoc-module.html#__version__',
1078262028: 'epydoc.compat-module.html',
..."><code class="variable-group">{</code>1078260780<code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">epydoc-module.html</code><code class="variable-quote">'</code><code class="variable-op">, </code>1078260940<code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">e</code><code class="variable-ellipsis">...</code></code>
</td>
</tr>
</table>
<!-- ==================== INSTANCE VARIABLES ==================== -->
<a name="section-InstanceVariables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceVariables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_show_private"></a><span class="summary-name">_show_private</span><br />
Should private docs be included?
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_prj_name"></a><span class="summary-name">_prj_name</span><br />
The project's name (for the project link in the navbar)
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_prj_url"></a><span class="summary-name">_prj_url</span><br />
URL for the project link in the navbar
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_prj_link"></a><span class="summary-name">_prj_link</span><br />
HTML code for the project link in the navbar
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_top_page"></a><span class="summary-name">_top_page</span><br />
The 'main' page
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_css"></a><span class="summary-name">_css</span><br />
CSS stylesheet to use
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_helpfile"></a><span class="summary-name">_helpfile</span><br />
Filename of file to extract help contents from
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_frames_index"></a><span class="summary-name">_frames_index</span><br />
Should a frames index be created?
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_show_imports"></a><span class="summary-name">_show_imports</span><br />
Should imports be listed?
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_propfunc_linelen"></a><span class="summary-name">_propfunc_linelen</span><br />
[XXX] Not used!
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_variable_maxlines"></a><span class="summary-name">_variable_maxlines</span><br />
Max lines for variable values
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_variable_linelen"></a><span class="summary-name">_variable_linelen</span><br />
Max line length for variable values
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_variable_summary_linelen"></a><span class="summary-name">_variable_summary_linelen</span><br />
Max length for variable value summaries
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_variable_tooltip_linelen"></a><span class="summary-name">_variable_tooltip_linelen</span><br />
Max length for variable tooltips
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_inheritance"></a><span class="summary-name">_inheritance</span><br />
How should inheritance be displayed? 'listed', 'included', or
'grouped'
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_incl_sourcecode"></a><span class="summary-name">_incl_sourcecode</span><br />
Should pages be generated for source code of modules?
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_mark_docstrings"></a><span class="summary-name">_mark_docstrings</span><br />
Wrap <span class='docstring'>...</span> around
docstrings?
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_graph_types"></a><span class="summary-name">_graph_types</span><br />
Graphs that we should include in our output.
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_include_log"></a><span class="summary-name">_include_log</span><br />
Are we generating an HTML log page?
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_src_code_tab_width"></a><span class="summary-name">_src_code_tab_width</span><br />
Number of spaces to replace each tab with in source code listings.
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_callgraph_cache"></a><span class="summary-name">_callgraph_cache</span><br />
Map the callgraph <a
href="epydoc.docwriter.dotgraph.DotGraph-class.html#uid"
class="link">uid</a> to their HTML representation.
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_redundant_details"></a><span class="summary-name">_redundant_details</span><br />
If true, then include objects in the details list even if all info
about them is already provided by the summary table.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="module_list"></a><span class="summary-name">module_list</span><br />
The list of <a href="epydoc.apidoc.ModuleDoc-class.html"
class="link">ModuleDoc</a>s for the documented modules.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="module_set"></a><span class="summary-name">module_set</span><br />
The set of <a href="epydoc.apidoc.ModuleDoc-class.html"
class="link">ModuleDoc</a>s for the documented modules.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="class_list"></a><span class="summary-name">class_list</span><br />
The list of <a href="epydoc.apidoc.ClassDoc-class.html"
class="link">ClassDoc</a>s for the documented classes.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="class_set"></a><span class="summary-name">class_set</span><br />
The set of <a href="epydoc.apidoc.ClassDoc-class.html"
class="link">ClassDoc</a>s for the documented classes.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="routine_list"></a><span class="summary-name">routine_list</span><br />
The list of <a href="epydoc.apidoc.RoutineDoc-class.html"
class="link">RoutineDoc</a>s for the documented routines.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="indexed_docs"></a><span class="summary-name">indexed_docs</span><br />
The list of <a href="epydoc.apidoc.APIDoc-class.html"
class="link">APIDoc</a>s for variables and values that should be
included in the index.
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">docindex</span>,
<span class="sig-arg">**kwargs</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.__init__">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for___init___21-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for___init___21-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for___init___21" name="call_graph_for___init___21">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="apidoc.APIDoc.__cmp__()" alt="" coords="192,6,416,38" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__hash__" title="apidoc.APIDoc.__hash__()" alt="" coords="192,62,416,94" />
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#reachable_valdocs" title="apidoc.DocIndex.reachable_valdocs()" alt="" coords="152,118,456,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#__init__" title="__init__()" alt="" coords="7,118,103,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_find_top_page" title="_find_top_page()" alt="" coords="228,174,380,206" />
<area shape="rect" href="epydoc.util-module.html#is_src_filename" title="util.is_src_filename()" alt="" coords="213,230,395,262" />
</map>
<img src="call_graph_for___init___21.gif" alt='' usemap="#call_graph_for___init___21" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Construct a new HTML writer, using the given documentation index.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>docindex</code></strong> - The documentation index.</li>
<li><strong class="pname"><code>prj_name</code></strong> (<code>string</code>) - The name of the project. Defaults to none.</li>
<li><strong class="pname"><code>prj_url</code></strong> (<code>string</code>) - The target for the project hopeage link on the navigation bar.
If <code>prj_url</code> is not specified, then no hyperlink is
created.</li>
<li><strong class="pname"><code>prj_link</code></strong> (<code>string</code>) - 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 <code>prj_name</code>.</li>
<li><strong class="pname"><code>top_page</code></strong> (<code>string</code>) - The top page for the documentation. This is the default page
shown main frame, when frames are enabled. <code>top</code> can
be a URL, the name of a module, the name of a class, or one of
the special strings <code>"trees.html"</code>,
<code>"indices.html"</code>, or
<code>"help.html"</code>. By default, the top-level
package or module is used, if there is one; otherwise,
<code>"trees"</code> is used.</li>
<li><strong class="pname"><code>css</code></strong> (<code>string</code>) - The CSS stylesheet file. If <code>css</code> is a file name,
then the specified file's conents will be used. Otherwise, if
<code>css</code> is the name of a CSS stylesheet in <a
href="epydoc.docwriter.html_css-module.html"
class="link">epydoc.docwriter.html_css</a>, then that stylesheet
will be used. Otherwise, an error is reported. If no stylesheet
is specified, then the default stylesheet is used.</li>
<li><strong class="pname"><code>help_file</code></strong> (<code>string</code>) - The name of the help file. If no help file is specified, then
the default help file will be used.</li>
<li><strong class="pname"><code>show_private</code></strong> (<code>boolean</code>) - Whether to create documentation for private objects. By default,
private objects are documented.</li>
<li><strong class="pname"><code>show_frames</code></strong> (<code>boolean</code>)) - Whether to create a frames-based table of contents. By default,
it is produced.</li>
<li><strong class="pname"><code>show_imports</code></strong> (<code>boolean</code>) - Whether or not to display lists of imported functions and
classes. By default, they are not shown.</li>
<li><strong class="pname"><code>variable_maxlines</code></strong> (<code>int</code>) - 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.</li>
<li><strong class="pname"><code>variable_linelength</code></strong> (<code>int</code>) - 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.</li>
<li><strong class="pname"><code>variable_summary_linelength</code></strong> (<code>int</code>) - 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.</li>
<li><strong class="pname"><code>variable_tooltip_linelength</code></strong> (<code>int</code>) - 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.</li>
<li><strong class="pname"><code>property_function_linelength</code></strong> (<code>int</code>) - The maximum line length used to dispaly property functions
(<code>fget</code>, <code>fset</code>, and <code>fdel</code>)
that contain something other than a function object. The default
length is 40 characters.</li>
<li><strong class="pname"><code>inheritance</code></strong> (<code>string</code>) - How inherited objects should be displayed. If
<code>inheritance='grouped'</code>, then inherited objects are
gathered into groups; if <code>inheritance='listed'</code>, then
inherited objects are listed in a short list at the end of their
group; if <code>inheritance='included'</code>, then inherited
objects are mixed in with non-inherited objects. The default is
'grouped'.</li>
<li><strong class="pname"><code>include_source_code</code></strong> (<code>boolean</code>) - If true, then generate colorized source code files for each
python module.</li>
<li><strong class="pname"><code>include_log</code></strong> (<code>boolean</code>) - If true, the the footer will include an href to the page
'epydoc-log.html'.</li>
<li><strong class="pname"><code>src_code_tab_width</code></strong> (<code>int</code>) - Number of spaces to replace each tab with in source code
listings.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_find_top_page"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_find_top_page</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">pagename</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter._find_top_page">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__find_top_page-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for__find_top_page-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__find_top_page" name="call_graph_for__find_top_page">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#dominates" title="apidoc.DottedName.dominates()" alt="" coords="353,6,617,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#__init__" title="__init__()" alt="" coords="7,34,103,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_find_top_page" title="_find_top_page()" alt="" coords="152,34,304,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#url" title="url()" alt="" coords="457,62,513,94" />
</map>
<img src="call_graph_for__find_top_page.gif" alt='' usemap="#call_graph_for__find_top_page" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>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 <code>index.html</code>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>pagename</code></strong> (<code>string</code>) - The name of the page, as specified by the keyword argument
<code>top</code> to the constructor.</li>
</ul></dd>
<dt>Returns: <code>string</code></dt>
<dd>The URL of the top page.</dd>
</dl>
</td></tr></table>
</div>
<a name="write"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">write</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">directory</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_3-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_write_3-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_3" name="call_graph_for_write_3">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="apidoc.DottedName.__getitem__()" alt="" coords="127,6,407,38" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__str__" title="apidoc.DottedName.__str__()" alt="" coords="145,62,388,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_group_by_letter" title="_group_by_letter()" alt="" coords="185,118,348,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_mkdir" title="_mkdir()" alt="" coords="223,174,311,206" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_write" title="_write()" alt="" coords="225,230,308,262" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#build_identifier_index" title="build_identifier_index()" alt="" coords="167,286,367,318" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#build_metadata_index" title="build_metadata_index()" alt="" coords="167,342,367,374" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#build_term_index" title="build_term_index()" alt="" coords="183,398,351,430" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#pysrc_url" title="pysrc_url()" alt="" coords="215,454,319,486" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#url" title="url()" alt="" coords="239,510,295,542" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write" title="write()" alt="" coords="5,426,77,458" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_css" title="write_css()" alt="" coords="215,566,319,598" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_homepage" title="write_homepage()" alt="" coords="188,622,345,654" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_images" title="write_images()" alt="" coords="200,678,333,710" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_javascript" title="write_javascript()" alt="" coords="189,734,344,766" />
<area shape="rect" href="epydoc.log-module.html#docstring_warning" title="log.docstring_warning()" alt="" coords="165,790,368,822" />
<area shape="rect" href="epydoc.log-module.html#progress" title="log.progress()" alt="" coords="204,846,329,878" />
</map>
<img src="call_graph_for_write_3.gif" alt='' usemap="#call_graph_for_write_3" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Write the documentation to the given directory.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>directory</code></strong> (<code>string</code>) - 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.</li>
</ul></dd>
<dt>Returns: <code>None</code></dt>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>OSError</strong></code> - If <code>directory</code> cannot be created.</li>
<li><code><strong class='fraise'>OSError</strong></code> - If any file cannot be created or written to.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="write_module"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">write_module</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">out</span>,
<span class="sig-arg">doc</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_module">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_module-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_write_module-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_module" name="call_graph_for_write_module">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="apidoc.DottedName.__getitem__()" alt="" coords="324,6,604,38" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__str__" title="apidoc.DottedName.__str__()" alt="" coords="343,62,586,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_write" title="_write()" alt="" coords="6,230,88,262" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module" title="write_module()" alt="" coords="138,230,274,262" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#descr" title="descr()" alt="" coords="428,118,500,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#pysrc_link" title="pysrc_link()" alt="" coords="407,174,522,206" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#url" title="url()" alt="" coords="436,230,492,262" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_details_list" title="write_details_list()" alt="" coords="383,286,546,318" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module_list" title="write_module_list()" alt="" coords="380,342,548,374" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_standard_fields" title="write_standard_fields()" alt="" coords="367,398,562,430" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_table" title="write_summary_table()" alt="" coords="367,454,562,486" />
</map>
<img src="call_graph_for_write_module.gif" alt='' usemap="#call_graph_for_write_module" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Write an HTML page containing the API documentation for the given
module to <code>out</code>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>doc</code></strong> - A <a href="epydoc.apidoc.ModuleDoc-class.html"
class="link">ModuleDoc</a> containing the API documentation for
the module that should be described.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="write_class"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">write_class</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">out</span>,
<span class="sig-arg">doc</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_class">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_class-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_write_class-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_class" name="call_graph_for_write_class">
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#is_exception" title="apidoc.ClassDoc.is_exception()" alt="" coords="316,6,575,38" />
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#is_type" title="apidoc.ClassDoc.is_type()" alt="" coords="336,62,555,94" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="apidoc.DottedName.__getitem__()" alt="" coords="305,118,585,150" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__str__" title="apidoc.DottedName.__str__()" alt="" coords="324,174,567,206" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_write" title="_write()" alt="" coords="5,286,88,318" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_class" title="write_class()" alt="" coords="137,286,255,318" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#descr" title="descr()" alt="" coords="409,230,481,262" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#pysrc_link" title="pysrc_link()" alt="" coords="388,286,503,318" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#url" title="url()" alt="" coords="417,342,473,374" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_class_tree_graph" title="write_class_tree_graph()" alt="" coords="343,398,548,430" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_details_list" title="write_details_list()" alt="" coords="364,454,527,486" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_standard_fields" title="write_standard_fields()" alt="" coords="348,510,543,542" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_table" title="write_summary_table()" alt="" coords="348,566,543,598" />
</map>
<img src="call_graph_for_write_class.gif" alt='' usemap="#call_graph_for_write_class" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Write an HTML page containing the API documentation for the given
class to <code>out</code>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>doc</code></strong> - A <a href="epydoc.apidoc.ClassDoc-class.html"
class="link">ClassDoc</a> containing the API documentation for
the class that should be described.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="write_class_tree_graph"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">write_class_tree_graph</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">out</span>,
<span class="sig-arg">doc</span>,
<span class="sig-arg">graphmaker</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_class_tree_graph">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_class_tre-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_write_class_tre-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_class_tre" name="call_graph_for_write_class_tre">
<area shape="rect" href="epydoc.docwriter.dotgraph-module.html#uml_class_tree_graph" title="dotgraph.uml_class_tree_graph()" alt="" coords="440,6,707,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_private_subclasses" title="_private_subclasses()" alt="" coords="482,62,666,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#render_graph" title="render_graph()" alt="" coords="507,118,640,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_class" title="write_class()" alt="" coords="7,90,124,122" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_class_tree_graph" title="write_class_tree_graph()" alt="" coords="175,90,380,122" />
<area shape="rect" href="epydoc.docwriter.html._HTMLDocstringLinker-class.html#__init__" title="_HTMLDocstringLinker.__init__()" alt="" coords="430,174,718,206" />
</map>
<img src="call_graph_for_write_class_tre.gif" alt='' usemap="#call_graph_for_write_class_tre" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Write HTML code for a class tree graph of <code>doc</code> (a
classdoc), using <code>graphmaker</code> to draw the actual graph.
<code>graphmaker</code> should be <a
href="epydoc.docwriter.dotgraph-module.html#class_tree_graph"
class="link">class_tree_graph()</a>, or <a
href="epydoc.docwriter.dotgraph-module.html#uml_class_tree_graph"
class="link">uml_class_tree_graph()</a>, or any other function with a
compatible signature.</p>
<p>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.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="write_class_tree"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">write_class_tree</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">out</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_class_tree">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_class_tre_2-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_write_class_tre_2-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_class_tre_2" name="call_graph_for_write_class_tre_2">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__hash__" title="apidoc.APIDoc.__hash__()" alt="" coords="340,6,564,38" />
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#mro" title="apidoc.ClassDoc.mro()" alt="" coords="355,62,550,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_write" title="_write()" alt="" coords="6,62,88,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_class_tree" title="write_class_tree()" alt="" coords="136,62,291,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_treepage_header" title="write_treepage_header()" alt="" coords="351,118,554,150" />
</map>
<img src="call_graph_for_write_class_tre_2.gif" alt='' usemap="#call_graph_for_write_class_tre_2" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>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.</p>
<dl class="fields">
</dl>
<div class="fields"> <p><strong>To Do:</strong>
For multiple inheritance, don't repeat subclasses the second time a
class is mentioned; instead, link to the first mention.
</p>
</div></td></tr></table>
</div>
<a name="write_help"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">write_help</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">out</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_help">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_help-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_write_help-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_help" name="call_graph_for_write_help">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_write" title="_write()" alt="" coords="5,6,88,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_help" title="write_help()" alt="" coords="137,6,249,38" />
</map>
<img src="call_graph_for_write_help.gif" alt='' usemap="#call_graph_for_write_help" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Write an HTML help file to the given stream. If
<code>self._helpfile</code> contains a help file, then use it; otherwise,
use the default helpfile from <a
href="epydoc.docwriter.html_help-module.html"
class="link">epydoc.docwriter.html_help</a>.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="write_module_toc"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">write_module_toc</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">out</span>,
<span class="sig-arg">doc</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_module_toc">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_module_to-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_write_module_to-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_module_to" name="call_graph_for_write_module_to">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="apidoc.DottedName.__getitem__()" alt="" coords="365,6,645,38" />
<area shape="rect" href="epydoc.apidoc.ModuleDoc-class.html#select_variables" title="apidoc.ModuleDoc.select_variables()" alt="" coords="355,62,656,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_write" title="_write()" alt="" coords="5,62,88,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module_toc" title="write_module_toc()" alt="" coords="137,62,305,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_toc_section" title="write_toc_section()" alt="" coords="423,118,588,150" />
</map>
<img src="call_graph_for_write_module_to.gif" alt='' usemap="#call_graph_for_write_module_to" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>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.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="write_homepage"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">write_homepage</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">directory</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_homepage">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_homepage-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_write_homepage-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_homepage" name="call_graph_for_write_homepage">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write" title="write()" alt="" coords="6,6,78,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_homepage" title="write_homepage()" alt="" coords="127,6,284,38" />
</map>
<img src="call_graph_for_write_homepage.gif" alt='' usemap="#call_graph_for_write_homepage" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Write an <code>index.html</code> 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 <a
href="epydoc.docwriter.html.HTMLWriter-class.html#_frames_index"
class="link" onclick="show_private();">_frames_index</a> and <a
href="epydoc.docwriter.html.HTMLWriter-class.html#_top_page" class="link"
onclick="show_private();">_top_page</a>:</p>
<ul>
<li>
If <a
href="epydoc.docwriter.html.HTMLWriter-class.html#_frames_index"
class="link" onclick="show_private();">_frames_index</a> is true,
then <code>frames.html</code> is copied.
</li>
<li>
Otherwise, the page specified by <a
href="epydoc.docwriter.html.HTMLWriter-class.html#_top_page"
class="link" onclick="show_private();">_top_page</a> is copied.
</li>
</ul>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="write_css"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">write_css</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">directory</span>,
<span class="sig-arg">cssname</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_css">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_css-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_write_css-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_css" name="call_graph_for_write_css">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write" title="write()" alt="" coords="5,6,77,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_css" title="write_css()" alt="" coords="127,6,231,38" />
</map>
<img src="call_graph_for_write_css.gif" alt='' usemap="#call_graph_for_write_css" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Write the CSS stylesheet in the given directory. If
<code>cssname</code> contains a stylesheet file or name (from <a
href="epydoc.docwriter.html_css-module.html"
class="link">epydoc.docwriter.html_css</a>), then use that stylesheet;
otherwise, use the default stylesheet.</p>
<dl class="fields">
<dt>Returns: <code>None</code></dt>
</dl>
</td></tr></table>
</div>
<a name="render_callgraph"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">render_callgraph</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">callgraph</span>,
<span class="sig-arg">token</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.render_callgraph">source code</a></span>
</td>
</tr></table>
<p>Render the HTML chunk of a callgraph.</p>
<p>If <code>callgraph</code> is a string, use the <a
href="epydoc.docwriter.html.HTMLWriter-class.html#_callgraph_cache"
class="link" onclick="show_private();">_callgraph_cache</a> to return a
pre-rendered HTML chunk. This mostly avoids to run <code>dot</code> twice
for the same callgraph. Else, run the graph and store its HTML output in
the cache.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>callgraph</code></strong> (<a href="epydoc.docwriter.dotgraph.DotGraph-class.html"
class="link">DotGraph</a> or <code>str</code>) - The graph to render or its <a
href="epydoc.docwriter.dotgraph.DotGraph-class.html#uid"
class="link">uid</a>.</li>
<li><strong class="pname"><code>token</code></strong> (<code>str</code>) - A string that can be used to make the <code><div></code> id
unambiguous, if the callgraph is used more than once in a page.</li>
</ul></dd>
<dt>Returns: <code>str</code></dt>
<dd>The HTML representation of the graph.</dd>
</dl>
</td></tr></table>
</div>
<a name="callgraph_link"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">callgraph_link</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">callgraph</span>,
<span class="sig-arg">token</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.callgraph_link">source code</a></span>
</td>
</tr></table>
<p>Render the HTML chunk of a callgraph link.</p>
<p>The link can toggles the visibility of the callgraph rendered using <a
href="epydoc.docwriter.html.HTMLWriter-class.html#render_callgraph"
class="link">render_callgraph</a> with matching parameters.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>callgraph</code></strong> (<a href="epydoc.docwriter.dotgraph.DotGraph-class.html"
class="link">DotGraph</a> or <code>str</code>) - The graph to render or its <a
href="epydoc.docwriter.dotgraph.DotGraph-class.html#uid"
class="link">uid</a>.</li>
<li><strong class="pname"><code>token</code></strong> (<code>str</code>) - A string that can be used to make the <code><div></code> id
unambiguous, if the callgraph is used more than once in a page.</li>
</ul></dd>
<dt>Returns: <code>str</code></dt>
<dd>The HTML representation of the graph link.</dd>
</dl>
</td></tr></table>
</div>
<a name="write_header"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">write_header</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">out</span>,
<span class="sig-arg">title</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_header">source code</a></span>
</td>
</tr></table>
<p>Generate HTML code for the standard page header, and write it to
<code>out</code>. <code>title</code> is a string containing the page
title. It should be appropriately escaped/encoded.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="write_navbar"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">write_navbar</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">out</span>,
<span class="sig-arg">context</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_navbar">source code</a></span>
</td>
</tr></table>
<p>Generate HTML code for the navigation bar, and write it to
<code>out</code>. The navigation bar typically looks like:</p>
<pre class="literalblock">
[ Home Trees Index Help Project ]
</pre>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>context</code></strong> - A value indicating what page we're generating a navigation bar
for. If we're generating an API documentation page for an
object, then <code>context</code> is a <a
href="epydoc.apidoc.ValueDoc-class.html"
class="link">ValueDoc</a> containing the documentation for that
object; otherwise, <code>context</code> is a string name for the
page. The following string names are recognized:
<code>'tree'</code>, <code>'index'</code>, and
<code>'help'</code>.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="write_breadcrumbs"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">write_breadcrumbs</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">out</span>,
<span class="sig-arg">context</span>,
<span class="sig-arg">context_url</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_breadcrumbs">source code</a></span>
</td>
</tr></table>
<p>Generate HTML for the breadcrumbs line, and write it to
<code>out</code>. 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.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>context</code></strong> (<a href="epydoc.apidoc.ValueDoc-class.html"
class="link">ValueDoc</a>) - The API documentation for the object whose breadcrumbs we should
generate.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="write_summary_table"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">write_summary_table</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">out</span>,
<span class="sig-arg">heading</span>,
<span class="sig-arg">doc</span>,
<span class="sig-arg">value_type</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_summary_table">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_summary_t-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_write_summary_t-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_summary_t" name="call_graph_for_write_summary_t">
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#select_variables" title="apidoc.ClassDoc.select_variables()" alt="" coords="452,6,735,38" />
<area shape="rect" href="epydoc.apidoc.ModuleDoc-class.html#select_variables" title="apidoc.ModuleDoc.select_variables()" alt="" coords="443,62,744,94" />
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#group_names" title="apidoc.NamespaceDoc.group_names()" alt="" coords="439,118,748,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_class" title="write_class()" alt="" coords="16,90,134,122" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_table" title="write_summary_table()" alt="" coords="194,118,388,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module" title="write_module()" alt="" coords="7,146,143,178" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_group" title="write_summary_group()" alt="" coords="492,174,695,206" />
<area shape="rect" href="epydoc.util-module.html#plaintext_to_html" title="util.plaintext_to_html()" alt="" coords="495,230,692,262" />
</map>
<img src="call_graph_for_write_summary_t.gif" alt='' usemap="#call_graph_for_write_summary_t" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Generate HTML code for a summary table, and write it to
<code>out</code>. A summary table is a table that includes a one-row
description for each variable (of a given type) in a module or class.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>heading</code></strong> - The heading for the summary table; typically, this indicates what
kind of value the table describes (e.g., functions or classes).</li>
<li><strong class="pname"><code>doc</code></strong> - A <a href="epydoc.apidoc.ValueDoc-class.html"
class="link">ValueDoc</a> object containing the API documentation
for the module or class whose variables we should summarize.</li>
<li><strong class="pname"><code>value_type</code></strong> - A string indicating what type of value should be listed in this
summary table. This value is passed on to <code>doc</code>'s
<code>select_variables()</code> method.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="write_summary_line"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">write_summary_line</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">out</span>,
<span class="sig-arg">var_doc</span>,
<span class="sig-arg">container</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_summary_line">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_summary_l-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_write_summary_l-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_summary_l" name="call_graph_for_write_summary_l">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="apidoc.APIDoc.__cmp__()" alt="" coords="582,6,806,38" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#summary_pyval_repr" title="apidoc.ValueDoc.summary_pyval_repr()" alt="" coords="530,62,858,94" />
<area shape="rect" href="epydoc.apidoc.VariableDoc-class.html#is_detailed" title="apidoc.VariableDoc.is_detailed()" alt="" coords="559,118,828,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#function_signature" title="function_signature()" alt="" coords="607,174,780,206" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#pysrc_link" title="pysrc_link()" alt="" coords="636,230,751,262" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#return_type" title="return_type()" alt="" coords="634,286,754,318" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#summary" title="summary()" alt="" coords="642,342,746,374" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#summary_name" title="summary_name()" alt="" coords="618,398,770,430" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#type_descr" title="type_descr()" alt="" coords="636,454,751,486" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#variable_tooltip" title="variable_tooltip()" alt="" coords="618,510,770,542" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_group" title="write_summary_group()" alt="" coords="6,286,208,318" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_line" title="write_summary_line()" alt="" coords="258,286,444,318" />
<area shape="rect" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#to_html" title="markup.epytext.ParsedEpytextDocstring.to_html()" alt="" coords="495,566,892,598" />
</map>
<img src="call_graph_for_write_summary_l.gif" alt='' usemap="#call_graph_for_write_summary_l" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Generate HTML code for a single line of a summary table, and write it
to <code>out</code>. See <a
href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_table"
class="link">write_summary_table</a> for more information.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>var_doc</code></strong> - The API documentation for the variable that should be described
by this line of the summary table.</li>
<li><strong class="pname"><code>container</code></strong> - The API documentation for the class or module whose summary table
we're writing.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="arg_name_to_html"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">arg_name_to_html</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">func_doc</span>,
<span class="sig-arg">arg_name</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.arg_name_to_html">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_arg_name_to_htm-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_arg_name_to_htm-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_arg_name_to_htm" name="call_graph_for_arg_name_to_htm">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#arg_name_to_html" title="arg_name_to_html()" alt="" coords="233,6,407,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#docstring_to_html" title="docstring_to_html()" alt="" coords="456,6,627,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_details_entry" title="write_details_entry()" alt="" coords="7,6,183,38" />
</map>
<img src="call_graph_for_arg_name_to_htm.gif" alt='' usemap="#call_graph_for_arg_name_to_htm" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>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.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="base_tree"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">base_tree</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">doc</span>,
<span class="sig-arg">width</span>=<span class="sig-default">None</span>,
<span class="sig-arg">postfix</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
<span class="sig-arg">context</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.base_tree">source code</a></span>
</td>
</tr></table>
<dl class="fields">
<dt>Returns: <code>string</code></dt>
<dd>The HTML code for a class's base tree. The tree is drawn
'upside-down' and right justified, to allow for multiple
inheritance.</dd>
</dl>
</td></tr></table>
</div>
<a name="find_tree_width"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">find_tree_width</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">doc</span>,
<span class="sig-arg">context</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.find_tree_width">source code</a></span>
</td>
</tr></table>
<p>Helper function for <a
href="epydoc.docwriter.html.HTMLWriter-class.html#base_tree"
class="link">base_tree</a>.</p>
<dl class="fields">
<dt>Returns: <code>int</code></dt>
<dd>The width of a base tree, when drawn right-justified. This is
used by <a
href="epydoc.docwriter.html.HTMLWriter-class.html#base_tree"
class="link">base_tree</a> to determine how far to indent lines
of the base tree.</dd>
</dl>
</td></tr></table>
</div>
<a name="function_signature"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">function_signature</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">api_doc</span>,
<span class="sig-arg">is_summary</span>=<span class="sig-default">False</span>,
<span class="sig-arg">link_name</span>=<span class="sig-default">False</span>,
<span class="sig-arg">anchor</span>=<span class="sig-default">False</span>,
<span class="sig-arg">context</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.function_signature">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_function_signat-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_function_signat-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_function_signat" name="call_graph_for_function_signat">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="apidoc.APIDoc.__cmp__()" alt="" coords="512,6,736,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#func_arg" title="func_arg()" alt="" coords="575,62,673,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#function_signature" title="function_signature()" alt="" coords="291,90,464,122" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#href" title="href()" alt="" coords="592,118,656,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#summary_name" title="summary_name()" alt="" coords="548,174,700,206" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#property_accessor_to_html" title="property_accessor_to_html()" alt="" coords="5,62,243,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_line" title="write_summary_line()" alt="" coords="31,118,217,150" />
</map>
<img src="call_graph_for_function_signat.gif" alt='' usemap="#call_graph_for_function_signat" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Render a function signature in HTML.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>api_doc</code></strong> (<a href="epydoc.apidoc.VariableDoc-class.html"
class="link">VariableDoc</a> or <a
href="epydoc.apidoc.RoutineDoc-class.html"
class="link">RoutineDoc</a>) - The object whose name is to be rendered. If a
<code>VariableDoc</code>, its <code>value</code> should be a
<code>RoutineDoc</code></li>
<li><strong class="pname"><code>is_summary</code></strong> - True if the fuction is to be rendered in the summary. type
css_class: <code>bool</code></li>
<li><strong class="pname"><code>link_name</code></strong> (<code>bool</code>) - If True, the name is a link to the object anchor.</li>
<li><strong class="pname"><code>anchor</code></strong> (<code>bool</code>) - If True, the name is the object anchor.</li>
<li><strong class="pname"><code>context</code></strong> (<a href="epydoc.apidoc.DottedName-class.html"
class="link">DottedName</a>) - If set, represent the function name from this context. Only
useful when <code>api_doc</code> is a <a
href="epydoc.apidoc.RoutineDoc-class.html"
class="link">RoutineDoc</a>.</li>
</ul></dd>
<dt>Returns: <code>str</code></dt>
<dd>The HTML code for the object.</dd>
</dl>
</td></tr></table>
</div>
<a name="summary_name"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">summary_name</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">api_doc</span>,
<span class="sig-arg">css_class</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">summary-name</code><code class="variable-quote">'</code></span>,
<span class="sig-arg">link_name</span>=<span class="sig-default">False</span>,
<span class="sig-arg">anchor</span>=<span class="sig-default">False</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.summary_name">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_summary_name-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_summary_name-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_summary_name" name="call_graph_for_summary_name">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#function_signature" title="function_signature()" alt="" coords="13,6,187,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#summary_name" title="summary_name()" alt="" coords="244,34,396,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#href" title="href()" alt="" coords="447,34,511,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_line" title="write_summary_line()" alt="" coords="7,62,193,94" />
</map>
<img src="call_graph_for_summary_name.gif" alt='' usemap="#call_graph_for_summary_name" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Render an object name in HTML.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>api_doc</code></strong> (<a href="epydoc.apidoc.APIDoc-class.html" class="link">APIDoc</a>) - The object whose name is to be rendered</li>
<li><strong class="pname"><code>css_class</code></strong> - The CSS class to assign to the rendered name type css_class:
<code>str</code></li>
<li><strong class="pname"><code>link_name</code></strong> (<code>bool</code>) - If True, the name is a link to the object anchor.</li>
<li><strong class="pname"><code>anchor</code></strong> (<code>bool</code>) - If True, the name is the object anchor.</li>
</ul></dd>
<dt>Returns: <code>str</code></dt>
<dd>The HTML code for the object.</dd>
</dl>
</td></tr></table>
</div>
<a name="write_standard_fields"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">write_standard_fields</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">out</span>,
<span class="sig-arg">doc</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_standard_fields">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_standard_-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_write_standard_-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_standard_" name="call_graph_for_write_standard_">
<area shape="rect" href="epydoc.docstringparser.DocstringField-class.html#__hash__" title="docstringparser.DocstringField.__hash__()" alt="" coords="435,34,776,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_class" title="write_class()" alt="" coords="16,6,133,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_standard_fields" title="write_standard_fields()" alt="" coords="192,34,387,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module" title="write_module()" alt="" coords="7,62,143,94" />
</map>
<img src="call_graph_for_write_standard_.gif" alt='' usemap="#call_graph_for_write_standard_" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Write HTML code containing descriptions of any standard markup fields
that are defined by the given <a href="epydoc.apidoc.APIDoc-class.html"
class="link">APIDoc</a> object (such as <code>@author</code> and
<code>@todo</code> fields).</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>doc</code></strong> - The <a href="epydoc.apidoc.APIDoc-class.html"
class="link">APIDoc</a> object containing the API documentation
for the object whose standard markup fields should be described.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_term_index_to_anchor"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_term_index_to_anchor</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">term</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter._term_index_to_anchor">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__term_index_to_-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for__term_index_to_-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__term_index_to_" name="call_graph_for__term_index_to_">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_term_index_to_anchor" title="_term_index_to_anchor()" alt="" coords="427,34,640,66" />
<area shape="rect" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#to_plaintext" title="markup.epytext.ParsedEpytextDocstring.to_plaintext()" alt="" coords="688,34,1118,66" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_terms_from_docstring" title="_terms_from_docstring()" alt="" coords="88,6,296,38" />
<area shape="rect" href="epydoc.docwriter.html._HTMLDocstringLinker-class.html#translate_indexterm" title="_HTMLDocstringLinker.translate_indexterm()" alt="" coords="6,62,379,94" />
</map>
<img src="call_graph_for__term_index_to_.gif" alt='' usemap="#call_graph_for__term_index_to_" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>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.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="write_redirect_page"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">write_redirect_page</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">out</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.write_redirect_page">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_write_redirect__2-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_write_redirect__2-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_write_redirect__2" name="call_graph_for_write_redirect__2">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__str__" title="apidoc.DottedName.__str__()" alt="" coords="370,6,612,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_write" title="_write()" alt="" coords="6,6,88,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_redirect_page" title="write_redirect_page()" alt="" coords="138,6,319,38" />
</map>
<img src="call_graph_for_write_redirect__2.gif" alt='' usemap="#call_graph_for_write_redirect__2" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>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>.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="href"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">href</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">target</span>,
<span class="sig-arg">label</span>=<span class="sig-default">None</span>,
<span class="sig-arg">css_class</span>=<span class="sig-default">None</span>,
<span class="sig-arg">context</span>=<span class="sig-default">None</span>,
<span class="sig-arg">tooltip</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter.href">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_href-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_href-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_href" name="call_graph_for_href">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__str__" title="apidoc.DottedName.__str__()" alt="" coords="596,118,839,150" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#container" title="apidoc.DottedName.container()" alt="" coords="590,174,846,206" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#contextualize" title="apidoc.DottedName.contextualize()" alt="" coords="574,230,862,262" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_val_is_public" title="_val_is_public()" alt="" coords="646,286,790,318" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#breadcrumbs" title="breadcrumbs()" alt="" coords="143,6,274,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#href" title="href()" alt="" coords="460,258,524,290" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#function_signature" title="function_signature()" alt="" coords="122,62,295,94" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#url" title="url()" alt="" coords="690,342,746,374" />
<area shape="rect" href="epydoc.util-module.html#plaintext_to_html" title="util.plaintext_to_html()" alt="" coords="619,398,816,430" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#summary_name" title="summary_name()" alt="" coords="132,118,284,150" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_index_section" title="write_index_section()" alt="" coords="116,174,300,206" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_inheritance_list" title="write_inheritance_list()" alt="" coords="111,230,306,262" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_metadata_index" title="write_metadata_index()" alt="" coords="108,286,308,318" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module_tree_item" title="write_module_tree_item()" alt="" coords="100,342,316,374" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_sourcecode" title="write_sourcecode()" alt="" coords="126,398,291,430" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_var_list" title="write_var_list()" alt="" coords="140,454,276,486" />
<area shape="rect" href="epydoc.docwriter.html._HTMLDocstringLinker-class.html#translate_identifier_xref" title="_HTMLDocstringLinker.translate_identifier_xref()" alt="" coords="6,510,411,542" />
</map>
<img src="call_graph_for_href.gif" alt='' usemap="#call_graph_for_href" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Return the HTML code for an HREF link to the given target (which can
be a <code>VariableDoc</code>, a <code>ValueDoc</code>, or a
<code>DottedName</code>. If a <code>NamespaceDoc</code>
<code>context</code> is specified, the target label is contextualized to
it.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="_private_subclasses"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_private_subclasses</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">class_doc</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docwriter.html-pysrc.html#HTMLWriter._private_subclasses">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__private_subcla-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for__private_subcla-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__private_subcla" name="call_graph_for__private_subcla">
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_private_subclasses" title="_private_subclasses()" alt="" coords="261,6,445,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_val_is_public" title="_val_is_public()" alt="" coords="495,6,639,38" />
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_class_tree_graph" title="write_class_tree_graph()" alt="" coords="7,6,212,38" />
</map>
<img src="call_graph_for__private_subcla.gif" alt='' usemap="#call_graph_for__private_subcla" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Return a list of all subclasses of the given class that are private,
as determined by <code class="link">_val_is_private</code>. Recursive
subclasses are included in this list.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== CLASS VARIABLE DETAILS ==================== -->
<a name="section-ClassVariableDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Class Variable Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassVariableDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="TOGGLE_PRIVATE_JS"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">TOGGLE_PRIVATE_JS</h3>
<p>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 <code><div
class="private">...</div></code> elements.</p>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-quote">'''</code><code class="variable-string">function toggle_private() {</code>
<code class="variable-string"> // Search for any private/public links on this page. Store</code>
<code class="variable-string"> // their old text in "cmd," so we will know what action to</code>
<code class="variable-string"> // take; and change their text to the opposite action.</code>
<code class="variable-string"> var cmd = "?";</code>
<code class="variable-string"> var elts = document.getElementsByTagName("a");</code>
<code class="variable-string"> for(var i=0; i<elts.length; i++) {</code>
<code class="variable-string"> if (elts[i].className == "privatelink") {</code>
<code class="variable-ellipsis">...</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="GET_COOKIE_JS"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">GET_COOKIE_JS</h3>
<p>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.</p>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-quote">'''</code><code class="variable-string">function getCookie(name) {</code>
<code class="variable-string"> var dc = document.cookie;</code>
<code class="variable-string"> var prefix = name + "=";</code>
<code class="variable-string"> var begin = dc.indexOf("; " + prefix);</code>
<code class="variable-string"> if (begin == -1) {</code>
<code class="variable-string"> begin = dc.indexOf(prefix);</code>
<code class="variable-string"> if (begin != 0) return null;</code>
<code class="variable-string"> } else</code>
<code class="variable-ellipsis">...</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="SET_FRAME_JS"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">SET_FRAME_JS</h3>
<p>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.</p>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-quote">'''</code><code class="variable-string">function setFrame(url1, url2) {</code>
<code class="variable-string"> parent.frames[1].location.href = url1;</code>
<code class="variable-string"> parent.frames[2].location.href = url2;</code>
<code class="variable-string"> }</code><code class="variable-quote">'''</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="HIDE_PRIVATE_JS"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">HIDE_PRIVATE_JS</h3>
<p>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.</p>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-quote">'''</code><code class="variable-string">function checkCookie() {</code>
<code class="variable-string"> var cmd=getCookie("EpydocPrivate");</code>
<code class="variable-string"> if (cmd && cmd.substr(0,4)!="show" && location.href.indexOf("#</code><span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
<code class="variable-string">_") < 0)</code>
<code class="variable-string"> toggle_private();</code>
<code class="variable-string"> }</code><code class="variable-quote">'''</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="TOGGLE_CALLGRAPH_JS"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">TOGGLE_CALLGRAPH_JS</h3>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-quote">'''</code><code class="variable-string">function toggleCallGraph(id) {</code>
<code class="variable-string"> var elt = document.getElementById(id);</code>
<code class="variable-string"> if (elt.style.display == "none")</code>
<code class="variable-string"> elt.style.display = "block";</code>
<code class="variable-string"> else</code>
<code class="variable-string"> elt.style.display = "none";</code>
<code class="variable-string"> }</code><code class="variable-quote">'''</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="SHOW_PRIVATE_JS"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">SHOW_PRIVATE_JS</h3>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-quote">'''</code><code class="variable-string">function show_private() {</code>
<code class="variable-string"> var elts = document.getElementsByTagName("a");</code>
<code class="variable-string"> for(var i=0; i<elts.length; i++) {</code>
<code class="variable-string"> if (elts[i].className == "privatelink") {</code>
<code class="variable-string"> cmd = elts[i].innerHTML;</code>
<code class="variable-string"> if (cmd && cmd.substr(0,4)=="show")</code>
<code class="variable-string"> toggle_private();</code>
<code class="variable-string"> }</code>
<code class="variable-ellipsis">...</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="GET_ANCHOR_JS"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">GET_ANCHOR_JS</h3>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-quote">'''</code><code class="variable-string">function get_anchor() {</code>
<code class="variable-string"> var href = location.href;</code>
<code class="variable-string"> var start = href.indexOf("#")+1;</code>
<code class="variable-string"> if ((start != 0) && (start != href.length))</code>
<code class="variable-string"> return href.substring(start, href.length);</code>
<code class="variable-string"> }</code><code class="variable-quote">'''</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="REDIRECT_URL_JS"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">REDIRECT_URL_JS</h3>
<p>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>.</p>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-quote">'''</code><code class="variable-string">function redirect_url(dottedName) {</code>
<code class="variable-string"> // Scan through each element of the "pages" list, and check</code>
<code class="variable-string"> // if "name" matches with any of them.</code>
<code class="variable-string"> for (var i=0; i<pages.length; i++) {</code>
<code class="variable-string"></code>
<code class="variable-string"> // Each page has the form "<pagename>-m" or "<pagename>-</code><span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
<code class="variable-string">c";</code>
<code class="variable-string"> // extract the <pagename> portion & compare it to dotted</code><span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
<code class="variable-ellipsis">...</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="IMAGES"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">IMAGES</h3>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">crarr.png</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'''</code><code class="variable-string">iVBORw0KGgoAAAANSUhEUgAAABEAAAAKCAMAAABlokWQAAAALHRFW</code><span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
<code class="variable-string">HRDcmVhdGlvbiBUaW1lAFR1</code>
<code class="variable-string">ZSAyMiBBdWcgMjAwNiAwMDo0MzoxMCAtMDUwMGAMEFgAAAAHdElNRQfWCBYFASkQ033WAA</code><span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
<code class="variable-string">AACXBI</code>
<code class="variable-string">WXMAAB7CAAAewgFu0HU+AAAABGdBTUEAALGPC/xhBQAAAEVQTFRF////zcOw18/AgGY0c1</code><span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
<code class="variable-string">cg4dvQ</code>
<code class="variable-string">inJEYEAAYkME3NXI6eTcloFYe2Asr5+AbE4Uh29A9fPwqpl4ZEUI8O3onopk0Ma0lH5U1n</code><span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
<code class="variable-string">fFdgAA</code>
<code class="variable-ellipsis">...</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="SPECIAL_METHODS"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">SPECIAL_METHODS</h3>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">__add__</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">Addition operator</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">__and__</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">And operator</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">__call__</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">Call operator</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">__cmp__</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">Comparison operator</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">__contains__</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">In operator</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">__del__</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">Destructor</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">__delitem__</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">Index deletion operator</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">__delslice__</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">Slice deletion operator</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-ellipsis">...</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="METADATA_INDICES"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">METADATA_INDICES</h3>
<p>A list of metadata indices that should be generated. Each entry in
this list is a tuple <code>(tag, label, short_label)</code>, where
<code>tag</code> is the cannonical tag of a metadata field;
<code>label</code> is a label for the index page; and
<code>short_label</code> is a shorter label, used in the index
selector.</p>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-group">[</code><code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">bug</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">Bug List</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">Bugs</code><code class="variable-quote">'</code><code class="variable-group">)</code><code class="variable-op">,</code>
<code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">todo</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">To Do List</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">To Do</code><code class="variable-quote">'</code><code class="variable-group">)</code><code class="variable-op">,</code>
<code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">change</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">Change Log</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">Changes</code><code class="variable-quote">'</code><code class="variable-group">)</code><code class="variable-op">,</code>
<code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">deprecated</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">Deprecation List</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">Deprecations</code><code class="variable-quote">'</code><code class="variable-group">)</code><code class="variable-op">,</code>
<code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">since</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">Introductions List</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">Introductions</code><code class="variable-quote">'</code><code class="variable-group">)</code><code class="variable-group">]</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="PRIVATE_LINK"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">PRIVATE_LINK</h3>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-quote">'''</code><code class="variable-string"><span class="options">[<a href="javascript:void(0);" class="private</code><span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
<code class="variable-string">link"</code>
<code class="variable-string"> onclick="toggle_private();">hide&nbsp;private</a>]</span></code><code class="variable-quote">'''</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="_url_cache"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">_url_cache</h3>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-group">{</code>1078260780<code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">epydoc-module.html</code><code class="variable-quote">'</code><code class="variable-op">,</code>
1078260940<code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">epydoc-module.html</code><code class="variable-quote">'</code><code class="variable-op">,</code>
1078261708<code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">epydoc-module.html#DEBUG</code><code class="variable-quote">'</code><code class="variable-op">,</code>
1078261804<code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">epydoc-module.html#__author__</code><code class="variable-quote">'</code><code class="variable-op">,</code>
1078261868<code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">epydoc-module.html#__license__</code><code class="variable-quote">'</code><code class="variable-op">,</code>
1078261932<code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">epydoc-module.html#__url__</code><code class="variable-quote">'</code><code class="variable-op">,</code>
1078261996<code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">epydoc-module.html#__version__</code><code class="variable-quote">'</code><code class="variable-op">,</code>
1078262028<code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">epydoc.compat-module.html</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-ellipsis">...</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="epydoc-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
<a href="epydoc-log.html">Generated by Epydoc
3.0.1 on Wed Jan 30 14:08:10 2008</a>
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
