1
<?xml version="1.0" encoding="ascii"?>
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
"DTD/xhtml1-transitional.dtd">
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7
<link rel="stylesheet" href="epydoc.css" type="text/css" />
8
<script type="text/javascript" src="epydoc.js"></script>
11
<body bgcolor="white" text="black" link="blue" vlink="#204080"
13
<!-- ==================== NAVIGATION BAR ==================== -->
14
<table class="navbar" border="0" width="100%" cellpadding="0"
15
bgcolor="#a0c0ff" cellspacing="0">
18
<th bgcolor="#70b0f0" class="navbar-select"
19
> Home </th>
22
<th> <a
23
href="module-tree.html">Trees</a> </th>
26
<th> <a
27
href="identifier-index.html">Indices</a> </th>
30
<th> <a
31
href="help.html">Help</a> </th>
33
<!-- Project homepage -->
34
<th class="navbar" align="right" width="100%">
35
<table border="0" cellpadding="0" cellspacing="0">
36
<tr><th class="navbar" align="center"
37
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
41
<table width="100%" cellpadding="0" cellspacing="0">
44
<span class="breadcrumbs">
49
<table cellpadding="0" cellspacing="0">
50
<!-- hide/show private -->
51
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
52
onclick="toggle_private();">hide private</a>]</span></td></tr>
53
<tr><td align="right"><span class="options"
54
>[<a href="frames.html" target="_top">frames</a
55
>] | <a href="epydoc-module.html"
56
target="_top">no frames</a>]</span></td></tr>
61
<!-- ==================== PACKAGE DESCRIPTION ==================== -->
62
<h1 class="epydoc">Package epydoc</h1><p class="nomargin-top"><span class="codelink"><a href="epydoc-pysrc.html">source code</a></span></p>
63
<p>Automatic Python reference documentation generator. Epydoc processes
64
Python modules and docstrings to generate formatted API documentation,
65
in the form of HTML pages. Epydoc can be used via a command-line
66
interface (<a href="epydoc.cli-module.html" class="link">epydoc.cli</a>) and a graphical interface (<a href="epydoc.gui-module.html" class="link">epydoc.gui</a>).
67
Both interfaces let the user specify a set of modules or other objects
68
to document, and produce API documentation using the following steps:</p>
69
<ol class="rst-arabic simple">
70
<li>Extract basic information about the specified objects, and objects
71
that are related to them (such as the values defined by a module).
72
This can be done via introspection, parsing, or both:<ul>
73
<li><em>Introspection</em> imports the objects, and examines them directly
74
using Python's introspection mechanisms.</li>
75
<li><em>Parsing</em> reads the Python source files that define the objects,
76
and extracts information from those files.</li>
79
<li>Combine and process that information.<ul>
80
<li><strong>Merging</strong>: Merge the information obtained from introspection &
81
parsing each object into a single structure.</li>
82
<li><strong>Linking</strong>: Replace any "pointers" that were created for
83
imported variables with the documentation that they point to.</li>
84
<li><strong>Naming</strong>: Assign unique <em>canonical names</em> to each of the
85
specified objects, and any related objects.</li>
86
<li><strong>Docstrings</strong>: Parse the docstrings of each of the specified
88
<li><strong>Inheritance</strong>: Add variables to classes for any values that
89
they inherit from their base classes.</li>
92
<li>Generate output. Output can be generated in a variety of formats:<ul>
93
<li>An HTML webpage.</li>
94
<li>A LaTeX document (which can be rendered as a PDF file)</li>
95
<li>A plaintext description.</li>
99
<center><table border="0" cellpadding="0" cellspacing="0" class="graph" width="600">
100
<tr><td align="center">
101
<map id="overview_of_epydoc_s_architect" name="overview_of_epydoc_s_architect">
102
<area shape="rect" href="epydoc.docintrospecter-module.html#introspect_docs" title="Introspect value:\nintrospect_docs()" alt="" coords="108,56,231,96" />
103
<area shape="rect" href="epydoc.docbuilder-module.html#merge_docs" title="Merge introspected & parsed docs:\nmerge_docs()" alt="" coords="119,133,359,173" />
104
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html" title="APIDoc" alt="" coords="208,107,256,122" />
105
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html" title="APIDoc" alt="" coords="182,92,190,100" />
106
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html" title="APIDoc" alt="" coords="215,129,223,137" />
107
<area shape="rect" href="epydoc.docparser-module.html#parse_docs" title="Parse source code:\nparse_docs()" alt="" coords="255,56,391,96" />
108
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html" title="APIDoc" alt="" coords="292,107,340,122" />
109
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html" title="APIDoc" alt="" coords="296,92,304,100" />
110
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html" title="APIDoc" alt="" coords="256,129,264,137" />
111
<area shape="rect" href="epydoc.docbuilder-module.html#link_imports" title="Link imports:\nlink_imports()" alt="" coords="119,211,359,251" />
112
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html" title=" DocIndex" alt="" coords="240,185,302,199" />
113
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html" title=" DocIndex" alt="" coords="235,169,243,177" />
114
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html" title=" DocIndex" alt="" coords="235,207,243,215" />
115
<area shape="rect" href="epydoc.docbuilder-module.html#assign_canonical_names" title="Assign names:\nassign_canonical_names()" alt="" coords="119,317,359,357" />
116
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html" title=" DocIndex" alt="" coords="240,277,302,291" />
117
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html" title=" DocIndex" alt="" coords="235,247,243,255" />
118
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html" title=" DocIndex" alt="" coords="235,313,243,321" />
119
<area shape="rect" href="epydoc.docstringparser-module.html#parse_docstring" title="Parse docstrings:\nparse_docstring()" alt="" coords="119,395,359,435" />
120
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html" title=" DocIndex" alt="" coords="240,369,302,383" />
121
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html" title=" DocIndex" alt="" coords="235,353,243,361" />
122
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html" title=" DocIndex" alt="" coords="235,391,243,399" />
123
<area shape="rect" href="epydoc.docbuilder-module.html#inherit_docs" title="Inherit docs from bases:\ninherit_docs()" alt="" coords="119,472,359,512" />
124
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html" title=" DocIndex" alt="" coords="240,446,302,461" />
125
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html" title=" DocIndex" alt="" coords="235,431,243,439" />
126
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html" title=" DocIndex" alt="" coords="235,468,243,476" />
127
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html" title="DocIndex" alt="" coords="200,537,278,561" />
128
<area shape="rect" href="epydoc.docwriter.html-module.html" title="Write HTML output:\nHTMLWriter" alt="" coords="6,587,144,627" />
129
<area shape="rect" href="epydoc.docwriter.latex-module.html" title="Write LaTeX output:\nLaTeXWriter" alt="" coords="168,587,310,627" />
130
<area shape="rect" href="epydoc.docwriter.plaintext-module.html" title="Write text output:\nPlaintextWriter" alt="" coords="334,587,459,627" />
131
<area shape="rect" href="epydoc.docbuilder-module.html#build_doc_index" title=" epydoc.\l docbuilder.\l build_doc_index()" alt="" coords="429,262,540,306" />
132
<area shape="rect" href="epydoc.docbuilder-module.html#build_doc_index" title=" epydoc.\l docbuilder.\l build_doc_index()" alt="" coords="426,20,434,28" />
133
<area shape="rect" href="epydoc.docbuilder-module.html#build_doc_index" title=" epydoc.\l docbuilder.\l build_doc_index()" alt="" coords="426,540,434,548" />
134
<area shape="rect" href="epydoc.cli-module.html" title=" epydoc.\l cli()" alt="" coords="560,323,614,352" />
135
<area shape="rect" href="epydoc.cli-module.html" title=" epydoc.\l cli()" alt="" coords="556,20,564,28" />
136
<area shape="rect" href="epydoc.cli-module.html" title=" epydoc.\l cli()" alt="" coords="556,597,564,605" />
138
<img src="overview_of_epydoc_s_architect.gif" alt="Overview of epydoc's architecture" usemap="#overview_of_epydoc_s_architect" ismap="ismap" class="graph-with-title" />
140
<tr><td align='left'>
141
<span class="graph-title">Overview of epydoc's architecture</span> -- <span class="graph-caption">The boxes represent steps in epydoc's processing chain.
142
Arrows are annotated with the data classes used to
143
communicate between steps. The lines along the right
144
side mark what portions of the processing chain are
145
initiated by build_doc_index() and cli(). Click on
146
any item to see its documentation.</span>
148
</table><br /></center><div class="rst-section" id="rst-package-organization">
149
<h1 class="heading">Package Organization</h1>
150
<p>The epydoc package contains the following subpackages and modules:</p>
151
<center><table border="0" cellpadding="0" cellspacing="0" class="graph">
152
<tr><td align="center">
153
<map id="package_tree_for_epydoc" name="package_tree_for_epydoc">
154
<area shape="rect" href="epydoc.apidoc-module.html" title="epydoc.apidoc" alt="" coords="25,55,75,76" />
155
<area shape="rect" href="epydoc.checker-module.html" title="epydoc.checker" alt="" coords="83,55,140,76" />
156
<area shape="rect" href="epydoc.cli-module.html" title="epydoc.cli" alt="" coords="148,55,176,76" />
157
<area shape="rect" href="epydoc.compat-module.html" title="epydoc.compat" alt="" coords="184,55,239,76" />
158
<area shape="rect" href="epydoc.docbuilder-module.html" title="epydoc.docbuilder" alt="" coords="247,55,316,76" />
159
<area shape="rect" href="epydoc.docintrospecter-module.html" title="epydoc.docintrospecter" alt="" coords="324,55,424,76" />
160
<area shape="rect" href="epydoc.docparser-module.html" title="epydoc.docparser" alt="" coords="432,55,500,76" />
161
<area shape="rect" href="epydoc.docstringparser-module.html" title="epydoc.docstringparser" alt="" coords="25,97,500,119" />
162
<area shape="rect" href="epydoc.docwriter.dotgraph-module.html" title="epydoc.docwriter.dotgraph" alt="" coords="35,173,97,195" />
163
<area shape="rect" href="epydoc.docwriter.html-module.html" title="epydoc.docwriter.html" alt="" coords="105,173,140,195" />
164
<area shape="rect" href="epydoc.docwriter.html_colorize-module.html" title="epydoc.docwriter.html_colorize" alt="" coords="148,173,235,195" />
165
<area shape="rect" href="epydoc.docwriter.html_css-module.html" title="epydoc.docwriter.html_css" alt="" coords="243,173,304,195" />
166
<area shape="rect" href="epydoc.docwriter.html_help-module.html" title="epydoc.docwriter.html_help" alt="" coords="312,173,379,195" />
167
<area shape="rect" href="epydoc.docwriter.latex-module.html" title="epydoc.docwriter.latex" alt="" coords="387,173,424,195" />
168
<area shape="rect" href="epydoc.docwriter.plaintext-module.html" title="epydoc.docwriter.plaintext" alt="" coords="432,173,491,195" />
169
<area shape="rect" href="epydoc.docwriter.xlink-module.html" title="epydoc.docwriter.xlink" alt="" coords="35,216,491,237" />
170
<area shape="rect" href="epydoc.docwriter-module.html" title="epydoc.docwriter" alt="" coords="25,140,500,247" />
171
<area shape="rect" href="epydoc.gui-module.html" title="epydoc.gui" alt="" coords="25,268,259,289" />
172
<area shape="rect" href="epydoc.log-module.html" title="epydoc.log" alt="" coords="267,268,500,289" />
173
<area shape="rect" href="epydoc.markup.doctest-module.html" title="epydoc.markup.doctest" alt="" coords="35,344,92,365" />
174
<area shape="rect" href="epydoc.markup.epytext-module.html" title="epydoc.markup.epytext" alt="" coords="100,344,156,365" />
175
<area shape="rect" href="epydoc.markup.javadoc-module.html" title="epydoc.markup.javadoc" alt="" coords="164,344,224,365" />
176
<area shape="rect" href="epydoc.markup.plaintext-module.html" title="epydoc.markup.plaintext" alt="" coords="232,344,295,365" />
177
<area shape="rect" href="epydoc.markup.pyval_repr-module.html" title="epydoc.markup.pyval_repr" alt="" coords="303,344,377,365" />
178
<area shape="rect" href="epydoc.markup.restructuredtext-module.html" title="epydoc.markup.restructuredtext" alt="" coords="385,344,491,365" />
179
<area shape="rect" href="epydoc.markup-module.html" title="epydoc.markup" alt="" coords="25,311,500,375" />
180
<area shape="rect" href="epydoc.test.util-module.html" title="epydoc.test.util" alt="" coords="35,429,275,451" />
181
<area shape="rect" href="epydoc.test-module.html" title="epydoc.test" alt="" coords="25,396,284,460" />
182
<area shape="rect" href="epydoc.util-module.html" title="epydoc.util" alt="" coords="292,417,500,460" />
183
<area shape="rect" href="epydoc-module.html" title="epydoc" alt="" coords="16,21,509,469" />
184
<area shape="rect" href="epydoc-module.html" title="epydoc" alt="" coords="5,5,520,475" />
186
<img src="package_tree_for_epydoc.gif" alt='Package Tree for epydoc' usemap="#package_tree_for_epydoc" ismap="ismap" class="graph-with-title" />
188
<tr><td align='center'>
189
<span class="graph-title">Package Tree for epydoc</span>
191
</table><br /></center><p>The user interfaces are provided by the <a href="epydoc.gui-module.html" class="link">gui</a> and <a href="epydoc.cli-module.html" class="link">cli</a> modules.
192
The <a href="epydoc.apidoc-module.html" class="link">apidoc</a> module defines the basic data types used to record
193
information about Python objects. The programmatic interface to
194
epydoc is provided by <a href="epydoc.docbuilder-module.html" class="link">docbuilder</a>. Docstring markup parsing is
195
handled by the <a href="epydoc.markup-module.html" class="link">markup</a> package, and output generation is handled by
196
the <a href="epydoc.docwriter-module.html" class="link">docwriter</a> package. See the submodule list for more
197
information about the submodules and subpackages.</p>
201
<div class="fields"> <p><strong>Author:</strong>
202
<a class="rst-reference external" href="mailto:edloper@gradient.cis.upenn.edu" target="_top">Edward Loper</a>
204
<p><strong>Requires:</strong>
207
<p><strong>Version:</strong>
210
<dl><dt>See Also:</dt>
212
<a class="rst-reference external" href="http://epydoc.sourceforge.net" target="_top">The epydoc webpage</a>,
213
<a class="rst-reference external" href="http://epydoc.sourceforge.net/epytext.html" target="_top">The epytext markup language
217
<strong>To Do:</strong>
218
<ul class="nomargin-top">
220
Create a better default top_page than trees.html.
223
Fix trees.html to work when documenting non-top-level
227
Implement @include
236
When introspecting, limit how much introspection you do (eg,
237
don't construct docs for imported modules' vars if it's
241
<p><strong>Bug:</strong>
242
UserDict.* is interpreted as imported .. why??
244
<p><strong>License:</strong>
245
IBM Open Source License
247
<p><strong>Copyright:</strong>
248
© 2006 Edward Loper
250
<strong>Contributors (Alphabetical Order):</strong>
251
<ul class="nomargin-top">
253
<a class="rst-reference external" href="mailto:glyph@twistedmatrix.com" target="_top">Glyph Lefkowitz</a>
256
<a class="rst-reference external" href="mailto:edloper@gradient.cis.upenn.edu" target="_top">Edward Loper</a>
259
<a class="rst-reference external" href="mailto:bruce@cubik.org" target="_top">Bruce Mitchener</a>
262
<a class="rst-reference external" href="mailto:jeff@ohalloran.ca" target="_top">Jeff O'Halloran</a>
265
<a class="rst-reference external" href="mailto:spamies@bipbap.de" target="_top">Simon Pamies</a>
268
<a class="rst-reference external" href="mailto:kiko@async.com.br" target="_top">Christian Reis</a>
271
<a class="rst-reference external" href="mailto:daniele.varrazzo@gmail.com" target="_top">Daniele Varrazzo</a>
274
</div><!-- ==================== SUBMODULES ==================== -->
275
<a name="section-Submodules"></a>
276
<table class="summary" border="1" cellpadding="3"
277
cellspacing="0" width="100%" bgcolor="white">
278
<tr bgcolor="#70b0f0" class="table-header">
279
<td colspan="2" class="table-header">
280
<table border="0" cellpadding="0" cellspacing="0" width="100%">
282
<td align="left"><span class="table-header">Submodules</span></td>
283
<td align="right" valign="top"
284
><span class="options">[<a href="#section-Submodules"
285
class="privatelink" onclick="toggle_private();"
286
>hide private</a>]</span></td>
291
<tr bgcolor="#e8f0f8" >
292
<th colspan="2" class="group-header"
293
> User Interface</th></tr>
294
<tr><td class="summary">
295
<ul class="nomargin">
296
<li> <strong class="uidlink"><a href="epydoc.cli-module.html">epydoc.cli</a></strong>: <em class="summary">Command-line interface for epydoc.</em> </li>
297
<li> <strong class="uidlink"><a href="epydoc.gui-module.html">epydoc.gui</a></strong>: <em class="summary">Graphical interface to epydoc.</em> </li>
299
<tr bgcolor="#e8f0f8" >
300
<th colspan="2" class="group-header"
301
> Basic Data Types</th></tr>
302
<tr><td class="summary">
303
<ul class="nomargin">
304
<li> <strong class="uidlink"><a href="epydoc.apidoc-module.html">epydoc.apidoc</a></strong>: <em class="summary">Classes for encoding API documentation about Python programs.</em> </li>
306
<tr bgcolor="#e8f0f8" >
307
<th colspan="2" class="group-header"
308
> Documentation Generation</th></tr>
309
<tr><td class="summary">
310
<ul class="nomargin">
311
<li> <strong class="uidlink"><a href="epydoc.docbuilder-module.html">epydoc.docbuilder</a></strong>: <em class="summary">Construct data structures that encode the API documentation for
312
Python objects.</em> </li>
313
<li> <strong class="uidlink"><a href="epydoc.docintrospecter-module.html">epydoc.docintrospecter</a></strong>: <em class="summary">Extract API documentation about python objects by directly
314
introspecting their values.</em> </li>
315
<li> <strong class="uidlink"><a href="epydoc.docparser-module.html">epydoc.docparser</a></strong>: <em class="summary">Extract API documentation about python objects by parsing their
316
source code.</em> </li>
318
<tr bgcolor="#e8f0f8" >
319
<th colspan="2" class="group-header"
320
> Docstring Processing</th></tr>
321
<tr><td class="summary">
322
<ul class="nomargin">
323
<li> <strong class="uidlink"><a href="epydoc.docstringparser-module.html">epydoc.docstringparser</a></strong>: <em class="summary">Parse docstrings and handle any fields it defines, such as
324
<code>@type</code> and <code>@author</code>.</em> </li>
325
<li> <strong class="uidlink"><a href="epydoc.markup-module.html">epydoc.markup</a></strong>: <em class="summary">Markup language support for docstrings.</em>
327
<li> <strong class="uidlink"><a href="epydoc.markup.doctest-module.html">epydoc.markup.doctest</a></strong>: <em class="summary">Syntax highlighting for doctest blocks.</em> </li>
328
<li> <strong class="uidlink"><a href="epydoc.markup.epytext-module.html">epydoc.markup.epytext</a></strong>: <em class="summary">Parser for epytext strings.</em> </li>
329
<li> <strong class="uidlink"><a href="epydoc.markup.javadoc-module.html">epydoc.markup.javadoc</a></strong>: <em class="summary">Epydoc parser for <a href="http://java.sun.com/j2se/javadoc/"
330
target="_top">Javadoc</a> docstrings.</em> </li>
331
<li> <strong class="uidlink"><a href="epydoc.markup.plaintext-module.html">epydoc.markup.plaintext</a></strong>: <em class="summary">Parser for plaintext docstrings.</em> </li>
332
<li> <strong class="uidlink"><a href="epydoc.markup.pyval_repr-module.html">epydoc.markup.pyval_repr</a></strong>: <em class="summary">Syntax highlighter for Python values.</em> </li>
333
<li> <strong class="uidlink"><a href="epydoc.markup.restructuredtext-module.html">epydoc.markup.restructuredtext</a></strong>: <em class="summary">Epydoc parser for ReStructuredText strings.</em> </li>
337
<tr bgcolor="#e8f0f8" >
338
<th colspan="2" class="group-header"
339
> Output Generation</th></tr>
340
<tr><td class="summary">
341
<ul class="nomargin">
342
<li> <strong class="uidlink"><a href="epydoc.docwriter-module.html">epydoc.docwriter</a></strong>: <em class="summary">Output generation.</em>
344
<li> <strong class="uidlink"><a href="epydoc.docwriter.dotgraph-module.html">epydoc.docwriter.dotgraph</a></strong>: <em class="summary">Render Graphviz directed graphs as images.</em> </li>
345
<li> <strong class="uidlink"><a href="epydoc.docwriter.html-module.html">epydoc.docwriter.html</a></strong>: <em class="summary">The HTML output generator for epydoc.</em> </li>
346
<li> <strong class="uidlink"><a href="epydoc.docwriter.html_colorize-module.html">epydoc.docwriter.html_colorize</a></strong>: <em class="summary">Functions to produce colorized HTML code for various objects.</em> </li>
347
<li> <strong class="uidlink"><a href="epydoc.docwriter.html_css-module.html">epydoc.docwriter.html_css</a></strong>: <em class="summary">Predefined CSS stylesheets for the HTML outputter (<a
348
href="epydoc.docwriter.html-module.html"
349
class="link">epydoc.docwriter.html</a>).</em> </li>
350
<li> <strong class="uidlink"><a href="epydoc.docwriter.html_help-module.html">epydoc.docwriter.html_help</a></strong>: <em class="summary">Default help file for the HTML outputter (<a
351
href="epydoc.docwriter.html-module.html"
352
class="link">epydoc.docwriter.html</a>).</em> </li>
353
<li> <strong class="uidlink"><a href="epydoc.docwriter.latex-module.html">epydoc.docwriter.latex</a></strong>: <em class="summary">The LaTeX output generator for epydoc.</em> </li>
354
<li> <strong class="uidlink"><a href="epydoc.docwriter.plaintext-module.html">epydoc.docwriter.plaintext</a></strong>: <em class="summary">Plaintext output generation.</em> </li>
355
<li> <strong class="uidlink"><a href="epydoc.docwriter.xlink-module.html">epydoc.docwriter.xlink</a></strong>: <em class="summary">A <a class="rst-rst-reference external rst-reference external" href="http://docutils.sourceforge.net/" target="_top">Docutils</a> interpreted text role for cross-API reference support.</em> </li>
359
<tr bgcolor="#e8f0f8" >
360
<th colspan="2" class="group-header"
361
> Completeness Checking</th></tr>
362
<tr><td class="summary">
363
<ul class="nomargin">
364
<li> <strong class="uidlink"><a href="epydoc.checker-module.html">epydoc.checker</a></strong>: <em class="summary">Documentation completeness checker.</em> </li>
366
<tr bgcolor="#e8f0f8" >
367
<th colspan="2" class="group-header"
368
> Miscellaneous</th></tr>
369
<tr><td class="summary">
370
<ul class="nomargin">
371
<li> <strong class="uidlink"><a href="epydoc.compat-module.html">epydoc.compat</a></strong>: <em class="summary">Backwards compatibility with previous versions of Python.</em> </li>
372
<li> <strong class="uidlink"><a href="epydoc.log-module.html">epydoc.log</a></strong>: <em class="summary">Functions used to report messages and progress updates to the user.</em> </li>
373
<li> <strong class="uidlink"><a href="epydoc.test-module.html">epydoc.test</a></strong>: <em class="summary">Regression testing.</em>
375
<li> <strong class="uidlink"><a href="epydoc.test.util-module.html">epydoc.test.util</a></strong>: <em class="summary">Utility functions used by the regression tests
376
(<code>*.doctest</code>).</em> </li>
379
<li> <strong class="uidlink"><a href="epydoc.util-module.html">epydoc.util</a></strong>: <em class="summary">Miscellaneous utility functions that are used by multiple modules.</em> </li>
384
<!-- ==================== VARIABLES ==================== -->
385
<a name="section-Variables"></a>
386
<table class="summary" border="1" cellpadding="3"
387
cellspacing="0" width="100%" bgcolor="white">
388
<tr bgcolor="#70b0f0" class="table-header">
389
<td colspan="2" class="table-header">
390
<table border="0" cellpadding="0" cellspacing="0" width="100%">
392
<td align="left"><span class="table-header">Variables</span></td>
393
<td align="right" valign="top"
394
><span class="options">[<a href="#section-Variables"
395
class="privatelink" onclick="toggle_private();"
396
>hide private</a>]</span></td>
402
<td width="15%" align="right" valign="top" class="summary">
403
<span class="summary-type"> </span>
404
</td><td class="summary">
405
<a name="DEBUG"></a><span class="summary-name">DEBUG</span> = <code title="True">True</code><br />
406
True if debugging is turned on.
410
<td width="15%" align="right" valign="top" class="summary">
411
<span class="summary-type"> </span>
412
</td><td class="summary">
413
<a name="__author__"></a><span class="summary-name">__author__</span> = <code title="'Edward Loper <edloper@gradient.cis.upenn.edu>'"><code class="variable-quote">'</code><code class="variable-string">Edward Loper <edloper@gradient.cis.upenn.edu></code><code class="variable-quote">'</code></code><br />
414
The primary author of eypdoc
418
<td width="15%" align="right" valign="top" class="summary">
419
<span class="summary-type"> </span>
420
</td><td class="summary">
421
<a name="__license__"></a><span class="summary-name">__license__</span> = <code title="'IBM Open Source License'"><code class="variable-quote">'</code><code class="variable-string">IBM Open Source License</code><code class="variable-quote">'</code></code><br />
422
The license governing the use and distribution of epydoc
426
<td width="15%" align="right" valign="top" class="summary">
427
<span class="summary-type"> </span>
428
</td><td class="summary">
429
<a name="__url__"></a><span class="summary-name">__url__</span> = <code title="'http://epydoc.sourceforge.net'"><code class="variable-quote">'</code><code class="variable-string">http://epydoc.sourceforge.net</code><code class="variable-quote">'</code></code><br />
430
The URL for epydoc's homepage
434
<td width="15%" align="right" valign="top" class="summary">
435
<span class="summary-type"> </span>
436
</td><td class="summary">
437
<a name="__version__"></a><span class="summary-name">__version__</span> = <code title="'3.0.1'"><code class="variable-quote">'</code><code class="variable-string">3.0.1</code><code class="variable-quote">'</code></code><br />
438
The version of epydoc
442
<!-- ==================== NAVIGATION BAR ==================== -->
443
<table class="navbar" border="0" width="100%" cellpadding="0"
444
bgcolor="#a0c0ff" cellspacing="0">
447
<th bgcolor="#70b0f0" class="navbar-select"
448
> Home </th>
451
<th> <a
452
href="module-tree.html">Trees</a> </th>
455
<th> <a
456
href="identifier-index.html">Indices</a> </th>
459
<th> <a
460
href="help.html">Help</a> </th>
462
<!-- Project homepage -->
463
<th class="navbar" align="right" width="100%">
464
<table border="0" cellpadding="0" cellspacing="0">
465
<tr><th class="navbar" align="center"
466
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
470
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
472
<td align="left" class="footer">
473
<a href="epydoc-log.html">Generated by Epydoc
474
3.0.1 on Wed Jan 30 14:05:46 2008</a>
476
<td align="right" class="footer">
477
<a target="mainFrame" href="http://epydoc.sourceforge.net"
478
>http://epydoc.sourceforge.net</a>
483
<script type="text/javascript">
485
// Private objects are initially displayed (because if
486
// javascript is turned off then we want them to be
487
// visible); but by default, we want to hide them. So hide
488
// them unless we have a cookie that says to show them.
added
removed
doc/api/epydoc-module.html
