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
|
<?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.latex.LatexFormatter</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 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">
<a href="epydoc-module.html">Package epydoc</a> ::
<a href="epydoc.latex-module.html">Module latex</a> ::
Class LatexFormatter
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="../private/epydoc.latex.LatexFormatter-class.html">show private</a> | hide private]</font></td></tr>
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="epydoc.latex.LatexFormatter-class.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class LatexFormatter</h2>
<hr/>
Documentation to LaTeX converter. The API documentation produced by
<code>LatexFormatter</code> consists of a single LaTeX document, divided
into several different files. In particular, <code>LatexFormatter</code>
generates the following files:
<ul>
<li>
<a name="index-api_tex"></a><i class="indexterm">api.tex</i>: The
top-level LaTeX file. This file imports the other files, to create a
single unified document. This is the file that you should run
<code>latex</code> on.
</li>
<li>
<a name="index-module_module_tex"></a><i
class="indexterm"><i>module</i>-module.tex</i>: The API documentation
for a module. <i>module</i> is the complete dotted name of the
module, such as <code>sys</code> or <code>epydoc.epytext</code>.
</li>
<li>
<a name="index-class_class_tex"></a><i
class="indexterm"><i>class</i>-class.tex</i>: The API documentation
for a class, exception, or type. <i>class</i> is the complete dotted
name of the class, such as <code>epydoc.epytext.Token</code> or
<code>array.ArrayType</code>. These class documentation files are
only created if the <code>list_classes_separately</code> option is
used; otherwise, the documentation for each class is included in its
module's documentation file.
</li>
</ul>
The methods <code>write_module</code> and <code>write_class</code>
used to generate individual module and class documentation LaTeX files.
These files can then be included as chapters or sections of other LaTeX
documents (with <code>"\include"</code>). When using these
methods, you may wish to disable the <code>crossref</code> option, which
will turn off crossreferencing betweeen modules and classes, since some
of these crossreference links will be broken if you only include some of
the API documentation as chapters or sections of your document.
<hr/>
<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="epydoc.latex.LatexFormatter-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>docmap</span>,
<span class="summary-sig-kwarg">**kwargs</span>)</span></code>
<br />
Construct a new LaTeX formatter, using the given documentation
map.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>int</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.latex.LatexFormatter-class.html#num_files" class="summary-sig-name"><code>num_files</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the number of files that this <code>LatexFormatter</code> will
generate.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>None</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.latex.LatexFormatter-class.html#write" class="summary-sig-name"><code>write</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>directory</span>,
<span class=summary-sig-arg>progress_callback</span>)</span></code>
<br />
Write the API documentation for the entire project to the given
directory.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="epydoc.latex.LatexFormatter-class.html#write_class" class="summary-sig-name"><code>write_class</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>uid</span>,
<span class=summary-sig-arg>filename</span>)</span></code>
<br />
Write the API documentation for the given class to
<code>filename</code>.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="epydoc.latex.LatexFormatter-class.html#write_module" class="summary-sig-name"><code>write_module</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>uid</span>,
<span class=summary-sig-arg>filename</span>)</span></code>
<br />
Write the API documentation for the given module to
<code>filename</code>.</td></tr>
</table><br />
<!-- =========== START OF METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Method Details</th></tr>
</table>
<a name="__init__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>docmap</span>,
<span class="sig-kwarg">**kwargs</span>)</span>
<br /><i>(Constructor)</i>
</h3>
Construct a new LaTeX formatter, using the given documentation
map.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>docmap</b></code> -
The documentation to output.
<br /><i>
(type=<a href="epydoc.objdoc.DocMap-class.html"
class="link"><code>DocMap</code></a>)</i>
<dd><code><b>kwargs</b></code> -
Keyword arguments:
<ul>
<li>
<code>prj_name</code>: The name of the project. Defaults
to none. (type=<code>string</code>)
</li>
<li>
<code>private</code>: Whether to create documentation for
private objects. By default, private objects are documented.
(type=<code>boolean</code>)
</li>
<li>
<code>crossref</code>: Whether to create crossreference
links between classes and modules. By default, crossreference
links are created. (type=<code>boolean</code>)
</li>
<li>
<code>index</code>: Whether to generate an index. If you
generate an index, you will need to run
<code>makeindex</code> to make the <code>.idx</code> file. By
default, an index is generated.
(type=<code>boolean</code>)
</li>
<li>
<code>list_classes_separately</code>: Whether to list
classes in separate chapters, or to include them as sections
of their modules' chapters. By default, they are not listed
separately. (type=<code>boolean</code>)
</li>
<li>
<code>exclude</code>: Whether to exclude inherited objects
and imported objects that are not defined by any of the
modules that are being documented. By default, these objects
are excluded. (type=<code>boolean</code>)
</li>
<li>
<code>alphabetical</code>: Whether to list modules in
alphabetical order or in the order that they were specified
in on the command line. By default, modules are listed in
alphabetical order. (type=<code>boolean</code>)
</li>
</ul>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="num_files"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">num_files</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
The number of files that this <code>LatexFormatter</code> will
generate.
<br /><i>
(type=<code>int</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="write"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">write</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>directory</span>=<span class=sig-default>None</span>,
<span class=sig-arg>progress_callback</span>=<span class=sig-default>None</span>)</span>
</h3>
Write the API documentation for the entire project to the given
directory.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>directory</b></code> -
The directory to which output should be written. If no
directory is specified, output will be written to the current
directory. If the directory does not exist, it will be
created.
<br /><i>
(type=<code>string</code>)</i>
<dd><code><b>progress_callback</b></code> -
A callback function that is called before each file is
written, with the name of the created file.
<br /><i>
(type=<code>function</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>None</code>
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>OSError</b></code> -
If <code>directory</code> cannot be created,
<dd><code><b>OSError</b></code> -
If any file cannot be created or written to.
</dl>
</dd></dl>
</td></tr></table>
<a name="write_class"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">write_class</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>uid</span>,
<span class=sig-arg>filename</span>)</span>
</h3>
Write the API documentation for the given class to
<code>filename</code>.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>uid</b></code> -
The unique identifier of the class to document.
<br /><i>
(type=<a href="epydoc.uid.UID-class.html"
class="link"><code>UID</code></a>)</i>
<dd><code><b>filename</b></code> -
The name of the file to write the documentation to.
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>OSError</b></code> -
If <code>directory</code> cannot be created,
<dd><code><b>OSError</b></code> -
If any file cannot be created or written to.
<dd><code><b>ValueError</b></code> -
If <code>uid</code> is not the identifier for a class.
</dl>
</dd></dl>
</td></tr></table>
<a name="write_module"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">write_module</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>uid</span>,
<span class=sig-arg>filename</span>)</span>
</h3>
Write the API documentation for the given module to
<code>filename</code>.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>uid</b></code> -
The unique identifier of the module to document.
<br /><i>
(type=<a href="epydoc.uid.UID-class.html"
class="link"><code>UID</code></a>)</i>
<dd><code><b>filename</b></code> -
The name of the file to write the documentation to.
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>OSError</b></code> -
If <code>directory</code> cannot be created,
<dd><code><b>OSError</b></code> -
If any file cannot be created or written to.
<dd><code><b>ValueError</b></code> -
If <code>uid</code> is not the identifier for a module.
</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 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: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>
|
