1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
|
<?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</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 bgcolor="#70b0f0" class="navbar-select"
> Home </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">
Package epydoc
</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-module.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== PACKAGE DESCRIPTION ==================== -->
<h1 class="epydoc">Package epydoc</h1><p class="nomargin-top"><span class="codelink"><a href="epydoc-pysrc.html">source code</a></span></p>
<p>Automatic Python reference documentation generator. Epydoc processes
Python modules and docstrings to generate formatted API documentation,
in the form of HTML pages. Epydoc can be used via a command-line
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>).
Both interfaces let the user specify a set of modules or other objects
to document, and produce API documentation using the following steps:</p>
<ol class="rst-arabic simple">
<li>Extract basic information about the specified objects, and objects
that are related to them (such as the values defined by a module).
This can be done via introspection, parsing, or both:<ul>
<li><em>Introspection</em> imports the objects, and examines them directly
using Python's introspection mechanisms.</li>
<li><em>Parsing</em> reads the Python source files that define the objects,
and extracts information from those files.</li>
</ul>
</li>
<li>Combine and process that information.<ul>
<li><strong>Merging</strong>: Merge the information obtained from introspection &
parsing each object into a single structure.</li>
<li><strong>Linking</strong>: Replace any "pointers" that were created for
imported variables with the documentation that they point to.</li>
<li><strong>Naming</strong>: Assign unique <em>canonical names</em> to each of the
specified objects, and any related objects.</li>
<li><strong>Docstrings</strong>: Parse the docstrings of each of the specified
objects.</li>
<li><strong>Inheritance</strong>: Add variables to classes for any values that
they inherit from their base classes.</li>
</ul>
</li>
<li>Generate output. Output can be generated in a variety of formats:<ul>
<li>An HTML webpage.</li>
<li>A LaTeX document (which can be rendered as a PDF file)</li>
<li>A plaintext description.</li>
</ul>
</li>
</ol>
<center><table border="0" cellpadding="0" cellspacing="0" class="graph" width="600">
<tr><td align="center">
<map id="overview_of_epydoc_s_architect" name="overview_of_epydoc_s_architect">
<area shape="rect" href="epydoc.docintrospecter-module.html#introspect_docs" title="Introspect value:\nintrospect_docs()" alt="" coords="108,56,231,96" />
<area shape="rect" href="epydoc.docbuilder-module.html#merge_docs" title="Merge introspected & parsed docs:\nmerge_docs()" alt="" coords="119,133,359,173" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html" title="APIDoc" alt="" coords="208,107,256,122" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html" title="APIDoc" alt="" coords="182,92,190,100" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html" title="APIDoc" alt="" coords="215,129,223,137" />
<area shape="rect" href="epydoc.docparser-module.html#parse_docs" title="Parse source code:\nparse_docs()" alt="" coords="255,56,391,96" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html" title="APIDoc" alt="" coords="292,107,340,122" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html" title="APIDoc" alt="" coords="296,92,304,100" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html" title="APIDoc" alt="" coords="256,129,264,137" />
<area shape="rect" href="epydoc.docbuilder-module.html#link_imports" title="Link imports:\nlink_imports()" alt="" coords="119,211,359,251" />
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html" title=" DocIndex" alt="" coords="240,185,302,199" />
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html" title=" DocIndex" alt="" coords="235,169,243,177" />
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html" title=" DocIndex" alt="" coords="235,207,243,215" />
<area shape="rect" href="epydoc.docbuilder-module.html#assign_canonical_names" title="Assign names:\nassign_canonical_names()" alt="" coords="119,317,359,357" />
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html" title=" DocIndex" alt="" coords="240,277,302,291" />
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html" title=" DocIndex" alt="" coords="235,247,243,255" />
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html" title=" DocIndex" alt="" coords="235,313,243,321" />
<area shape="rect" href="epydoc.docstringparser-module.html#parse_docstring" title="Parse docstrings:\nparse_docstring()" alt="" coords="119,395,359,435" />
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html" title=" DocIndex" alt="" coords="240,369,302,383" />
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html" title=" DocIndex" alt="" coords="235,353,243,361" />
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html" title=" DocIndex" alt="" coords="235,391,243,399" />
<area shape="rect" href="epydoc.docbuilder-module.html#inherit_docs" title="Inherit docs from bases:\ninherit_docs()" alt="" coords="119,472,359,512" />
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html" title=" DocIndex" alt="" coords="240,446,302,461" />
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html" title=" DocIndex" alt="" coords="235,431,243,439" />
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html" title=" DocIndex" alt="" coords="235,468,243,476" />
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html" title="DocIndex" alt="" coords="200,537,278,561" />
<area shape="rect" href="epydoc.docwriter.html-module.html" title="Write HTML output:\nHTMLWriter" alt="" coords="6,587,144,627" />
<area shape="rect" href="epydoc.docwriter.latex-module.html" title="Write LaTeX output:\nLaTeXWriter" alt="" coords="168,587,310,627" />
<area shape="rect" href="epydoc.docwriter.plaintext-module.html" title="Write text output:\nPlaintextWriter" alt="" coords="334,587,459,627" />
<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" />
<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" />
<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" />
<area shape="rect" href="epydoc.cli-module.html" title=" epydoc.\l cli()" alt="" coords="560,323,614,352" />
<area shape="rect" href="epydoc.cli-module.html" title=" epydoc.\l cli()" alt="" coords="556,20,564,28" />
<area shape="rect" href="epydoc.cli-module.html" title=" epydoc.\l cli()" alt="" coords="556,597,564,605" />
</map>
<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" />
</td></tr>
<tr><td align='left'>
<span class="graph-title">Overview of epydoc's architecture</span> -- <span class="graph-caption">The boxes represent steps in epydoc's processing chain.
Arrows are annotated with the data classes used to
communicate between steps. The lines along the right
side mark what portions of the processing chain are
initiated by build_doc_index() and cli(). Click on
any item to see its documentation.</span>
</td></tr>
</table><br /></center><div class="rst-section" id="rst-package-organization">
<h1 class="heading">Package Organization</h1>
<p>The epydoc package contains the following subpackages and modules:</p>
<center><table border="0" cellpadding="0" cellspacing="0" class="graph">
<tr><td align="center">
<map id="package_tree_for_epydoc" name="package_tree_for_epydoc">
<area shape="rect" href="epydoc.apidoc-module.html" title="epydoc.apidoc" alt="" coords="25,55,75,76" />
<area shape="rect" href="epydoc.checker-module.html" title="epydoc.checker" alt="" coords="83,55,140,76" />
<area shape="rect" href="epydoc.cli-module.html" title="epydoc.cli" alt="" coords="148,55,176,76" />
<area shape="rect" href="epydoc.compat-module.html" title="epydoc.compat" alt="" coords="184,55,239,76" />
<area shape="rect" href="epydoc.docbuilder-module.html" title="epydoc.docbuilder" alt="" coords="247,55,316,76" />
<area shape="rect" href="epydoc.docintrospecter-module.html" title="epydoc.docintrospecter" alt="" coords="324,55,424,76" />
<area shape="rect" href="epydoc.docparser-module.html" title="epydoc.docparser" alt="" coords="432,55,500,76" />
<area shape="rect" href="epydoc.docstringparser-module.html" title="epydoc.docstringparser" alt="" coords="25,97,500,119" />
<area shape="rect" href="epydoc.docwriter.dotgraph-module.html" title="epydoc.docwriter.dotgraph" alt="" coords="35,173,97,195" />
<area shape="rect" href="epydoc.docwriter.html-module.html" title="epydoc.docwriter.html" alt="" coords="105,173,140,195" />
<area shape="rect" href="epydoc.docwriter.html_colorize-module.html" title="epydoc.docwriter.html_colorize" alt="" coords="148,173,235,195" />
<area shape="rect" href="epydoc.docwriter.html_css-module.html" title="epydoc.docwriter.html_css" alt="" coords="243,173,304,195" />
<area shape="rect" href="epydoc.docwriter.html_help-module.html" title="epydoc.docwriter.html_help" alt="" coords="312,173,379,195" />
<area shape="rect" href="epydoc.docwriter.latex-module.html" title="epydoc.docwriter.latex" alt="" coords="387,173,424,195" />
<area shape="rect" href="epydoc.docwriter.plaintext-module.html" title="epydoc.docwriter.plaintext" alt="" coords="432,173,491,195" />
<area shape="rect" href="epydoc.docwriter.xlink-module.html" title="epydoc.docwriter.xlink" alt="" coords="35,216,491,237" />
<area shape="rect" href="epydoc.docwriter-module.html" title="epydoc.docwriter" alt="" coords="25,140,500,247" />
<area shape="rect" href="epydoc.gui-module.html" title="epydoc.gui" alt="" coords="25,268,259,289" />
<area shape="rect" href="epydoc.log-module.html" title="epydoc.log" alt="" coords="267,268,500,289" />
<area shape="rect" href="epydoc.markup.doctest-module.html" title="epydoc.markup.doctest" alt="" coords="35,344,92,365" />
<area shape="rect" href="epydoc.markup.epytext-module.html" title="epydoc.markup.epytext" alt="" coords="100,344,156,365" />
<area shape="rect" href="epydoc.markup.javadoc-module.html" title="epydoc.markup.javadoc" alt="" coords="164,344,224,365" />
<area shape="rect" href="epydoc.markup.plaintext-module.html" title="epydoc.markup.plaintext" alt="" coords="232,344,295,365" />
<area shape="rect" href="epydoc.markup.pyval_repr-module.html" title="epydoc.markup.pyval_repr" alt="" coords="303,344,377,365" />
<area shape="rect" href="epydoc.markup.restructuredtext-module.html" title="epydoc.markup.restructuredtext" alt="" coords="385,344,491,365" />
<area shape="rect" href="epydoc.markup-module.html" title="epydoc.markup" alt="" coords="25,311,500,375" />
<area shape="rect" href="epydoc.test.util-module.html" title="epydoc.test.util" alt="" coords="35,429,275,451" />
<area shape="rect" href="epydoc.test-module.html" title="epydoc.test" alt="" coords="25,396,284,460" />
<area shape="rect" href="epydoc.util-module.html" title="epydoc.util" alt="" coords="292,417,500,460" />
<area shape="rect" href="epydoc-module.html" title="epydoc" alt="" coords="16,21,509,469" />
<area shape="rect" href="epydoc-module.html" title="epydoc" alt="" coords="5,5,520,475" />
</map>
<img src="package_tree_for_epydoc.gif" alt='Package Tree for epydoc' usemap="#package_tree_for_epydoc" ismap="ismap" class="graph-with-title" />
</td></tr>
<tr><td align='center'>
<span class="graph-title">Package Tree for epydoc</span>
</td></tr>
</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.
The <a href="epydoc.apidoc-module.html" class="link">apidoc</a> module defines the basic data types used to record
information about Python objects. The programmatic interface to
epydoc is provided by <a href="epydoc.docbuilder-module.html" class="link">docbuilder</a>. Docstring markup parsing is
handled by the <a href="epydoc.markup-module.html" class="link">markup</a> package, and output generation is handled by
the <a href="epydoc.docwriter-module.html" class="link">docwriter</a> package. See the submodule list for more
information about the submodules and subpackages.</p>
</div>
<hr />
<div class="fields"> <p><strong>Author:</strong>
<a class="rst-reference external" href="mailto:edloper@gradient.cis.upenn.edu" target="_top">Edward Loper</a>
</p>
<p><strong>Requires:</strong>
Python 2.3+
</p>
<p><strong>Version:</strong>
3.0.1
</p>
<dl><dt>See Also:</dt>
<dd>
<a class="rst-reference external" href="http://epydoc.sourceforge.net" target="_top">The epydoc webpage</a>,
<a class="rst-reference external" href="http://epydoc.sourceforge.net/epytext.html" target="_top">The epytext markup language
manual</a>
</dd>
</dl>
<strong>To Do:</strong>
<ul class="nomargin-top">
<li>
Create a better default top_page than trees.html.
</li>
<li>
Fix trees.html to work when documenting non-top-level
modules/packages
</li>
<li>
Implement @include
</li>
<li>
Optimize epytext
</li>
<li>
More doctests
</li>
<li>
When introspecting, limit how much introspection you do (eg,
don't construct docs for imported modules' vars if it's
not necessary)
</li>
</ul>
<p><strong>Bug:</strong>
UserDict.* is interpreted as imported .. why??
</p>
<p><strong>License:</strong>
IBM Open Source License
</p>
<p><strong>Copyright:</strong>
© 2006 Edward Loper
</p>
<strong>Contributors (Alphabetical Order):</strong>
<ul class="nomargin-top">
<li>
<a class="rst-reference external" href="mailto:glyph@twistedmatrix.com" target="_top">Glyph Lefkowitz</a>
</li>
<li>
<a class="rst-reference external" href="mailto:edloper@gradient.cis.upenn.edu" target="_top">Edward Loper</a>
</li>
<li>
<a class="rst-reference external" href="mailto:bruce@cubik.org" target="_top">Bruce Mitchener</a>
</li>
<li>
<a class="rst-reference external" href="mailto:jeff@ohalloran.ca" target="_top">Jeff O'Halloran</a>
</li>
<li>
<a class="rst-reference external" href="mailto:spamies@bipbap.de" target="_top">Simon Pamies</a>
</li>
<li>
<a class="rst-reference external" href="mailto:kiko@async.com.br" target="_top">Christian Reis</a>
</li>
<li>
<a class="rst-reference external" href="mailto:daniele.varrazzo@gmail.com" target="_top">Daniele Varrazzo</a>
</li>
</ul>
</div><!-- ==================== SUBMODULES ==================== -->
<a name="section-Submodules"></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">Submodules</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Submodules"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> User Interface</th></tr>
<tr><td class="summary">
<ul class="nomargin">
<li> <strong class="uidlink"><a href="epydoc.cli-module.html">epydoc.cli</a></strong>: <em class="summary">Command-line interface for epydoc.</em> </li>
<li> <strong class="uidlink"><a href="epydoc.gui-module.html">epydoc.gui</a></strong>: <em class="summary">Graphical interface to epydoc.</em> </li>
</ul></td></tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Basic Data Types</th></tr>
<tr><td class="summary">
<ul class="nomargin">
<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>
</ul></td></tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Documentation Generation</th></tr>
<tr><td class="summary">
<ul class="nomargin">
<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
Python objects.</em> </li>
<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
introspecting their values.</em> </li>
<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
source code.</em> </li>
</ul></td></tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Docstring Processing</th></tr>
<tr><td class="summary">
<ul class="nomargin">
<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
<code>@type</code> and <code>@author</code>.</em> </li>
<li> <strong class="uidlink"><a href="epydoc.markup-module.html">epydoc.markup</a></strong>: <em class="summary">Markup language support for docstrings.</em>
<ul>
<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>
<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>
<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/"
target="_top">Javadoc</a> docstrings.</em> </li>
<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>
<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>
<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>
</ul>
</li>
</ul></td></tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Output Generation</th></tr>
<tr><td class="summary">
<ul class="nomargin">
<li> <strong class="uidlink"><a href="epydoc.docwriter-module.html">epydoc.docwriter</a></strong>: <em class="summary">Output generation.</em>
<ul>
<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>
<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>
<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>
<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
href="epydoc.docwriter.html-module.html"
class="link">epydoc.docwriter.html</a>).</em> </li>
<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
href="epydoc.docwriter.html-module.html"
class="link">epydoc.docwriter.html</a>).</em> </li>
<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>
<li> <strong class="uidlink"><a href="epydoc.docwriter.plaintext-module.html">epydoc.docwriter.plaintext</a></strong>: <em class="summary">Plaintext output generation.</em> </li>
<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>
</ul>
</li>
</ul></td></tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Completeness Checking</th></tr>
<tr><td class="summary">
<ul class="nomargin">
<li> <strong class="uidlink"><a href="epydoc.checker-module.html">epydoc.checker</a></strong>: <em class="summary">Documentation completeness checker.</em> </li>
</ul></td></tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Miscellaneous</th></tr>
<tr><td class="summary">
<ul class="nomargin">
<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>
<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>
<li> <strong class="uidlink"><a href="epydoc.test-module.html">epydoc.test</a></strong>: <em class="summary">Regression testing.</em>
<ul>
<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
(<code>*.doctest</code>).</em> </li>
</ul>
</li>
<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>
</ul></td></tr>
</table>
<br />
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></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">Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Variables"
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">
<a name="DEBUG"></a><span class="summary-name">DEBUG</span> = <code title="True">True</code><br />
True if debugging is turned on.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<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 />
The primary author of eypdoc
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<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 />
The license governing the use and distribution of epydoc
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<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 />
The URL for epydoc's homepage
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<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 />
The version of epydoc
</td>
</tr>
</table>
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th bgcolor="#70b0f0" class="navbar-select"
> Home </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:05:46 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>
|
