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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html40/loose.dtd">
<html>
<head>
<title>Module: docset_mstruct</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">Module: docset_mstruct</font>
</th>
<th width="90%" align="right"><font color="#000000">../HappyDoc-r2_0/happydoclib/docset/docset_mstruct.py</font></th>
</tr>
<tr>
<td>
<p>Documentation set which writes output to multiple structured files.</p>
<p>This docset creates file for every module and defined class.</p>
<p>Documentation structure is rendered with formatter's <em>process</em> methods
(processClass, processModule, processImport, etc.). There is special
method -- processRoot. It is invoked when new output is opened
or closed.</p>
<dl>
<dt>These all methods can be called in four different stages (element</dt>
<dd>i.e.
class or module):
1. PRE -- before any of elements processing
2. START -- before an element processing
3. END -- after an element processing
4. POST -- after all element processing</dd>
</dl>
<p>Formatters can produce index of created by this docset files with packageIndex,
moduleIndex and classIndex methods.</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>from</b> happydoclib.docset.mstruct_const <b>import</b> *<br>
<b>import</b> happydoclib.happydocset<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="#entryPoint">entryPoint</a><br>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="entryPoint"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">entryPoint </font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
entryPoint ()
</pre></font>
<p>Return info about this module to the HappyDoc dynamic loader.</p>
</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"><a href="docset_mstruct_MStructDocSet.py.html">MStructDocSet</a></td><td valign="top" align="left">
<p>Documentation set written to multiple structured files.</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 Sun Dec 30 07:30:05 2001 by
<a href="http://happydoc.sourceforge.net">HappyDoc</a> version
2.0</i></font>
</body>
</html>
|
