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
|
<?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</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> ::
Module latex
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[show private | <a href="../public/epydoc.latex-module.html">hide private</a>]</font></td></tr>
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="epydoc.latex-module.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module epydoc.latex</h2>
Documentation to LaTeX converter. This module defines a single class,
<a href="epydoc.latex.LatexFormatter-class.html"
class="link"><code>LatexFormatter</code></a>, which translates the API
documentation encoded in a <a href="epydoc.objdoc.DocMap-class.html"
class="link"><code>DocMap</code></a> into a set of LaTeX files.
<hr/>
<p><b>Bug:</b> If a longtable is generated with a single row that's larger than a
page, then LaTeX is unable to generate the correct output. This should
only be a problem if a variable or property has a very long
description.
</p>
<!-- =========== START OF CLASSES =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Classes</th></tr>
<tr><td width="15%">
<b><a href="epydoc.latex.LatexFormatter-class.html"><code>LatexFormatter</code></a></b></td>
<td>Documentation to LaTeX converter.</td></tr>
<tr><td width="15%">
<b><a href="../private/epydoc.latex._LatexDocstringLinker-class.html"><code>_LatexDocstringLinker</code></a></b></td>
<td> </td></tr>
</table><br />
<!-- =========== START OF VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="../private/epydoc.latex-module.html#_HRULE"><code>_HRULE</code></a></b>: LaTeX code for a horizontal rule across the page</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="../private/epydoc.latex-module.html#_LATEX_HEADER"><code>_LATEX_HEADER</code></a></b>: The header for standard documentation LaTeX pages.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td>
<td><b><a href="../private/epydoc.latex-module.html#_SECTIONS"><code>_SECTIONS</code></a></b>: A list of string patterns that encode each numbered section level.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td>
<td><b><a href="../private/epydoc.latex-module.html#_STARSECTIONS"><code>_STARSECTIONS</code></a></b>: A list of string patterns that encode each un-numbered section
level.</td></tr>
</table><br />
<!-- =========== START OF VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_HRULE"></a>
<h3>_HRULE</h3>
LaTeX code for a horizontal rule across the page
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>str</code>
</dd>
<span title="'\\rule{\\textwidth}{0.5\\fboxrule}\n\n'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'''</span>\\rule{\\textwidth}{0.5\\fboxrule}
<span class="variable-quote">'''</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_LATEX_HEADER"></a>
<h3>_LATEX_HEADER</h3>
The header for standard documentation LaTeX pages.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>str</code>
</dd>
<span title="'\\documentclass{article}\n\\usepackage{alltt, parskip, fancyheadings, boxedminipage}\n\\usepackage{makeidx, multirow, longtable, tocbibind, amssymb}\n\\usepackage{fullpage}\n%\\usepackage[headings]{fullpage}\n\\begin{document}\n\n\\setlength{\\parindent}{0ex}\n\\setlength{\\fboxrule}{2\\fboxrule}\n\\newlength{\\BCL} % base class length, for base trees.\n\n\\pagestyle{fancy}\n\\renewcommand{\\sectionmark}[1]{\\markboth{#1}{}}\n\\renewcommand{\\subsectionmark}[1]{\\markright{#1}}\n\n\\newenvironment{Ventry}[1]%\n {\\begin{list}{}{%\n \\renewcommand{\\makelabel}[1]{\\texttt{##1:}\\hfil}%\..."> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'''</span>\\documentclass{article}
\\usepackage{alltt, parskip, fancyheadings, boxedminipage}
\\usepackage{makeidx, multirow, longtable, tocbibind, amssymb}
\\usepackage{fullpage}
%\\usepackage[headings]{fullpage}
\\begin{document}
\\setlength{\\parindent}{0ex}
<span class="variable-ellipsis">...</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_SECTIONS"></a>
<h3>_SECTIONS</h3>
A list of string patterns that encode each numbered section level.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>list</code>
</dd>
<span title="['\\part{%s}', '\\chapter{%s}', '\\section{%s}', '\\subsection{%s}', '\\subsubsection{%s}', '\\textbf{%s}']"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
['\\part{%s}',
'\\chapter{%s}',
'\\section{%s}',
'\\subsection{%s}',
'\\subsubsection{%s}',
'\\textbf{%s}'] </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_STARSECTIONS"></a>
<h3>_STARSECTIONS</h3>
A list of string patterns that encode each un-numbered section
level.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>list</code>
</dd>
<span title="['\\part*{%s}', '\\chapter*{%s}', '\\section*{%s}', '\\subsection*{%s}', '\\subsubsection*{%s}', '\\textbf{%s}']"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
['\\part*{%s}',
'\\chapter*{%s}',
'\\section*{%s}',
'\\subsection*{%s}',
'\\subsubsection*{%s}',
'\\textbf{%s}'] </pre>
</td></tr></table></dd>
</span> </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:12 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>
|
