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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!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"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th bgcolor="#70b0f0" class="navselect"> Home </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 2.0</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
Package epydoc
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[show private | <a href="../public/epydoc-module.html">hide private</a>]</font></td></tr>
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="epydoc-module.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF PACKAGE DESCRIPTION =========== -->
<h2 class="package">Package epydoc</h2>
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"><code>epydoc.cli</code></a>) and a graphical interface (<a
href="epydoc.gui-module.html" class="link"><code>epydoc.gui</code></a>).
Both interfaces let the user specify a set of modules to document, and
produce API documentation using the following steps:
<ol start="1">
<li>
Import the requested modules, using <a
href="epydoc.imports-module.html"
class="link"><code>epydoc.imports</code></a>.
</li>
<li>
Construct documentation for each object, using <a
href="epydoc.objdoc-module.html"
class="link"><code>epydoc.objdoc</code></a>.
<ul>
<li>
<a href="epydoc.uid-module.html"
class="link"><code>epydoc.uid</code></a> is used to create unique
identifiers for each object.
</li>
<li>
The <a href="epydoc.markup-module.html"
class="link"><code>epydoc.markup</code></a> package is used to
parse the objects' documentation strings.
</li>
</ul>
</li>
<li>
Generate output, using <a href="epydoc.html-module.html"
class="link"><code>epydoc.html</code></a> or <a
href="epydoc.latex-module.html"
class="link"><code>epydoc.latex</code></a>.
<ul>
<li>
<a href="epydoc.css-module.html"
class="link"><code>epydoc.css</code></a> is used to generate the
CSS stylehseet for HTML output.
</li>
<li>
<a href="epydoc.help-module.html"
class="link"><code>epydoc.help</code></a> is used to generate the
help page for HTML output.
</li>
<li>
<a href="epydoc.colorize-module.html"
class="link"><code>epydoc.colorize</code></a> is used to colorize
doctest blocks and regular expressions variable values for HTML
output.
</li>
</ul>
</li>
</ol>
<hr/>
<p><b>Version:</b> 2.1
</p>
<p><b>Author:</b> <a href="mailto:edloper@gradient.cis.upenn.edu">Edward
Loper</a>
</p>
<p><b>Copyright:</b> (C) 2003 Edward Loper
</p>
<p><b>License:</b> IBM Open Source License
</p>
<p><b>Requires:</b> Python 2.1+, or Python 2.0 with <a
href="http://lfw.org/python/inspect.html"><code>inspect.py</code></a>.
</p>
<dl><dt><b>See Also:</b></dt>
<dd>
<a href="http://epydoc.sourceforge.net">The epydoc webpage</a>,
<a href="http://epydoc.sourceforge.net/epytext.html">The epytext
markup language manual</a>
</dd>
</dl>
<p><b>To Do:</b> Consider other names for <code>@undocumented</code>:
<code>@bypass</code>, <code>@nodoc</code>,
<code>@exclude</code>, <code>@omit</code>?
</p>
<p><b>To Do for Version 3.0:</b>
<ul>
<li>Support encodings.
</li>
<li>Refactor <a href="epydoc.objdoc.ObjDoc-class.html"
class="link"><code>epydoc.objdoc.ObjDoc</code></a>:
<ul>
<li>
<code>ObjDoc</code>s will contain info about objects, but not
gather it.
</li>
<li>
An <code>inspection</code> module will gather info via
inspection.
</li>
<li>
A new <code>parsing</code> module will provide an alternative,
gathering info by parsing python files.
</li>
<li>
<code>Var</code> will be replaced by <code>VarDoc</code>, a
subclass of <code>ObjDoc</code>.
</li>
<li>
Structure <code>ObjDoc</code>s in a directed acyclic graph, rather
than using a links and a dictionary? Are non-directed cycles a
problem? Interaction of the access hierarchy (a.b.c) and the base
class hierarchy? What does pydoc do?
</li>
</ul>
</li>
<li>Create a better default top_page than trees.html.
</li>
<li>Add the man-page style outputter. (epyman)
</li>
<li>Docstring inheritance for overridden properties.
</li>
<li>Optimize epytext
<ul>
<li>
Use classes instead of minidom nodes?
</li>
</ul>
</li>
<li>Rewrite <code>epydoc.uid.findUID</code> to be more robust.
</li>
</ul></p>
<p><b>Contributors (Alphabetical Order):</b>
<ul>
<li><a href="mailto:glyph@twistedmatrix.com">Glyph Lefkowitz</a>
</li>
<li><a href="mailto:edloper@gradient.cis.upenn.edu">Edward
Loper</a>
</li>
<li><a href="mailto:bruce@cubik.org">Bruce Mitchener</a>
</li>
<li><a href="mailto:spamies@bipbap.de">Simon Pamies</a>
</li>
<li><a href="mailto:kiko@async.com.br">Christian Reis</a>
</li>
<li><a href="mailto:jeff@ohalloran.ca">Jeff O'Halloran</a>
</li>
</ul></p>
<!-- =========== START OF SUBMODULES =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Submodules</th></tr>
<tr><td><ul>
<li> <b><a href="epydoc.foog-module.html"><code>foog</code></a></b>
</ul></td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Interface Modules</th></tr>
<tr><td><ul>
<li> <b><a href="epydoc.cli-module.html"><code>cli</code></a></b>: <i>Command-line interface for epydoc.</i>
<li> <b><a href="epydoc.gui-module.html"><code>gui</code></a></b>: <i>Graphical interface to epydoc.</i>
</ul></td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inspection Modules</th></tr>
<tr><td><ul>
<li> <b><a href="epydoc.uid-module.html"><code>uid</code></a></b>: <i>Unique identifiers and crossreference links for Python objects.</i>
<li> <b><a href="epydoc.objdoc-module.html"><code>objdoc</code></a></b>: <i>Support for <code>ObjDoc</code>s, which encode the information about a
Python object that is necessary to create its documentation.</i>
<li> <b><a href="epydoc.imports-module.html"><code>imports</code></a></b>: <i>Module import support for epydoc.</i>
</ul></td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Docstring Parsing Modules</th></tr>
<tr><td><ul>
<li> <b><a href="epydoc.markup-module.html"><code>markup</code></a></b>: <i>Markup language support for docstrings.</i>
<ul>
<li> <b><a href="epydoc.markup.epytext-module.html"><code>epytext</code></a></b>: <i>Parser for epytext strings.</i>
<li> <b><a href="epydoc.markup.javadoc-module.html"><code>javadoc</code></a></b>: <i>Epydoc parser for <a
href="http://java.sun.com/j2se/javadoc/">Javadoc</a> docstrings.</i>
<li> <b><a href="epydoc.markup.plaintext-module.html"><code>plaintext</code></a></b>: <i>Parser for plaintext docstrings.</i>
<li> <b><a href="epydoc.markup.restructuredtext-module.html"><code>restructuredtext</code></a></b>: <i>Epydoc parser for ReStructuredText strings.</i>
</ul>
</ul></td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Documentation Output Modules</th></tr>
<tr><td><ul>
<li> <b><a href="epydoc.html-module.html"><code>html</code></a></b>: <i>Documentation to HTML converter.</i>
<li> <b><a href="epydoc.css-module.html"><code>css</code></a></b>: <i>Predefined CSS stylesheets for the HTML outputter (<a
href="epydoc.html-module.html"
class="link"><code>epydoc.html</code></a>).</i>
<li> <b><a href="epydoc.help-module.html"><code>help</code></a></b>: <i>Default help file for the HTML outputter (<a
href="epydoc.html-module.html"
class="link"><code>epydoc.html</code></a>).</i>
<li> <b><a href="epydoc.colorize-module.html"><code>colorize</code></a></b>: <i>Functions to produce colorized HTML code for various objects.</i>
<li> <b><a href="epydoc.latex-module.html"><code>latex</code></a></b>: <i>Documentation to LaTeX converter.</i>
<li> <b><a href="epydoc.man-module.html"><code>man</code></a></b>: <i>Documentation formatter that produces man-style documentation.</i>
</ul></td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Testing Modules</th></tr>
<tr><td><ul>
<li> <b><a href="epydoc.checker-module.html"><code>checker</code></a></b>: <i>Documentation completeness checker.</i>
<li> <b><a href="epydoc.test-module.html"><code>test</code></a></b>: <i>Unit tests for the NLTK modules.</i>
<ul>
<li> <b><a href="epydoc.test.epytext-module.html"><code>epytext</code></a></b>: <i>Regression testing for the epytext markup language.</i>
</ul>
</ul></td></tr>
</table><br />
<!-- =========== START OF VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="epydoc-module.html#__author__"><code>__author__</code></a></b> = <span title="'Edward Loper <edloper@gradient.cis.upenn.edu>'"><code><span class="variable-quote">'</span>Edward Loper <edloper@gradient.cis.upenn.e<span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="epydoc-module.html#__license__"><code>__license__</code></a></b>: The license governing the use and distribution of epydoc.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="epydoc-module.html#__url__"><code>__url__</code></a></b> = <span title="'http://epydoc.sourceforge.net'"><code><span class="variable-quote">'</span>http://epydoc.sourceforge.net<span class="variable-quote">'</span> </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="epydoc-module.html#__version__"><code>__version__</code></a></b> = <span title="'2.1'"><code><span class="variable-quote">'</span>2.1<span class="variable-quote">'</span> </code>
</span></td></tr>
</table><br />
<!-- =========== START OF VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="__author__"></a>
<h3>__author__</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>str</code>
</dd>
<span title="'Edward Loper <edloper@gradient.cis.upenn.edu>'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>Edward Loper <edloper@gradient.cis.upenn.edu><span class="variable-quote">'</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="__license__"></a>
<h3>__license__</h3>
The license governing the use and distribution of epydoc.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>str</code>
</dd>
<span title="'IBM Open Source License'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>IBM Open Source License<span class="variable-quote">'</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="__url__"></a>
<h3>__url__</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>str</code>
</dd>
<span title="'http://epydoc.sourceforge.net'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>http://epydoc.sourceforge.net<span class="variable-quote">'</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="__version__"></a>
<h3>__version__</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>str</code>
</dd>
<span title="'2.1'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>2.1<span class="variable-quote">'</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th bgcolor="#70b0f0" class="navselect"> Home </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 2.0</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Mar 20 17:46:19 2004</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>
|
