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
|
<?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>Module and Class Hierarchies</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 class="navbar"> <a class="navbar" href="epydoc-module.html">Home</a> </th>
<th bgcolor="#70b0f0" class="navselect"> Trees </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%">
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[show private | <a href="../public/trees.html">hide private</a>]</font></td></tr>
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="trees.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF MODULE HIERARCHY =========== -->
<h2>Module Hierarchy</h2>
<ul>
<li> <b><a href="epydoc-module.html"><code>epydoc</code></a></b>: <i>Automatic Python reference documentation generator.</i>
<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>
<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>
<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>
<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>
<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>
<li> <b><a href="epydoc.foog-module.html"><code>foog</code></a></b>
</ul>
</ul>
<!-- =========== START OF CLASS HIERARCHY =========== -->
<h2>Class Hierarchy</h2>
<ul>
<li> <b><a href="UserDict.UserDict-class.html"><code>UserDict.UserDict</code></a></b>
<ul>
<li> <b><a href="epydoc.objdoc.DocMap-class.html"><code>epydoc.objdoc.DocMap</code></a></b>: <i>
A dictionary mapping each object to the object's documentation.</i>
</ul>
<li> <b><a href="docutils.SettingsSpec-class.html"><code>docutils.SettingsSpec</code></a></b>: <i>
Runtime setting specification base class.</i>
<ul>
<li> <b><a href="docutils.Component-class.html"><code>docutils.Component</code></a></b>: <i>
Base class for Docutils components.</i>
<ul>
<li> <b><a href="docutils.readers.Reader-class.html"><code>docutils.readers.Reader</code></a></b>: <i>
Abstract base class for docutils Readers.</i>
<ul>
<li> <b><a href="docutils.readers.standalone.Reader-class.html"><code>docutils.readers.standalone.Reader</code></a></b>
<ul>
<li> <b><a href="../private/epydoc.markup.restructuredtext._EpydocReader-class.html"><code>epydoc.markup.restructuredtext._EpydocReader</code></a></b>: <i>
A reader that captures all errors that are generated by parsing, and
appends them to a list.</i>
</ul>
</ul>
<li> <b><a href="docutils.writers.Writer-class.html"><code>docutils.writers.Writer</code></a></b>: <i>
Abstract base class for docutils Writers.</i>
<ul>
<li> <b><a href="../private/epydoc.markup.restructuredtext._DocumentPseudoWriter-class.html"><code>epydoc.markup.restructuredtext._DocumentPseudoWriter</code></a></b>: <i>
A pseudo-writer for the docutils framework, that can be used to access
the document itself.</i>
</ul>
</ul>
</ul>
<li> <b><a href="docutils.TransformSpec-class.html"><code>docutils.TransformSpec</code></a></b>: <i>
Runtime transform specification base class.</i>
<ul>
<li> <b><a href="docutils.Component-class.html"><code>docutils.Component</code></a></b>: <i>
Base class for Docutils components.</i>
<ul>
<li> <b><a href="docutils.readers.Reader-class.html"><code>docutils.readers.Reader</code></a></b>: <i>
Abstract base class for docutils Readers.</i>
<ul>
<li> <b><a href="docutils.readers.standalone.Reader-class.html"><code>docutils.readers.standalone.Reader</code></a></b>
<ul>
<li> <b><a href="../private/epydoc.markup.restructuredtext._EpydocReader-class.html"><code>epydoc.markup.restructuredtext._EpydocReader</code></a></b>: <i>
A reader that captures all errors that are generated by parsing, and
appends them to a list.</i>
</ul>
</ul>
<li> <b><a href="docutils.writers.Writer-class.html"><code>docutils.writers.Writer</code></a></b>: <i>
Abstract base class for docutils Writers.</i>
<ul>
<li> <b><a href="../private/epydoc.markup.restructuredtext._DocumentPseudoWriter-class.html"><code>epydoc.markup.restructuredtext._DocumentPseudoWriter</code></a></b>: <i>
A pseudo-writer for the docutils framework, that can be used to access
the document itself.</i>
</ul>
</ul>
</ul>
<li> <b><a href="docutils.nodes.NodeVisitor-class.html"><code>docutils.nodes.NodeVisitor</code></a></b>: <i>
"Visitor" pattern <a class="citation-reference" href="#rst-gof95" id="id1" name="id1">[GoF95]</a> abstract superclass implementation for document
tree traversals.</i>
<ul>
<li> <b><a href="docutils.writers.html4css1.HTMLTranslator-class.html"><code>docutils.writers.html4css1.HTMLTranslator</code></a></b>: <i>
This HTML writer has been optimized to produce visually compact
lists (less vertical whitespace).</i>
<ul>
<li> <b><a href="../private/epydoc.markup.restructuredtext._EpydocHTMLTranslator-class.html"><code>epydoc.markup.restructuredtext._EpydocHTMLTranslator</code></a></b>
</ul>
<li> <b><a href="../private/epydoc.markup.restructuredtext._SplitFieldsTranslator-class.html"><code>epydoc.markup.restructuredtext._SplitFieldsTranslator</code></a></b>: <i>
A docutils translator that removes all fields from a document, and
collects them into the instance variable <code>fields</code></i>
<li> <b><a href="../private/epydoc.markup.restructuredtext._SummaryExtractor-class.html"><code>epydoc.markup.restructuredtext._SummaryExtractor</code></a></b>: <i>
A docutils node visitor that extracts the first sentence from the
first paragraph in a document.</i>
</ul>
<li> <b><a href="epydoc.checker.DocChecker-class.html"><code>epydoc.checker.DocChecker</code></a></b>: <i>
Documentation completeness checker.</i>
<li> <b><a href="../private/epydoc.cli._Progress-class.html"><code>epydoc.cli._Progress</code></a></b>: <i>
The progress meter that is used by <code>cli</code> to report its
progress.</i>
<li> <b><a href="epydoc.foog.Foo-class.html"><code>epydoc.foog.Foo</code></a></b>
<li> <b><a href="epydoc.gui.EpydocGUI-class.html"><code>epydoc.gui.EpydocGUI</code></a></b>: <i>
A graphical user interace to epydoc.</i>
<li> <b><a href="../private/epydoc.gui._PipeIO-class.html"><code>epydoc.gui._PipeIO</code></a></b>: <i>
A file-like class that captures strings and prints them.</i>
<li> <b><a href="epydoc.html.HTMLFormatter-class.html"><code>epydoc.html.HTMLFormatter</code></a></b>: <i>
Documentation to HTML converter.</i>
<li> <b><a href="../private/epydoc.html._DevNull-class.html"><code>epydoc.html._DevNull</code></a></b>: <i>
A file-like-object that ignores all input.</i>
<li> <b><a href="../private/epydoc.imports._DevNull-class.html"><code>epydoc.imports._DevNull</code></a></b>: <i>
A "file-like" object that discards anything that is written
and always reports end-of-file when read.</i>
<li> <b><a href="epydoc.latex.LatexFormatter-class.html"><code>epydoc.latex.LatexFormatter</code></a></b>: <i>
Documentation to LaTeX converter.</i>
<li> <b><a href="epydoc.man.ManFormatter-class.html"><code>epydoc.man.ManFormatter</code></a></b>
<li> <b><a href="epydoc.markup.DocstringLinker-class.html"><code>epydoc.markup.DocstringLinker</code></a></b>: <i>
A translator for crossreference links into and out of a
<code>ParsedDocstring</code>.</i>
<ul>
<li> <b><a href="../private/epydoc.html._HTMLDocstringLinker-class.html"><code>epydoc.html._HTMLDocstringLinker</code></a></b>
<li> <b><a href="../private/epydoc.latex._LatexDocstringLinker-class.html"><code>epydoc.latex._LatexDocstringLinker</code></a></b>
</ul>
<li> <b><a href="epydoc.markup.Field-class.html"><code>epydoc.markup.Field</code></a></b>: <i>
The contents of a docstring's field.</i>
<li> <b><a href="epydoc.markup.ParsedDocstring-class.html"><code>epydoc.markup.ParsedDocstring</code></a></b>: <i>
A standard intermediate representation for parsed docstrings that can
be used to generate output.</i>
<ul>
<li> <b><a href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html"><code>epydoc.markup.epytext.ParsedEpytextDocstring</code></a></b>
<li> <b><a href="epydoc.markup.javadoc.ParsedJavadocDocstring-class.html"><code>epydoc.markup.javadoc.ParsedJavadocDocstring</code></a></b>: <i>
An encoded version of a Javadoc docstring.</i>
<li> <b><a href="epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html"><code>epydoc.markup.plaintext.ParsedPlaintextDocstring</code></a></b>
<li> <b><a href="epydoc.markup.restructuredtext.ParsedRstDocstring-class.html"><code>epydoc.markup.restructuredtext.ParsedRstDocstring</code></a></b>: <i>
An encoded version of a ReStructuredText docstring.</i>
</ul>
<li> <b><a href="epydoc.markup.epytext.Token-class.html"><code>epydoc.markup.epytext.Token</code></a></b>: <i>
<code>Token</code>s are an intermediate data structure used while
constructing the structuring DOM tree for a formatted docstring.</i>
<li> <b><a href="epydoc.objdoc.DocField-class.html"><code>epydoc.objdoc.DocField</code></a></b>: <i>
A generic docstring field.</i>
<li> <b><a href="epydoc.objdoc.ObjDoc-class.html"><code>epydoc.objdoc.ObjDoc</code></a></b>: <i>
A base class for encoding the information about a Python object that
is necessary to create its documentation.</i>
<ul>
<li> <b><a href="epydoc.objdoc.ClassDoc-class.html"><code>epydoc.objdoc.ClassDoc</code></a></b>: <i>
The documentation for a class.</i>
<li> <b><a href="epydoc.objdoc.FuncDoc-class.html"><code>epydoc.objdoc.FuncDoc</code></a></b>: <i>
The documentation for a function.</i>
<li> <b><a href="epydoc.objdoc.ModuleDoc-class.html"><code>epydoc.objdoc.ModuleDoc</code></a></b>: <i>
The documentation for a module or package.</i>
<li> <b><a href="epydoc.objdoc.PropertyDoc-class.html"><code>epydoc.objdoc.PropertyDoc</code></a></b>: <i>
The documentation for a property.</i>
</ul>
<li> <b><a href="epydoc.objdoc.Param-class.html"><code>epydoc.objdoc.Param</code></a></b>: <i>
The documentation for a function parameter.</i>
<li> <b><a href="epydoc.objdoc.Raise-class.html"><code>epydoc.objdoc.Raise</code></a></b>: <i>
The documentation for the raising of an exception.</i>
<li> <b><a href="epydoc.objdoc.Var-class.html"><code>epydoc.objdoc.Var</code></a></b>: <i>
The documentation for a variable.</i>
<li> <b><a href="epydoc.uid.Link-class.html"><code>epydoc.uid.Link</code></a></b>: <i>
A cross-reference link between documentation.</i>
<li> <b><a href="epydoc.uid.UID-class.html"><code>epydoc.uid.UID</code></a></b>: <i>
A globally unique identifier.</i>
<ul>
<li> <b><a href="epydoc.uid.ObjectUID-class.html"><code>epydoc.uid.ObjectUID</code></a></b>: <i>
A globally unique identifier used to refer to a Python object.</i>
<li> <b><a href="epydoc.uid.RelativeUID-class.html"><code>epydoc.uid.RelativeUID</code></a></b>: <i>
A globally unique identifier used to refer to a variable, relative to
a Python object.</i>
<ul>
<li> <b><a href="epydoc.uid.ClassMethodUID-class.html"><code>epydoc.uid.ClassMethodUID</code></a></b>
<li> <b><a href="epydoc.uid.PropertyUID-class.html"><code>epydoc.uid.PropertyUID</code></a></b>
<li> <b><a href="epydoc.uid.StaticMethodUID-class.html"><code>epydoc.uid.StaticMethodUID</code></a></b>
<li> <b><a href="epydoc.uid.VariableUID-class.html"><code>epydoc.uid.VariableUID</code></a></b>
</ul>
</ul>
<li> <b><a href="exceptions.Exception-class.html"><code>exceptions.Exception</code></a></b>: <i>
Common base class for all exceptions.</i>
<ul>
<li> <b><a href="epydoc.markup.ParseError-class.html"><code>epydoc.markup.ParseError</code></a></b>: <i>
The base class for errors generated while parsing docstrings.</i>
<ul>
<li> <b><a href="epydoc.markup.epytext.ColorizingError-class.html"><code>epydoc.markup.epytext.ColorizingError</code></a></b>: <i>
An error generated while colorizing a paragraph.</i>
<li> <b><a href="epydoc.markup.epytext.StructuringError-class.html"><code>epydoc.markup.epytext.StructuringError</code></a></b>: <i>
An error generated while structuring a formatted documentation
string.</i>
<li> <b><a href="epydoc.markup.epytext.TokenizationError-class.html"><code>epydoc.markup.epytext.TokenizationError</code></a></b>: <i>
An error generated while tokenizing a formatted documentation
string.</i>
</ul>
<li> <b><a href="exceptions.StandardError-class.html"><code>exceptions.StandardError</code></a></b>: <i>
Base class for all standard Python exceptions.</i>
<ul>
<li> <b><a href="exceptions.AssertionError-class.html"><code>exceptions.AssertionError</code></a></b>: <i>
Assertion failed.</i>
</ul>
</ul>
<li> <b><a href="unittest.TestCase-class.html"><code>unittest.TestCase</code></a></b>: <i>
A class whose instances are single test cases.</i>
<ul>
<li> <b><a href="epydoc.test.epytext.ParseTestCase-class.html"><code>epydoc.test.epytext.ParseTestCase</code></a></b>
</ul>
</ul>
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="epydoc-module.html">Home</a> </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:23 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>
|
