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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html40/loose.dtd">
<html>
<head>
<title>Module: __init__</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>
<th rowspan="2"
valign="top"
align="left"
width="10%"
bgcolor="#88bbee"><font color="#000000">Module: __init__</font>
</th>
<th bgcolor="#88bbee"
width="90%"
align="right"><font color="#000000">../HappyDoc-r2_1/happydoclib/docstring/__init__.py</font>
</th>
</tr>
<tr>
<td>
<h3>Python docstring converter plugins.</h3>
<p> <em>How does an author write documentation so that it will be marked
up and look fancy?</em> This is a perennial question for
<a href="http://www.python.org">Python</a> users, and seems to have introduced
a roadblock into the development of more robust and useful
documentation tools. HappyDoc stands firmly on the fence and does
not attempt to resolve the issue.</p>
<p> By separating the docstring converter and formatter classes from
the docset classes, HappyDoc allows a user to create their own
converter and formatter to interpret comments in any way they see
fit.</p>
<p> The docstring converter plugins are responsible for translating
text from the input markup syntax to the output format. This
translation is formatter independent, so that the same HTML
conversion might be used by mutliple HTML formatters. It is,
however, <em>format</em> dependent, so that HTML output should not be
used by a plain text formatter.</p>
<p> The default for the <code>HTMLTableFormatter</code> (the default formatter
for HappyDoc) is to treat <code>__doc__</code> strings as
<a href="http://www.zope.org//Members/jim/StructuredTextWiki/StructuredTextNGRules">StructuredTextNG</a>.
This is the "Next Generation" version of the original
<a href="http://www.python.org/sigs/doc-sig/stext.html">StructuredText</a>
markup syntax. See also the <code>StructuredText</code> package for a
description of the rules for using StructuredText.</p>
<p> <em>Don't like StructuredText?</em> Write your own docstring converter
that uses something different and drop it into place. Refer to
the <code>happydocstring.py</code> module for the base class and APIs
required of a docstring converter. If a defacto (or otherwise)
standard structured markup for Python <code>__doc__</code> strings emerges,
HappyDoc will be updated to use that format by default.</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="Imported modules">Imported modules</a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000"> </font>
</th>
</tr>
<tr>
<td>
<b>import</b> <a href="../../../happydoclib/index.html">happydoclib</a><br>
<b>import</b> <a href="http://www.python.org/doc/current/lib/module-re.html">re</a><br>
<b>import</b> <a href="http://www.python.org/doc/current/lib/module-sys.html">sys</a><br>
<b>import</b> <a href="http://www.python.org/doc/current/lib/module-traceback.html">traceback</a><br>
</td></tr>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="Functions">Functions</a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000"> </font>
</th>
</tr>
<tr>
<td>
<a href="#DocStringLoader">DocStringLoader</a><br>
<a href="#getConverterFactory">getConverterFactory</a><br>
<a href="#getConverterFactoryForFile">getConverterFactoryForFile</a><br>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="DocStringLoader"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">DocStringLoader </font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
DocStringLoader ()
</pre></font>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="getConverterFactory"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">getConverterFactory </font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
getConverterFactory ( formatType )
</pre></font>
<h3>Returns the factory for a docstring converter for <code>formatType</code> text.</h3>
<h4> Parameters:</h4>
<dl>
<dt> <code>formatType</code></dt>
<dd>A string representing the name of the input text
type. If this string does not match a registered docstring
converter input format, a ValueError exception will be raised.</dd>
</dl>
<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="Exceptions">Exceptions</a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000"> </font>
</th>
</tr>
<tr>
<td>
ValueError( 'Unrecognized docstring format type "%s"' % formatType )<br>
</td></tr>
</table>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="getConverterFactoryForFile"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">getConverterFactoryForFile </font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
getConverterFactoryForFile ( filename )
</pre></font>
<h3>Returns the factory for a docstring converter for an external file.</h3>
<h4> Parameters:</h4>
<dl>
<dt> <code>filename</code></dt>
<dd>The name of the external file to be examined.</dd>
</dl>
</td></tr>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="Classes">Classes</a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000"> </font>
</th>
</tr>
<tr>
<td>
<table border="0" cellpadding="3" cellspacing="0">
<tr><td valign="top" align="left"><p><a href="__init__/DocStringLoaderSingleton.html">DocStringLoaderSingleton</a></p></td><td valign="top" align="left">
<p>Load pluggable docstring converters.</p>
</td></tr>
</table>
</td></tr>
</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 Sat Aug 24 16:57:29 2002 by
<a href="http://happydoc.sourceforge.net">HappyDoc</a> version
2.1</i></font>
</body>
</html>
|
