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
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
|
<?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">[show private | <a href="../public/epydoc.latex.LatexFormatter-class.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.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>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_base_tree"></a><span class="summary-sig"><span class="summary-sig-name">_base_tree</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>uid</span>,
<span class=summary-sig-arg>width</span>,
<span class=summary-sig-arg>linespec</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_base_tree_line"></a><span class="summary-sig"><span class="summary-sig-name">_base_tree_line</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>uid</span>,
<span class=summary-sig-arg>width</span>,
<span class=summary-sig-arg>linespec</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_class_list"></a><span class="summary-sig"><span class="summary-sig-name">_class_list</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>container</span>,
<span class=summary-sig-arg>classes</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_class_list_line"></a><span class="summary-sig"><span class="summary-sig-name">_class_list_line</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>link</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_class_to_latex"></a><span class="summary-sig"><span class="summary-sig-name">_class_to_latex</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>uid</span>)</span></code>
</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="../private/epydoc.latex.LatexFormatter-class.html#_cmp_name" class="summary-sig-name"><code>_cmp_name</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name1</span>,
<span class=summary-sig-arg>name2</span>)</span></code>
<br />
Compare uid1 and uid2 by their names, using the following rules:</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_descrlist"></a><span class="summary-sig"><span class="summary-sig-name">_descrlist</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>items</span>,
<span class=summary-sig-arg>singular</span>,
<span class=summary-sig-arg>plural</span>,
<span class=summary-sig-arg>short</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_docstring_to_latex"></a><span class="summary-sig"><span class="summary-sig-name">_docstring_to_latex</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>docstring</span>,
<span class=summary-sig-arg>indent</span>,
<span class=summary-sig-arg>breakany</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="../private/epydoc.latex.LatexFormatter-class.html#_excluded" class="summary-sig-name"><code>_excluded</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>x</span>)</span></code>
<br />
Return true if the given object should be excluded from the documentation
(since it was imported or inherited from a module that we're not
documenting).</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="../private/epydoc.latex.LatexFormatter-class.html#_filter" class="summary-sig-name"><code>_filter</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>links</span>)</span></code>
<br />
Filter a list of <code>Link</code>s.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_find_tree_width"></a><span class="summary-sig"><span class="summary-sig-name">_find_tree_width</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>uid</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_func_list"></a><span class="summary-sig"><span class="summary-sig-name">_func_list</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>container</span>,
<span class=summary-sig-arg>functions</span>,
<span class=summary-sig-arg>heading</span>,
<span class=summary-sig-arg>seclevel</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_func_list_box"></a><span class="summary-sig"><span class="summary-sig-name">_func_list_box</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>link</span>,
<span class=summary-sig-arg>cls</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_func_signature"></a><span class="summary-sig"><span class="summary-sig-name">_func_signature</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>fname</span>,
<span class=summary-sig-arg>fdoc</span>,
<span class=summary-sig-arg>show_defaults</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_header"></a><span class="summary-sig"><span class="summary-sig-name">_header</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>where</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_indexterm"></a><span class="summary-sig"><span class="summary-sig-name">_indexterm</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>uid</span>,
<span class=summary-sig-arg>pos</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_inheritance_list"></a><span class="summary-sig"><span class="summary-sig-name">_inheritance_list</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>links</span>,
<span class=summary-sig-arg>cls</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_inheritance_list_line"></a><span class="summary-sig"><span class="summary-sig-name">_inheritance_list_line</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>links</span>,
<span class=summary-sig-arg>cls</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>boolean</code>
</font></td>
<td><code><span class="summary-sig"><a href="../private/epydoc.latex.LatexFormatter-class.html#_is_private" class="summary-sig-name"><code>_is_private</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>str</span>)</span></code>
<br />
Return true if <code>str</code> is the name of a private Python object.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_kind"></a><span class="summary-sig"><span class="summary-sig-name">_kind</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>uid</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>string</code>
</font></td>
<td><code><span class="summary-sig"><a href="../private/epydoc.latex.LatexFormatter-class.html#_module_list" class="summary-sig-name"><code>_module_list</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>container</span>,
<span class=summary-sig-arg>modules</span>)</span></code>
<br />
Return the HTML code for the module hierarchy tree, containing the given
modules.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_module_to_latex"></a><span class="summary-sig"><span class="summary-sig-name">_module_to_latex</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>uid</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>string</code>
</font></td>
<td><code><span class="summary-sig"><a href="../private/epydoc.latex.LatexFormatter-class.html#_module_tree" class="summary-sig-name"><code>_module_tree</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>sortorder</span>)</span></code>
<br />
Return the HTML code for the module hierarchy tree.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>string</code>
</font></td>
<td><code><span class="summary-sig"><a href="../private/epydoc.latex.LatexFormatter-class.html#_module_tree_item" class="summary-sig-name"><code>_module_tree_item</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>uid</span>,
<span class=summary-sig-arg>depth</span>)</span></code>
<br />
Helper function for <a
href="../private/epydoc.latex.LatexFormatter-class.html#_module_tree"
class="link"><code>_module_tree</code></a> and <a
href="../private/epydoc.latex.LatexFormatter-class.html#_module_list"
class="link"><code>_module_list</code></a>.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_params_to_latex"></a><span class="summary-sig"><span class="summary-sig-name">_params_to_latex</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>parameters</span>,
<span class=summary-sig-arg>show_defaults</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_pprint_var_value"></a><span class="summary-sig"><span class="summary-sig-name">_pprint_var_value</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>var</span>,
<span class=summary-sig-arg>maxwidth</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_property_list"></a><span class="summary-sig"><span class="summary-sig-name">_property_list</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>container</span>,
<span class=summary-sig-arg>properties</span>,
<span class=summary-sig-arg>heading</span>,
<span class=summary-sig-arg>seclevel</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_property_list_line"></a><span class="summary-sig"><span class="summary-sig-name">_property_list_line</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>link</span>,
<span class=summary-sig-arg>container</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_section"></a><span class="summary-sig"><span class="summary-sig-name">_section</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>title</span>,
<span class=summary-sig-arg>depth</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_sectionstar"></a><span class="summary-sig"><span class="summary-sig-name">_sectionstar</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>title</span>,
<span class=summary-sig-arg>depth</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>string</code>
</font></td>
<td><code><span class="summary-sig"><a href="../private/epydoc.latex.LatexFormatter-class.html#_standard_fields" class="summary-sig-name"><code>_standard_fields</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>doc</span>)</span></code>
<br />
Return hTML code containing descriptions of the epytext fields that are
common to all <a href="epydoc.objdoc.ObjDoc-class.html"
class="link"><code>ObjDoc</code></a>s (except for
<code>descr</code>).</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_start_of"></a><span class="summary-sig"><span class="summary-sig-name">_start_of</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>section_name</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="../private/epydoc.latex.LatexFormatter-class.html#_subclasses" class="summary-sig-name"><code>_subclasses</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>subclasses</span>,
<span class=summary-sig-arg>container</span>)</span></code>
<br />
Return the LaTeX code for the subclasses field.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>string</code>
</font></td>
<td><code><span class="summary-sig"><a href="../private/epydoc.latex.LatexFormatter-class.html#_summary" class="summary-sig-name"><code>_summary</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>doc</span>,
<span class=summary-sig-arg>container</span>)</span></code>
<br />
Return the LATEX code for the summary description of the object documented by
<code>doc</code>.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="../private/epydoc.latex.LatexFormatter-class.html#_text_to_latex" class="summary-sig-name"><code>_text_to_latex</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>str</span>,
<span class=summary-sig-arg>nbsp</span>,
<span class=summary-sig-arg>breakany</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_topfile"></a><span class="summary-sig"><span class="summary-sig-name">_topfile</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_uid_to_label"></a><span class="summary-sig"><span class="summary-sig-name">_uid_to_label</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>uid</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_var_list"></a><span class="summary-sig"><span class="summary-sig-name">_var_list</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>container</span>,
<span class=summary-sig-arg>variables</span>,
<span class=summary-sig-arg>heading</span>,
<span class=summary-sig-arg>seclevel</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_var_list_line"></a><span class="summary-sig"><span class="summary-sig-name">_var_list_line</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>var</span>,
<span class=summary-sig-arg>container</span>)</span></code>
</td></tr>
</table><br />
<!-- =========== START OF INSTANCE VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Instance Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="../private/epydoc.latex.LatexFormatter-class.html#_docmap"><code>_docmap</code></a></b>: The documentation map, encoding the objects that should be
documented.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="../private/epydoc.latex.LatexFormatter-class.html#_show_private"><code>_show_private</code></a></b>: Whether to include show private objects in the documentation.</td></tr>
</table><br />
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Class Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><a
href="../private/epydoc.latex._LatexDocstringLinker-class.html"
class="link"><code>_LatexDocstringLinker</code></a></font></td>
<td><b><a href="../private/epydoc.latex.LatexFormatter-class.html#_docstring_linker"><code>_docstring_linker</code></a></b> = <span title="<epydoc.latex._LatexDocstringLinker instance at 0x826dbf4>"><code><epydoc.latex._LatexDocstringLinker <span class="variable-ellipsis">...</span></code>
</span></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>
<a name="_cmp_name"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_cmp_name</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>name1</span>,
<span class=sig-arg>name2</span>)</span>
</h3>
Compare uid1 and uid2 by their names, using the following rules:
<ul>
<li>
<code>'__init__'</code> < anything.
</li>
<li>
public < private.
</li>
<li>
otherwise, sort alphabetically by name (ignoring case)
</li>
</ul>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
-1 if <code>uid1<uid2</code>; 0 if <code>uid1==uid2</code>;
and 1 if <code>uid1>uid2</code>.
<br /><i>
(type=<code>int</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_excluded"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_excluded</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>x</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
True if the given object should be excluded from the
documentation (since it was imported or inherited from a module
that we're not documenting).
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_filter"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_filter</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>links</span>)</span>
</h3>
Filter a list of <code>Link</code>s. If <a
href="../private/epydoc.latex.LatexFormatter-class.html#_show_private"
class="link"><code>_show_private</code></a> is false, then filter out
all private objects; otherwise, perform no filtering.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>links</b></code> -
The list of <code>Link</code>s to be filtered.
<br /><i>
(type=<code>list</code> of <a
href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
The filtered list of links.
<br /><i>
(type=<code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_is_private"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_is_private</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>str</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
true if <code>str</code> is the name of a private Python
object.
<br /><i>
(type=<code>boolean</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_module_list"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_module_list</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>container</span>,
<span class=sig-arg>modules</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
The HTML code for the module hierarchy tree, containing the
given modules. This is used by <a
href="../private/epydoc.latex.LatexFormatter-class.html#_module_to_latex"
class="link"><code>_module_to_latex</code></a> to list the
submodules of a package.
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_module_tree"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_module_tree</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>sortorder</span>=<span class=sig-default>None</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
The HTML code for the module hierarchy tree. This is used by
<code>_trees_to_latex</code> to construct the hiearchy page.
(Well, actually, it's not used by anything at present.)
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_module_tree_item"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_module_tree_item</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>uid</span>=<span class=sig-default>None</span>,
<span class=sig-arg>depth</span>=<span class=sig-default>0</span>)</span>
</h3>
Helper function for <a
href="../private/epydoc.latex.LatexFormatter-class.html#_module_tree"
class="link"><code>_module_tree</code></a> and <a
href="../private/epydoc.latex.LatexFormatter-class.html#_module_list"
class="link"><code>_module_list</code></a>.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>string</code>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_standard_fields"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_standard_fields</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>doc</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>doc</b></code> -
The object whose fields should be described.
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
HTML code containing descriptions of the epytext fields that
are common to all <a href="epydoc.objdoc.ObjDoc-class.html"
class="link"><code>ObjDoc</code></a>s (except for
<code>descr</code>).
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_subclasses"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_subclasses</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>subclasses</span>,
<span class=sig-arg>container</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
The LaTeX code for the subclasses field.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_summary"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_summary</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>doc</span>,
<span class=sig-arg>container</span>=<span class=sig-default>None</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>doc</b></code> -
The documentation for the object whose summary should be
returned.
<br /><i>
(type=<a href="epydoc.objdoc.ObjDoc-class.html"
class="link"><code>objdoc.ObjDoc</code></a>)</i>
<dd><code><b>container</b></code> -
The container object for <code>doc</code>, or
<code>None</code> if there is none. This container object is used
to resolve links (L{...}) in the epytext.
<br /><i>
(type=<a href="epydoc.uid.UID-class.html"
class="link"><code>uid.UID</code></a>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
The LATEX code for the summary description of the object
documented by <code>doc</code>. A summary description is the
first sentence of the <code>doc</code>'s 'description' field. If
the <code>doc</code> has no 'description' field, but does have a
'return' field, then the summary is taken from the return field
instead.
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_text_to_latex"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_text_to_latex</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>str</span>,
<span class=sig-arg>nbsp</span>=<span class=sig-default>0</span>,
<span class=sig-arg>breakany</span>=<span class=sig-default>0</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>breakany</b></code> -
Insert hyphenation marks, so that LaTeX can break the
resulting string at any point. This is useful for small boxes
(e.g., the type box in the variable list table).
</dd>
</dl>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF INSTANCE VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Instance Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_docmap"></a>
<h3>_docmap</h3>
The documentation map, encoding the objects that should be
documented.
</td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_show_private"></a>
<h3>_show_private</h3>
Whether to include show private objects in the documentation.
</td></tr></table>
<br />
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Class Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_docstring_linker"></a>
<h3>_docstring_linker</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<a
href="../private/epydoc.latex._LatexDocstringLinker-class.html"
class="link"><code>_LatexDocstringLinker</code></a>
</dd>
<span title="<epydoc.latex._LatexDocstringLinker instance at 0x826dbf4>"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<epydoc.latex._LatexDocstringLinker instance at 0x826dbf4> </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: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>
|
