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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html40/loose.dtd">
<html>
<head>
<title>HappyDoc Source Documentation: happydoclib</title>
</head>
<body bgcolor="#ffffff">
<p><i><a href="index.html">Table of Contents</a></i></p>
<table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr bgcolor="#88bbee">
<th rowspan="2"
valign="top"
align="left"
width="10%"><font color="#000000">HappyDoc Source Documentation: happydoclib</font>
</th>
<th width="90%" align="right"><font color="#000000"> </font></th>
</tr>
<tr>
<td>
<h3>Documentation Sets</h3>
<p> The documentation set, or <em>docset</em>, defines the structure of the
collected documentation being generated. All aspects of the
structure are left up to the docset. Whether to use multiple or a
single file, a file or a database, and what specific metadata to
include in the output is left up to the docset. The docset drives
the documentation generation using controls available from the
formatter.</p>
<table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="Modules and Packages">Modules and Packages</a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000"> </font>
</th>
</tr>
<tr>
<td>
<h4>HappyDoc-r2_0/happydoclib/</h4>
<table border="0" cellpadding="3" cellspacing="0">
<tr><td valign="top" align="left"><a href="CommandLineApp.py.html">CommandLineApp</a></td><td valign="top" align="left">
<p>Base class for building command line applications.</p>
</td></tr>
<tr><td valign="top" align="left"><a href="StreamFlushTest.py.html">StreamFlushTest</a></td><td valign="top" align="left">
<p>Wrapper to control stdout and stderr for a TestCase.</p>
</td></tr>
<tr><td valign="top" align="left"><a href="__init__.py.html">__init__</a></td><td valign="top" align="left">
<p>HappyDoc Components</p>
</td></tr>
<tr><td valign="top" align="left"><a href="appclass.py.html">appclass</a></td><td valign="top" align="left">
<p>Command line application class for HappyDoc.</p>
</td></tr>
<tr><td valign="top" align="left"><a href="cvsversion.py.html">cvsversion</a></td><td valign="top" align="left">
<p>Get the CVS version information based on the $Name: r2_0 $ token.</p>
</td></tr>
<tr><td valign="top" align="left"><a href="docset/index.html">docset</a></td><td valign="top" align="left">
<p>Documentation Sets</p>
</td></tr>
<tr><td valign="top" align="left"><a href="docstring/index.html">docstring</a></td><td valign="top" align="left">
<p>Python docstring converter plugins.</p>
</td></tr>
<tr><td valign="top" align="left"><a href="formatter/index.html">formatter</a></td><td valign="top" align="left">
<p>Output Formatters</p>
</td></tr>
<tr><td valign="top" align="left"><a href="happydocset.py.html">happydocset</a></td><td valign="top" align="left">
<p>Base for docsets.</p>
</td></tr>
<tr><td valign="top" align="left"><a href="happydocstring.py.html">happydocstring</a></td><td valign="top" align="left">
<p>Base class for docstring converters.</p>
</td></tr>
<tr><td valign="top" align="left"><a href="happydom.py.html">happydom</a></td><td valign="top" align="left">
<p>Base class for accessing documentation extracted from inputs.</p>
</td></tr>
<tr><td valign="top" align="left"><a href="happyformatter.py.html">happyformatter</a></td><td valign="top" align="left">
<p>Base class for formatting info generated by parseinfo classes.</p>
</td></tr>
<tr><td valign="top" align="left"><a href="indentstring.py.html">indentstring</a></td><td valign="top" align="left">
<p>Function to indent the lines of a string using a standard indent spacing.</p>
</td></tr>
<tr><td valign="top" align="left"><a href="optiontools.py.html">optiontools</a></td><td valign="top" align="left">
<p>Functions for handling options and arguments.</p>
</td></tr>
<tr><td valign="top" align="left"><a href="parsecomments.py.html">parsecomments</a></td><td valign="top" align="left">
<p>Parse comment information from a module.</p>
</td></tr>
<tr><td valign="top" align="left"><a href="parseinfo/index.html">parseinfo</a></td><td valign="top" align="left">
<p>Extract information from a Python code parse tree.</p>
</td></tr>
<tr><td valign="top" align="left"><a href="path.py.html">path</a></td><td valign="top" align="left">
<p>Provide a common set of path management functions.</p>
</td></tr>
<tr><td valign="top" align="left"><a href="pluginloader.py.html">pluginloader</a></td><td valign="top" align="left">
<p>Define a class to handle pluggable module loading.</p>
</td></tr>
<tr><td valign="top" align="left"><a href="prettyast.py.html">prettyast</a></td><td valign="top" align="left">
<p>Pretty print the AST for a .py file.</p>
</td></tr>
<tr><td valign="top" align="left"><a href="trace.py.html">trace</a></td><td valign="top" align="left">
<p>A debugging trace module.</p>
</td></tr>
</table>
</td></tr>
</table>
</td>
</tr>
</table>
<hr>
<p><i><a href="index.html">Table of Contents</a></i></p>
<font size="-2"><i>This document was automatically generated
on Sun Dec 30 07:30:04 2001 by
<a href="http://happydoc.sourceforge.net">HappyDoc</a> version
2.0</i></font>
</body>
</html>
|
