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
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
|
<?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.html.HTMLFormatter</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.html-module.html">Module html</a> ::
Class HTMLFormatter
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[show private | <a href="../public/epydoc.html.HTMLFormatter-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.html.HTMLFormatter-class.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class HTMLFormatter</h2>
<hr/>
Documentation to HTML converter. The API documentation produced
<code>HTMLFormatter</code> consists of a set of HTML files. Two
subdirectories are created for the public and private documentation.
Within each subdirectories, every class and module is documented in its
own file. An index file, a trees file, a help file, and a frames-based
table of contents are also created. In particular,
<code>HTMLFormatter</code> generates the following files:
<ul>
<li>
<a name="index-index_html"></a><i
class="indexterm">index.html</i>: The standard entry point for the
documentation. Normally, index.html is a frame index file, which
defines three frames: two frames on the left side of the browser
contain a table of contents, and the main frame on the right side of
the window contains documentation pages. But if the --no-frames
option is used, then index.html will redirect the user to the
project's top page.
</li>
<li>
<a name="index-module_module_html"></a><i
class="indexterm"><i>module</i>-module.html</i>: The API
documentation for a module. <i>module</i> is the complete dotted name
of the module, such as sys or epydoc.epytext.
</li>
<li>
<a name="index-class_class_html"></a><i
class="indexterm"><i>class</i>-class.html</i>: The API documentation
for a class, exception, or type. <i>class</i> is the complete dotted
name of the class, such as epydoc.epytext.Token or
array.ArrayType.
</li>
<li>
<a name="index-trees_html"></a><i
class="indexterm">trees.html</i>: The module and class
hierarchies.
</li>
<li>
<a name="index-indices_html"></a><i
class="indexterm">indices.html</i> The term and identifier
indices.
</li>
<li>
<a name="index-help_html"></a><i class="indexterm">help.html</i>:
The help page for the project. This page explains how to use and
navigate the webpage produced by epydoc.
</li>
<li>
<a name="index-toc_html"></a><i class="indexterm">toc.html</i>:
The top-level table of contents page. This page is displayed in the
upper-left frame, and provides links to toc-everything.html and the
toc-<i>module</i>-module.html files. toc.html is not generated if the
--no-frames option is used.
</li>
<li>
<a name="index-toc_everything_html"></a><i
class="indexterm">toc-everything.html</i>: The table of contents for
the entire project. This page is displayed in the lower-left frame,
and provides links to every class, type, exception, function, and
variable defined by the project. toc-everything.html is not generated
if the --no-frames option is used.
</li>
<li>
<a name="index-toc_module_module_html"></a><i
class="indexterm">toc-<i>module</i>-module.html</i>: The table of
contents for a module. This page is displayed in the lower-left
frame, and provides links to every class, type, exception, function,
and variable defined by the module. module is the complete dotted
name of the module, such as sys or epydoc.epytext. toc-m-module.html
is not generated if the --no-frames option is used.
</li>
<li>
<a name="index-epydoc_css"></a><i
class="indexterm">epydoc.css</i>: The CSS stylesheet used to display
all HTML pages.
</li>
</ul>
<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.html.HTMLFormatter-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 HTML formatter, using the given documentation map.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="epydoc.html.HTMLFormatter-class.html#format" class="summary-sig-name"><code>format</code></a>(<span class=summary-sig-arg>object</span>,
<span class=summary-sig-arg>error_stream</span>,
<span class=summary-sig-arg>show_private</span>,
<span class=summary-sig-arg>body_only</span>,
<span class="summary-sig-kwarg">**options</span>)</span></code>
<br />
Return a string containing the HTML documentation for the given object. <i>(Static method)</i>
</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.html.HTMLFormatter-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>HTMLFormatter</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.html.HTMLFormatter-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 documentation to the given directory.</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.html.HTMLFormatter-class.html#_base_tree" class="summary-sig-name"><code>_base_tree</code></a>(<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>postfix</span>)</span></code>
<br />
Return the HTML code for a class's base 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.html.HTMLFormatter-class.html#_breadcrumbs" class="summary-sig-name"><code>_breadcrumbs</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>uid</span>)</span></code>
<br />
Return the HTML code for a series of links to the ancestors of
<code>uid</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.html.HTMLFormatter-class.html#_descrlist" class="summary-sig-name"><code>_descrlist</code></a>(<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>
<br />
Return the HTML code for a list of description items.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="epydoc.markup.ParsedDocstring-class.html"
class="link"><code>markup.ParsedDocstring</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="../private/epydoc.html.HTMLFormatter-class.html#_docstring_to_html" class="summary-sig-name"><code>_docstring_to_html</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>docstring</span>,
<span class=summary-sig-arg>uid</span>,
<span class=summary-sig-arg>indent</span>)</span></code>
<br />
Return a string containing the HTML encoding for the given
<code>ParsedDocstring</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.html.HTMLFormatter-class.html#_documented" class="summary-sig-name"><code>_documented</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>uid</span>)</span></code>
<br />
Return true if the given UID is documented by the documentation map for this
<code>HTMLFormatter</code>.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>list</code> of <a href="epydoc.uid.UID-class.html"
class="link"><code>UID</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="../private/epydoc.html.HTMLFormatter-class.html#_extract_identifier_index" class="summary-sig-name"><code>_extract_identifier_index</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return a list of the <code>UID</code>s of all objects and variables
documented by <code>_docmap</code>.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>list</code> of <code>(string, <a
href="epydoc.markup.ParsedDocstring-class.html"
class="link"><code>markup.ParsedDocstring</code></a>, list of
Link)</code>
</font></td>
<td><code><span class="summary-sig"><a href="../private/epydoc.html.HTMLFormatter-class.html#_extract_term_index" class="summary-sig-name"><code>_extract_term_index</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Extract the set of terms that should be indexed from all documented
docstrings.</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.html.HTMLFormatter-class.html#_find_top_page" class="summary-sig-name"><code>_find_top_page</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>pagename</span>)</span></code>
<br />
Find the top page for the API documentation.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="epydoc.uid.UID-class.html"
class="link"><code>UID</code></a> or <code>None</code>
</font></td>
<td><code><span class="summary-sig"><a href="../private/epydoc.html.HTMLFormatter-class.html#_find_toplevel" class="summary-sig-name"><code>_find_toplevel</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the UID of the top-level module or package, or</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.html.HTMLFormatter-class.html#_find_tree_width" class="summary-sig-name"><code>_find_tree_width</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>uid</span>)</span></code>
<br />
Helper function for <a
href="../private/epydoc.html.HTMLFormatter-class.html#_base_tree"
class="link"><code>_base_tree</code></a>.</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.html.HTMLFormatter-class.html#_footer" class="summary-sig-name"><code>_footer</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the HTML code for the footer of a page.</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.html.HTMLFormatter-class.html#_frames_link" class="summary-sig-name"><code>_frames_link</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>where</span>)</span></code>
<br />
Return hTML code for the frames/noframes selector.</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.html.HTMLFormatter-class.html#_func_details_entry" class="summary-sig-name"><code>_func_details_entry</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>function</span>,
<span class=summary-sig-arg>container</span>)</span></code>
<br />
Return the HTML code for an entry in the function details section.</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.html.HTMLFormatter-class.html#_func_signature" class="summary-sig-name"><code>_func_signature</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>fname</span>,
<span class=summary-sig-arg>fuid</span>,
<span class=summary-sig-arg>fdoc</span>,
<span class=summary-sig-arg>href</span>,
<span class=summary-sig-arg>show_defaults</span>,
<span class=summary-sig-arg>css_class</span>)</span></code>
<br />
Return the HTML code for the function signature of the function with the
given name and documentation.</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.html.HTMLFormatter-class.html#_get_index_terms" class="summary-sig-name"><code>_get_index_terms</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>parsed_docstring</span>,
<span class=summary-sig-arg>link</span>,
<span class=summary-sig-arg>terms</span>,
<span class=summary-sig-arg>links</span>)</span></code>
<br />
A helper function for <a
href="../private/epydoc.html.HTMLFormatter-class.html#_extract_term_index"
class="link"><code>_extract_term_index</code></a>.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_group_header"></a><span class="summary-sig"><span class="summary-sig-name">_group_header</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>group</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.html.HTMLFormatter-class.html#_header" class="summary-sig-name"><code>_header</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>)</span></code>
<br />
Return the HTML code for the header of a page with the given name.</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.html.HTMLFormatter-class.html#_linewrap_html" class="summary-sig-name"><code>_linewrap_html</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>str</span>,
<span class=summary-sig-arg>linelen</span>,
<span class=summary-sig-arg>maxlines</span>)</span></code>
<br />
Add line-wrapping to the HTML string <code>str</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.html.HTMLFormatter-class.html#_link_to_html" class="summary-sig-name"><code>_link_to_html</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>link</span>)</span></code>
<br />
Return the HTML code for the given link.</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="../private/epydoc.html.HTMLFormatter-class.html#_mkdir" class="summary-sig-name"><code>_mkdir</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>directory</span>)</span></code>
<br />
If the given directory does not exist, then attempt to create it.</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.html.HTMLFormatter-class.html#_param_to_html" class="summary-sig-name"><code>_param_to_html</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>param</span>,
<span class=summary-sig-arg>show_defaults</span>,
<span class=summary-sig-arg>css_class</span>)</span></code>
<br />
Return the HTML code for a single parameter.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_parameter_list"></a><span class="summary-sig"><span class="summary-sig-name">_parameter_list</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>parameters</span>,
<span class=summary-sig-arg>container</span>,
<span class=summary-sig-arg>heading</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.html.HTMLFormatter-class.html#_pprint_var_value" class="summary-sig-name"><code>_pprint_var_value</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>var</span>,
<span class=summary-sig-arg>multiline</span>,
<span class=summary-sig-arg>summary_linelen</span>)</span></code>
<br />
Return a string representation of the value of the variable <code>var</code>,
suitable for use in a <code><pre>...</pre></code> HTML
block.</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.html.HTMLFormatter-class.html#_property_in_public_details" class="summary-sig-name"><code>_property_in_public_details</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>puid</span>)</span></code>
<br />
Return true if the given property should be shown in the public version of
the property details section.</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.html.HTMLFormatter-class.html#_public_private_link" class="summary-sig-name"><code>_public_private_link</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>where</span>,
<span class=summary-sig-arg>toc</span>,
<span class=summary-sig-arg>from_private</span>)</span></code>
<br />
Return hTML code for the show/hide private selector.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>pair</code> of <code>list</code> of <a
href="epydoc.uid.Link-class.html"
class="link"><code>uid.Link</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="../private/epydoc.html.HTMLFormatter-class.html#_split_classes" class="summary-sig-name"><code>_split_classes</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>classes_and_excepts</span>)</span></code>
<br />
Divide the classes fromt the given module into exceptions and
non-exceptions.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>list</code> of <a
href="epydoc.markup.ParsedDocstring-class.html"
class="link"><code>markup.ParsedDocstring</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="../private/epydoc.html.HTMLFormatter-class.html#_standard_field_values" class="summary-sig-name"><code>_standard_field_values</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>doc</span>)</span></code>
<br />
Return a list of epytext field values that includes all fields that are
common to all <a href="epydoc.objdoc.ObjDoc-class.html"
class="link"><code>ObjDoc</code></a>s.</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.html.HTMLFormatter-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"> <code>string</code>
</font></td>
<td><code><span class="summary-sig"><a href="../private/epydoc.html.HTMLFormatter-class.html#_start_of" class="summary-sig-name"><code>_start_of</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>heading</span>)</span></code>
<br />
Return the HTML code for a 'start-of' comment.</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.html.HTMLFormatter-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>uid</span>,
<span class=summary-sig-arg>indent</span>)</span></code>
<br />
Return the HTML 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"> <code>string</code>
</font></td>
<td><code><span class="summary-sig"><a href="../private/epydoc.html.HTMLFormatter-class.html#_table_header" class="summary-sig-name"><code>_table_header</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>heading</span>,
<span class=summary-sig-arg>css_class</span>)</span></code>
<br />
Return the HTML code for the start of a table.</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.html.HTMLFormatter-class.html#_term_index_to_anchor" class="summary-sig-name"><code>_term_index_to_anchor</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>term</span>)</span></code>
<br />
Given the name of an inline index item, construct a URI anchor.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_uid_to_filename"></a><span class="summary-sig"><span class="summary-sig-name">_uid_to_filename</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.html.HTMLFormatter-class.html#_uid_to_href" class="summary-sig-name"><code>_uid_to_href</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>uid</span>,
<span class=summary-sig-arg>label</span>,
<span class=summary-sig-arg>css_class</span>,
<span class=summary-sig-arg>code</span>)</span></code>
<br />
Return the HTML code to link to the given UID.</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.html.HTMLFormatter-class.html#_uid_to_uri" class="summary-sig-name"><code>_uid_to_uri</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>uid</span>)</span></code>
<br />
Return a URI that points to the description of the object identified by
<code>uid</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.html.HTMLFormatter-class.html#_var_details_entry" class="summary-sig-name"><code>_var_details_entry</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>var</span>,
<span class=summary-sig-arg>container</span>)</span></code>
<br />
Return the HTML code for an entry in the variable details section.</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.html.HTMLFormatter-class.html#_var_value_tooltip" class="summary-sig-name"><code>_var_value_tooltip</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>var</span>)</span></code>
<br />
Return a string representation of the value of the variable <code>var</code>,
suitable for use in a tooltip.</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="../private/epydoc.html.HTMLFormatter-class.html#_write" class="summary-sig-name"><code>_write</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>write_func</span>,
<span class=summary-sig-arg>directory</span>,
<span class=summary-sig-arg>filename</span>,
<span class=summary-sig-arg>progress_callback</span>,
<span class=summary-sig-arg>is_public</span>,
<span class="summary-sig-vararg">*args</span>)</span></code>
<br />
A helper for <a href="epydoc.html.HTMLFormatter-class.html#write"
class="link"><code>write</code></a>, that creates new public and private
streams for a given filename, and delegates writing to
<code>write_func</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.html.HTMLFormatter-class.html#_write_breadcrumbs" class="summary-sig-name"><code>_write_breadcrumbs</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>public</span>,
<span class=summary-sig-arg>private</span>,
<span class=summary-sig-arg>where</span>)</span></code>
<br />
Write the HTML code for the breadcrumbs line to the given streams.</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.html.HTMLFormatter-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>public</span>,
<span class=summary-sig-arg>private</span>,
<span class=summary-sig-arg>uid</span>,
<span class=summary-sig-arg>doc</span>,
<span class=summary-sig-arg>body_only</span>)</span></code>
<br />
Write an HTML page describing the given module to the given
streams.</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.html.HTMLFormatter-class.html#_write_class_summary" class="summary-sig-name"><code>_write_class_summary</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>public</span>,
<span class=summary-sig-arg>private</span>,
<span class=summary-sig-arg>container</span>,
<span class=summary-sig-arg>classes</span>,
<span class=summary-sig-arg>heading</span>)</span></code>
<br />
Write HTML code for a class summary table.</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.html.HTMLFormatter-class.html#_write_class_summary_row" class="summary-sig-name"><code>_write_class_summary_row</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>public</span>,
<span class=summary-sig-arg>private</span>,
<span class=summary-sig-arg>link</span>)</span></code>
<br />
Write HTML code for a row in the class summary table.</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.html.HTMLFormatter-class.html#_write_class_tree" class="summary-sig-name"><code>_write_class_tree</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>public</span>,
<span class=summary-sig-arg>private</span>)</span></code>
<br />
Write HTML code for a nested list showing the base/subclass
relationships between all documented classes.</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.html.HTMLFormatter-class.html#_write_class_tree_item" class="summary-sig-name"><code>_write_class_tree_item</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>public</span>,
<span class=summary-sig-arg>private</span>,
<span class=summary-sig-arg>uid</span>,
<span class=summary-sig-arg>depth</span>,
<span class=summary-sig-arg>public_base</span>)</span></code>
<br />
Write HTML code for a list item describing a class and all of its
subclasses.</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="../private/epydoc.html.HTMLFormatter-class.html#_write_css" class="summary-sig-name"><code>_write_css</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>directory</span>,
<span class=summary-sig-arg>cssname</span>)</span></code>
<br />
Write the CSS stylesheet in 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="../private/epydoc.html.HTMLFormatter-class.html#_write_frames" class="summary-sig-name"><code>_write_frames</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>public</span>,
<span class=summary-sig-arg>private</span>)</span></code>
<br />
Write the frames index file for the frames-based table of contents to
the given streams.</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.html.HTMLFormatter-class.html#_write_func_details" class="summary-sig-name"><code>_write_func_details</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>public</span>,
<span class=summary-sig-arg>private</span>,
<span class=summary-sig-arg>container</span>,
<span class=summary-sig-arg>functions</span>,
<span class=summary-sig-arg>heading</span>)</span></code>
<br />
Write HTML code for a function details section.</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.html.HTMLFormatter-class.html#_write_func_summary" class="summary-sig-name"><code>_write_func_summary</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>public</span>,
<span class=summary-sig-arg>private</span>,
<span class=summary-sig-arg>container</span>,
<span class=summary-sig-arg>functions</span>,
<span class=summary-sig-arg>heading</span>)</span></code>
<br />
Write HTML code for a function summary table.</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.html.HTMLFormatter-class.html#_write_func_summary_row" class="summary-sig-name"><code>_write_func_summary_row</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>public</span>,
<span class=summary-sig-arg>private</span>,
<span class=summary-sig-arg>function</span>,
<span class=summary-sig-arg>container</span>)</span></code>
<br />
Write HTML code for a row in the function summary table.</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.html.HTMLFormatter-class.html#_write_help" class="summary-sig-name"><code>_write_help</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>public</span>,
<span class=summary-sig-arg>private</span>)</span></code>
<br />
Write an HTML help file to the given streams.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_write_imports"></a><span class="summary-sig"><span class="summary-sig-name">_write_imports</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>public</span>,
<span class=summary-sig-arg>private</span>,
<span class=summary-sig-arg>doc</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.html.HTMLFormatter-class.html#_write_index" class="summary-sig-name"><code>_write_index</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>directory</span>,
<span class=summary-sig-arg>frombase</span>)</span></code>
<br />
Write an <code>index.html</code> file in 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="../private/epydoc.html.HTMLFormatter-class.html#_write_indices" class="summary-sig-name"><code>_write_indices</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>public</span>,
<span class=summary-sig-arg>private</span>)</span></code>
<br />
Write an HTML page containing the term and identifier indices to the
given streams.</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.html.HTMLFormatter-class.html#_write_inheritance_list" class="summary-sig-name"><code>_write_inheritance_list</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>public</span>,
<span class=summary-sig-arg>private</span>,
<span class=summary-sig-arg>links</span>,
<span class=summary-sig-arg>cls</span>)</span></code>
<br />
Return a string containing HTML that lists all objects from that were
inherited from a base ancestor of <code>cls</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.html.HTMLFormatter-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>public</span>,
<span class=summary-sig-arg>private</span>,
<span class=summary-sig-arg>uid</span>,
<span class=summary-sig-arg>doc</span>,
<span class=summary-sig-arg>body_only</span>)</span></code>
<br />
Write an HTML page describing the given module to the given
streams.</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.html.HTMLFormatter-class.html#_write_module_list" class="summary-sig-name"><code>_write_module_list</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>public</span>,
<span class=summary-sig-arg>private</span>,
<span class=summary-sig-arg>container</span>,
<span class=summary-sig-arg>modules</span>)</span></code>
<br />
Write HTML code for a list of the submodules to the given streams.</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.html.HTMLFormatter-class.html#_write_module_toc" class="summary-sig-name"><code>_write_module_toc</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>public</span>,
<span class=summary-sig-arg>private</span>,
<span class=summary-sig-arg>uid</span>,
<span class=summary-sig-arg>doc</span>)</span></code>
<br />
Write an HTML page containing the table of contents page for the given
module to the given streams.</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.html.HTMLFormatter-class.html#_write_module_tree" class="summary-sig-name"><code>_write_module_tree</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>public</span>,
<span class=summary-sig-arg>private</span>)</span></code>
<br />
Write HTML code for a nested list showing the submodule relationships
between all documented packages and modules.</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.html.HTMLFormatter-class.html#_write_module_tree_item" class="summary-sig-name"><code>_write_module_tree_item</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>public</span>,
<span class=summary-sig-arg>private</span>,
<span class=summary-sig-arg>uid</span>,
<span class=summary-sig-arg>depth</span>)</span></code>
<br />
Write HTML for a list item describing a package/module and all of its
submodules.</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.html.HTMLFormatter-class.html#_write_navbar" class="summary-sig-name"><code>_write_navbar</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>public</span>,
<span class=summary-sig-arg>private</span>,
<span class=summary-sig-arg>where</span>)</span></code>
<br />
Write the HTML code for the navigation bar to the given streams.</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.html.HTMLFormatter-class.html#_write_project_toc" class="summary-sig-name"><code>_write_project_toc</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>public</span>,
<span class=summary-sig-arg>private</span>)</span></code>
<br />
Write an HTML page containing the table of contents page for the whole
project to the given streams.</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.html.HTMLFormatter-class.html#_write_property_details" class="summary-sig-name"><code>_write_property_details</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>public</span>,
<span class=summary-sig-arg>private</span>,
<span class=summary-sig-arg>container</span>,
<span class=summary-sig-arg>properties</span>,
<span class=summary-sig-arg>heading</span>)</span></code>
<br />
Write HTML code for a properties details section.</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.html.HTMLFormatter-class.html#_write_property_details_entry" class="summary-sig-name"><code>_write_property_details_entry</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>public</span>,
<span class=summary-sig-arg>private</span>,
<span class=summary-sig-arg>property</span>,
<span class=summary-sig-arg>container</span>)</span></code>
<br />
Write HTML code for an individual property in the properties details
section.</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.html.HTMLFormatter-class.html#_write_property_summary" class="summary-sig-name"><code>_write_property_summary</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>public</span>,
<span class=summary-sig-arg>private</span>,
<span class=summary-sig-arg>container</span>,
<span class=summary-sig-arg>properties</span>,
<span class=summary-sig-arg>heading</span>)</span></code>
<br />
Write HTML code for a property summary table.</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.html.HTMLFormatter-class.html#_write_property_summary_row" class="summary-sig-name"><code>_write_property_summary_row</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>public</span>,
<span class=summary-sig-arg>private</span>,
<span class=summary-sig-arg>property</span>,
<span class=summary-sig-arg>container</span>)</span></code>
<br />
Write HTML code for a row in the property summary table.</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.html.HTMLFormatter-class.html#_write_toc" class="summary-sig-name"><code>_write_toc</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>public</span>,
<span class=summary-sig-arg>private</span>)</span></code>
<br />
Write an HTML page containing the top-level table of contents.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_write_toc_section"></a><span class="summary-sig"><span class="summary-sig-name">_write_toc_section</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>public</span>,
<span class=summary-sig-arg>private</span>,
<span class=summary-sig-arg>section</span>,
<span class=summary-sig-arg>links</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.html.HTMLFormatter-class.html#_write_trees" class="summary-sig-name"><code>_write_trees</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>public</span>,
<span class=summary-sig-arg>private</span>)</span></code>
<br />
Write an HTML page containing the module and class hierarchies to the
given streams.</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.html.HTMLFormatter-class.html#_write_var_details" class="summary-sig-name"><code>_write_var_details</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>public</span>,
<span class=summary-sig-arg>private</span>,
<span class=summary-sig-arg>container</span>,
<span class=summary-sig-arg>vars</span>,
<span class=summary-sig-arg>heading</span>)</span></code>
<br />
Write HTML code for a variable details section.</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.html.HTMLFormatter-class.html#_write_var_summary" class="summary-sig-name"><code>_write_var_summary</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>public</span>,
<span class=summary-sig-arg>private</span>,
<span class=summary-sig-arg>container</span>,
<span class=summary-sig-arg>variables</span>,
<span class=summary-sig-arg>heading</span>)</span></code>
<br />
Write HTML code for a variable summary table.</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.html.HTMLFormatter-class.html#_write_var_summary_row" class="summary-sig-name"><code>_write_var_summary_row</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>public</span>,
<span class=summary-sig-arg>private</span>,
<span class=summary-sig-arg>var</span>,
<span class=summary-sig-arg>container</span>)</span></code>
<br />
Write HTML code for a row in the variable summary table.</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.html.HTMLFormatter-class.html#_create_private_docs"><code>_create_private_docs</code></a></b>: Whether or not to create documentation pages that include information
about private objects.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="../private/epydoc.html.HTMLFormatter-class.html#_css"><code>_css</code></a></b>: The name of a file containing a CSS stylesheet; or the name of a CSS
stylesheet.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><a href="epydoc.objdoc.DocMap-class.html"
class="link"><code>DocMap</code></a></font></td>
<td><b><a href="../private/epydoc.html.HTMLFormatter-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.html.HTMLFormatter-class.html#_frames_index"><code>_frames_index</code></a></b>: Whether or not to create a frames-based table of contents for the
documentation.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>string</code></font></td>
<td><b><a href="../private/epydoc.html.HTMLFormatter-class.html#_prj_name"><code>_prj_name</code></a></b>: A name for the documentation (for the navbar).</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>string</code></font></td>
<td><b><a href="../private/epydoc.html.HTMLFormatter-class.html#_prj_url"><code>_prj_url</code></a></b>: A URL for the documentation (for the navpar).</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="../private/epydoc.html.HTMLFormatter-class.html#_top_page"><code>_top_page</code></a></b>: The URI of the top page.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="../private/epydoc.html.HTMLFormatter-class.html#_variable_linelen"><code>_variable_linelen</code></a></b>: The maximum line length used for displaying the values of variables in
the variable details sections.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="../private/epydoc.html.HTMLFormatter-class.html#_variable_maxlines"><code>_variable_maxlines</code></a></b>: The maximum number of lines that should be displayed for the value of
a variable in the variable details section.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="../private/epydoc.html.HTMLFormatter-class.html#_variable_tooltip_linelen"><code>_variable_tooltip_linelen</code></a></b>: The maximum line length for variable value tooltips.</td></tr>
</table><br />
<!-- =========== START OF INSTANCE METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Instance 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 HTML 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>
</dl>
<dl><dt><b>Keyword Parameters:</b></dt>
<dd><code><b>prj_name</b></code> -
The name of the project. Defaults to none.
<br /><i>
(type=<code>string</code>)</i>
<dd><code><b>prj_url</b></code> -
The target for the project hopeage link on the navigation bar.
If <code>prj_url</code> is not specified, then no hyperlink is
created.
<br /><i>
(type=<code>string</code>)</i>
<dd><code><b>prj_link</b></code> -
The label for the project link on the navigation bar. This
link can contain arbitrary HTML code (e.g. images). By default, a
label is constructed from <code>prj_name</code>.
<br /><i>
(type=<code>string</code>)</i>
<dd><code><b>top</b></code> -
The top page for the documentation. This is the default page
shown main frame, when frames are enabled. <code>top</code> can
be a URL, the name of a module, the name of a class, or one of
the special strings <code>"trees.html"</code>,
<code>"indices.html"</code>, or
<code>"help.html"</code>. By default, the top-level
package or module is used, if there is one; otherwise,
<code>"trees"</code> is used.
<br /><i>
(type=<code>string</code>)</i>
<dd><code><b>css</b></code> -
The CSS stylesheet file. If <code>css</code> is a file name,
then the specified file's conents will be used. Otherwise, if
<code>css</code> is the name of a CSS stylesheet in <a
href="epydoc.css-module.html"
class="link"><code>epydoc.css</code></a>, then that stylesheet
will be used. Otherwise, an error is reported. If no stylesheet
is specified, then the default stylesheet is used.
<br /><i>
(type=<code>string</code>)</i>
<dd><code><b>private_css</b></code> -
The CSS stylesheet file for the private API documentation. If
<code>css</code> is a file name, then the specified file's
conents will be used. Otherwise, if <code>css</code> is the name
of a CSS stylesheet in <a href="epydoc.css-module.html"
class="link"><code>epydoc.css</code></a>, then that stylesheet
will be used. Otherwise, an error is reported. If no stylesheet
is specified, then the private API documentation will use the
same stylesheet as the public API documentation.
<br /><i>
(type=<code>string</code>)</i>
<dd><code><b>help</b></code> -
The name of the help file. If no help file is specified, then
the default help file will be used.
<br /><i>
(type=<code>string</code>)</i>
<dd><code><b>private</b></code> -
Whether to create documentation for private objects. By
default, private objects are documented.
<br /><i>
(type=<code>boolean</code>)</i>
<dd><code><b>frames</b></code> -
Whether to create a frames-based table of contents. By
default, it is produced.
<br /><i>
(type=<code>boolean</code>))</i>
<dd><code><b>show_imports</b></code> -
Whether or not to display lists of imported functions and
classes. By default, they are not shown.
<br /><i>
(type=<code>boolean</code>)</i>
<dd><code><b>index_parameters</b></code> -
Whether or not to include function parameters in the
identifier index. By default, they are not included.
<br /><i>
(type=<code>boolean</code>)</i>
<dd><code><b>variable_maxlines</b></code> -
The maximum number of lines that should be displayed for the
value of a variable in the variable details section. By default,
8 lines are displayed.
<br /><i>
(type=<code>int</code>)</i>
<dd><code><b>variable_linelength</b></code> -
The maximum line length used for displaying the values of
variables in the variable details sections. If a line is longer
than this length, then it will be wrapped to the next line. The
default line length is 70 characters.
<br /><i>
(type=<code>int</code>)</i>
<dd><code><b>variable_summary_linelength</b></code> -
The maximum line length used for displaying the values of
variables in the summary section. If a line is longer than this
length, then it will be truncated. The default is 40
characters.
<br /><i>
(type=<code>int</code>)</i>
<dd><code><b>variable_tooltip_linelength</b></code> -
The maximum line length used for tooltips for the values of
variables. If a line is longer than this length, then it will be
truncated. The default is 600 characters.
<br /><i>
(type=<code>int</code>)</i>
<dd><code><b>property_function_linelength</b></code> -
The maximum line length used to dispaly property functions
(<code>fget</code>, <code>fset</code>, and <code>fdel</code>)
that contain something other than a function object. The dfeault
length is 40 characters.
<br /><i>
(type=<code>int</code>)</i>
<dd><code><b>inheritance</b></code> -
How inherited objects should be displayed. If
<code>inheritance='grouped'</code>, then inherited objects are
gathered into groups; if <code>inheritance='listed'</code>, then
inherited objects are listed in a short list at the end of their
group; if <code>inheritance='included'</code>, then inherited
objects are mixed in with non-inherited objects. The default is
'grouped'.
<br /><i>
(type=<code>string</code>)</i>
</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>HTMLFormatter</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 documentation 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="_base_tree"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_base_tree</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>uid</span>,
<span class=sig-arg>width</span>=<span class=sig-default>None</span>,
<span class=sig-arg>postfix</span>=<span class=sig-default>''</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
The HTML code for a class's base tree. The tree is drawn
'upside-down' and right justified, to allow for multiple
inheritance.
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_breadcrumbs"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_breadcrumbs</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>uid</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>uid</b></code> -
The UID of the object whose ancestors should be listed.
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
The HTML code for a series of links to the ancestors of
<code>uid</code>.
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_descrlist"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_descrlist</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>items</span>,
<span class=sig-arg>singular</span>,
<span class=sig-arg>plural</span>=<span class=sig-default>None</span>,
<span class=sig-arg>short</span>=<span class=sig-default>0</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>items</b></code> -
The description items.
<br /><i>
(type=<code>list</code> of <code>string</code>)</i>
<dd><code><b>singular</b></code> -
The name of the list, if there is one element.
<dd><code><b>plural</b></code> -
The name of the list, if there are multiple elements.
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
The HTML code for a list of description items.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_docstring_to_html"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_docstring_to_html</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>docstring</span>,
<span class=sig-arg>uid</span>,
<span class=sig-arg>indent</span>=<span class=sig-default>0</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>uid</b></code>
<br /><i>
(type=<code>None</code> or <code>UID</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A string containing the HTML encoding for the given
<code>ParsedDocstring</code>
<br /><i>
(type=<a href="epydoc.markup.ParsedDocstring-class.html"
class="link"><code>markup.ParsedDocstring</code></a>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_documented"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_documented</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>uid</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
True if the given UID is documented by the documentation map
for this <code>HTMLFormatter</code>.
<br /><i>
(type=<code>boolean</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_extract_identifier_index"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_extract_identifier_index</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A list of the <code>UID</code>s of all objects and variables
documented by <code>_docmap</code>. This list is used by <a
href="../private/epydoc.html.HTMLFormatter-class.html#_write_indices"
class="link"><code>_write_indices</code></a> to construct the
identifier index.
<br /><i>
(type=<code>list</code> of <a href="epydoc.uid.UID-class.html"
class="link"><code>UID</code></a>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_extract_term_index"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_extract_term_index</span>(<span class=sig-arg>self</span>)</span>
</h3>
Extract the set of terms that should be indexed from all documented
docstrings. Return the extracted set as a list of tuples of the form
<code>(key, term, [links])</code>. This list is used by <a
href="../private/epydoc.html.HTMLFormatter-class.html#_write_indices"
class="link"><code>_write_indices</code></a> to construct the term
index.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>list</code> of <code>(string, <a
href="epydoc.markup.ParsedDocstring-class.html"
class="link"><code>markup.ParsedDocstring</code></a>, list of
Link)</code>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_find_top_page"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_find_top_page</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>pagename</span>)</span>
</h3>
Find the top page for the API documentation. This page is used as
the default page shown in the main frame, when frames are used. When
frames are not used, a redirect page is created from
<code>index.html</code> to the top page.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>pagename</b></code> -
The name of the page, as specified by the keyword argument
<code>top</code> to the constructor.
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
The URL of the top page.
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_find_toplevel"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_find_toplevel</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<p>The UID of the top-level module or package, or</p>
<code>None</code> if there is no top-level module or
package.
<br /><i>
(type=<a href="epydoc.uid.UID-class.html"
class="link"><code>UID</code></a> or <code>None</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_find_tree_width"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_find_tree_width</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>uid</span>)</span>
</h3>
Helper function for <a
href="../private/epydoc.html.HTMLFormatter-class.html#_base_tree"
class="link"><code>_base_tree</code></a>.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
The width of a base tree, when drawn right-justified. This is
used by <a
href="../private/epydoc.html.HTMLFormatter-class.html#_base_tree"
class="link"><code>_base_tree</code></a> to determine how far to
indent lines of the base tree.
<br /><i>
(type=<code>int</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_footer"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_footer</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
The HTML code for the footer of a page.
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_frames_link"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_frames_link</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>where</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>where</b></code> -
An identifier indiciating the page we're creating a navigation
bar for. This is either a UID or the name of a file without the
".html" extension.
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
HTML code for the frames/noframes selector. This selector is
used to turn the frames-based table of contents on or off.
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_func_details_entry"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_func_details_entry</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>function</span>,
<span class=sig-arg>container</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>function</b></code> -
The function that should be described by this entry.
<br /><i>
(type=<a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
The HTML code for an entry in the function details section.
Each entry gives a complete description of a documented
function.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_func_signature"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_func_signature</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>fname</span>,
<span class=sig-arg>fuid</span>,
<span class=sig-arg>fdoc</span>,
<span class=sig-arg>href</span>=<span class=sig-default>0</span>,
<span class=sig-arg>show_defaults</span>=<span class=sig-default>1</span>,
<span class=sig-arg>css_class</span>=<span class=sig-default>'sig'</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>fname</b></code> -
The short name of the function.
<br /><i>
(type=<code>string</code>)</i>
<dd><code><b>fuid</b></code> -
The UID of the function (used to generate the optional href
link).
<br /><i>
(type=<a href="epydoc.uid.UID-class.html"
class="link"><code>UID</code></a>)</i>
<dd><code><b>fdoc</b></code> -
The documentation for the function.
<br /><i>
(type=<a href="epydoc.objdoc.FuncDoc-class.html"
class="link"><code>objdoc.FuncDoc</code></a>)</i>
<dd><code><b>href</b></code> -
Whether to create an href link from the function's name to its
details description.
<dd><code><b>show_defaults</b></code> -
Whether or not to show default values for parameters.
<dd><code><b>css_class</b></code> -
The CSS class that should be used to mark the signature.
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
The HTML code for the function signature of the function with
the given name and documentation.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_get_index_terms"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_get_index_terms</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>parsed_docstring</span>,
<span class=sig-arg>link</span>,
<span class=sig-arg>terms</span>,
<span class=sig-arg>links</span>)</span>
</h3>
<p>A helper function for <a
href="../private/epydoc.html.HTMLFormatter-class.html#_extract_term_index"
class="link"><code>_extract_term_index</code></a>.</p>
For each index term <i class="math">t</i> with key <i
class="math">k</i> in <code>parsed_docstring</code>, modify
<code>terms</code> and <code>links</code> as follows:
<ul>
<li>
Set <code>terms[<i class="math">k</i>] = t</code> (if
<code>terms[<i class="math">k</i>]</code> doesn't exist).
</li>
<li>
Append <code>link</code> to <code>links[<i
class="math">k</i>]</code>.
</li>
</ul>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="_header"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_header</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>name</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
The HTML code for the header of a page with the given
name.
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_linewrap_html"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_linewrap_html</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>str</span>,
<span class=sig-arg>linelen</span>,
<span class=sig-arg>maxlines</span>)</span>
</h3>
Add line-wrapping to the HTML string <code>str</code>. Line length
is determined by <code>linelen</code>; and the maximum number of lines
to display is determined by <code>maxlines</code>. This function treats
HTML entities (e.g., <code>&amp;</code>) as single characters; and
ignores HTML tags (e.g., <code><p></code>).
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="_link_to_html"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_link_to_html</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>link</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>link</b></code>
<br /><i>
(type=<a href="epydoc.uid.Link-class.html"
class="link"><code>uid.Link</code></a>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
The HTML code for the given link. This code consists of an
anchor with an href to the page for the link's target, and with
text taken from the link's name. If the target is not documented,
then the HTML code will just contain the name, and no href.
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_mkdir"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_mkdir</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>directory</span>)</span>
</h3>
If the given directory does not exist, then attempt to create
it.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>None</code>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_param_to_html"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_param_to_html</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>param</span>,
<span class=sig-arg>show_defaults</span>,
<span class=sig-arg>css_class</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>show_defaults</b></code> -
Whether or not to show default values for parameters.
<dd><code><b>css_class</b></code> -
The CSS class that should be used to mark the signature.
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
The HTML code for a single parameter. Note that a single
parameter can consists of a sublist of parameters (although this
feature isn't often used). This is a helper function for <a
href="../private/epydoc.html.HTMLFormatter-class.html#_func_signature"
class="link"><code>_func_signature</code></a>.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_pprint_var_value"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_pprint_var_value</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>var</span>,
<span class=sig-arg>multiline</span>=<span class=sig-default>1</span>,
<span class=sig-arg>summary_linelen</span>=<span class=sig-default>0</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>var</b></code>
<br /><i>
(type=<a href="epydoc.objdoc.Var-class.html"
class="link"><code>Var</code></a>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A string representation of the value of the variable
<code>var</code>, suitable for use in a
<code><pre>...</pre></code> HTML block.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_property_in_public_details"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_property_in_public_details</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>puid</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
True if the given property should be shown in the public
version of the property details section.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_public_private_link"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_public_private_link</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>where</span>,
<span class=sig-arg>toc</span>=<span class=sig-default>0</span>,
<span class=sig-arg>from_private</span>=<span class=sig-default>0</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>where</b></code> -
An identifier indiciating the page we're creating a navigation
bar for. This is either a UID or the name of a file without the
".html" extension.
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
HTML code for the show/hide private selector. This selector is
used to select whether private objects should be displayed.
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_split_classes"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_split_classes</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>classes_and_excepts</span>)</span>
</h3>
Divide the classes fromt the given module into exceptions and
non-exceptions. This is used by <a
href="../private/epydoc.html.HTMLFormatter-class.html#_write_module"
class="link"><code>_write_module</code></a> to list exceptions and
non-exceptions separately.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>classes_and_excepts</b></code> -
The list of classes to split up.
<br /><i>
(type=<code>list</code> of <a
href="epydoc.uid.Link-class.html"
class="link"><code>uid.Link</code></a>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A list <code>(<i>classes</i>, <i>excepts</i>)</code>, where
<code><i>classes</i></code> is the list of non-exception classes,
and <code><i>excepts</i></code> is the list of exception
classes.
<br /><i>
(type=<code>pair</code> of <code>list</code> of <a
href="epydoc.uid.Link-class.html"
class="link"><code>uid.Link</code></a>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_standard_field_values"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_standard_field_values</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>doc</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A list of epytext field values that includes all fields that
are common to all <a href="epydoc.objdoc.ObjDoc-class.html"
class="link"><code>ObjDoc</code></a>s.
<code>_standard_field_values</code> is used by <a
href="../private/epydoc.html.HTMLFormatter-class.html#_extract_term_index"
class="link"><code>_extract_term_index</code></a>.
<br /><i>
(type=<code>list</code> of <a
href="epydoc.markup.ParsedDocstring-class.html"
class="link"><code>markup.ParsedDocstring</code></a>)</i>
</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="_start_of"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_start_of</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>heading</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>heading</b></code> -
The name of the section that is starting.
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
The HTML code for a 'start-of' comment. These comments are
used to deliniate sections of the HTML output.
<br /><i>
(type=<code>string</code>)</i>
</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>uid</span>,
<span class=sig-arg>indent</span>=<span class=sig-default>0</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>uid</b></code>
<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 HTML 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="_table_header"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_table_header</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>heading</span>,
<span class=sig-arg>css_class</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>heading</b></code> -
The name for the table.
<br /><i>
(type=<code>string</code>)</i>
<dd><code><b>css_class</b></code> -
The css class for the table. This is used to allow different
tables to be given different styles. Currently, the following
classes are used: <code>'summary'</code>; <code>'details'</code>;
and <code>'index'</code>.
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
The HTML code for the start of a table. This is used by class
tables, function tables, variable tables, etc.
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_term_index_to_anchor"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_term_index_to_anchor</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>term</span>)</span>
</h3>
Given the name of an inline index item, construct a URI anchor.
These anchors are used to create links from the index page to each
index item.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="_uid_to_href"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_uid_to_href</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>uid</span>,
<span class=sig-arg>label</span>=<span class=sig-default>None</span>,
<span class=sig-arg>css_class</span>=<span class=sig-default>None</span>,
<span class=sig-arg>code</span>=<span class=sig-default>1</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>uid</b></code>
<br /><i>
(type=<a href="epydoc.uid.UID-class.html"
class="link"><code>uid.UID</code></a>)</i>
<dd><code><b>label</b></code>
<br /><i>
(type=<code>string</code>)</i>
<dd><code><b>code</b></code> -
Whether or not to include
<code><code>...</code></code> tags around the
label.
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
The HTML code to link to the given UID. This code consists of
an anchor with an href to the page for <code>uid</code>. If
<code>label</code> is not <code>None</code>, then it is used as
the text for the link; otherwise, <code>uid</code> is used as the
text. If <code>uid</code> is not documented, then the HTML code
will just contain the name, and no href.
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_uid_to_uri"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_uid_to_uri</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>uid</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>uid</b></code> -
A unique identifier for the object.
<br /><i>
(type=<a href="epydoc.uid.UID-class.html"
class="link"><code>UID</code></a>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
a URI that points to the description of the object identified
by <code>uid</code>.
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_var_details_entry"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_var_details_entry</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>var</span>,
<span class=sig-arg>container</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>var</b></code> -
The variable that should be described.
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
The HTML code for an entry in the variable details section.
Each entry gives a complete description of a documented
variable.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_var_value_tooltip"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_var_value_tooltip</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>var</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>var</b></code>
<br /><i>
(type=<a href="epydoc.objdoc.Var-class.html"
class="link"><code>Var</code></a>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A string representation of the value of the variable
<code>var</code>, suitable for use in a tooltip. In particular,
use <code>repr</code> to convert the var to a string; truncate it
to <a
href="../private/epydoc.html.HTMLFormatter-class.html#_variable_tooltip_linelen"
class="link"><code>_variable_tooltip_linelen</code></a>; and
convert it to HTML.
</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>write_func</span>,
<span class=sig-arg>directory</span>,
<span class=sig-arg>filename</span>,
<span class=sig-arg>progress_callback</span>,
<span class=sig-arg>is_public</span>,
<span class="sig-vararg">*args</span>)</span>
</h3>
A helper for <a href="epydoc.html.HTMLFormatter-class.html#write"
class="link"><code>write</code></a>, that creates new public and
private streams for a given filename, and delegates writing to
<code>write_func</code>. If <a
href="../private/epydoc.html.HTMLFormatter-class.html#_create_private_docs"
class="link"><code>_create_private_docs</code></a> is true, then the
streams are created in the <code>'public'</code> and
<code>'private'</code> subdirectories of <code>directory</code>. If
it's false, then the public stream is created in
<code>directory</code>, and a <a
href="../private/epydoc.html._DevNull-class.html"
class="link"><code>_DevNull</code></a> is used for the private
stream.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>write_func</b></code> -
The output function to delegate to. It is called with a public
stream, a private stream, and any arguments given in
<code>args</code>.
<dd><code><b>directory</b></code> -
The base directory for the output files
<dd><code><b>filename</b></code> -
The filename of the file(s) that <code>write_func</code>
should write to.
<dd><code><b>progress_callback</b></code> -
A progress callback function. If it is not <code>None</code>,
then it is called with <code>filename</code> before
<code>write_func</code> is called.
<dd><code><b>is_public</b></code> -
Whether this is a public page. If it is not a public page,
then a <code>_DevNull</code> will be used for the public stream.
(Or if it is not a public page and
<code>_create_private_docs</code> is false, then immediately
return.)
<dd><code><b>args</b></code> -
Extra arguments for <code>write_func</code>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>None</code>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_write_breadcrumbs"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_write_breadcrumbs</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>public</span>,
<span class=sig-arg>private</span>,
<span class=sig-arg>where</span>=<span class=sig-default>None</span>)</span>
</h3>
Write the HTML code for the breadcrumbs line to the given streams.
The breadcrumbs line is an invisible table with a list of pointers to
the current object's ancestors on the left; and the show/hide private
selector and the frames/noframes selector on the right.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>public</b></code> -
The output stream for the public version of the page.
<dd><code><b>private</b></code> -
The output stream for the private version of the page.
<dd><code><b>where</b></code> -
An identifier indicating what page we're creating a navigation
bar for. This is either a UID (for an object documentation page);
or a string. If it is a UID, then a list of pointers to its
ancestors is displayed.
</dd>
</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>public</span>,
<span class=sig-arg>private</span>,
<span class=sig-arg>uid</span>,
<span class=sig-arg>doc</span>,
<span class=sig-arg>body_only</span>=<span class=sig-default>0</span>)</span>
</h3>
Write an HTML page describing the given module to the given
streams.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>public</b></code> -
The output stream for the public version of the page.
<dd><code><b>private</b></code> -
The output stream for the private version of the page.
<dd><code><b>uid</b></code> -
The UID of the module to document.
<dd><code><b>doc</b></code> -
The <a href="epydoc.objdoc.ModuleDoc-class.html"
class="link"><code>ModuleDoc</code></a> of the module to
document.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_write_class_summary"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_write_class_summary</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>public</span>,
<span class=sig-arg>private</span>,
<span class=sig-arg>container</span>,
<span class=sig-arg>classes</span>,
<span class=sig-arg>heading</span>=<span class=sig-default>'Class Summary'</span>)</span>
</h3>
Write HTML code for a class summary table. This is used by <a
href="../private/epydoc.html.HTMLFormatter-class.html#_write_module"
class="link"><code>_write_module</code></a> to list the classes in a
module.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>public</b></code> -
The output stream for the public version of the page.
<dd><code><b>private</b></code> -
The output stream for the private version of the page.
<dd><code><b>container</b></code> -
The module that contains the classes. <code>container</code>
is used to group the classes.
<dd><code><b>classes</b></code> -
The classes that should be included in the list.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_write_class_summary_row"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_write_class_summary_row</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>public</span>,
<span class=sig-arg>private</span>,
<span class=sig-arg>link</span>)</span>
</h3>
Write HTML code for a row in the class summary table. Each row gives
the name and summary of a single class.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>public</b></code> -
The output stream for the public version of the page.
<dd><code><b>private</b></code> -
The output stream for the private version of the page.
<dd><code><b>link</b></code> -
A link to the class that should be described by this row.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_write_class_tree"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_write_class_tree</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>public</span>,
<span class=sig-arg>private</span>)</span>
</h3>
Write HTML code for a nested list showing the base/subclass
relationships between all documented classes. Each element of the
top-level list is a class with no (documented) bases; and under each
class is listed all of its subclasses. Note that in the case of
multiple inheritance, a class may appear multiple times. This is used
by <a
href="../private/epydoc.html.HTMLFormatter-class.html#_write_trees"
class="link"><code>_write_trees</code></a> to write the class
hierarchy.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>public</b></code> -
The output stream for the public version of the page.
<dd><code><b>private</b></code> -
The output stream for the private version of the page.
</dd>
</dl>
<p><b>Bug:</b> This function does not list public subclasses of private bases.
</p>
<p><b>To Do:</b> For multiple inheritance, don't repeat subclasses the second time a
class is mentioned; instead, link to the first mention.
</p>
</dd></dl>
</td></tr></table>
<a name="_write_class_tree_item"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_write_class_tree_item</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>public</span>,
<span class=sig-arg>private</span>,
<span class=sig-arg>uid</span>,
<span class=sig-arg>depth</span>=<span class=sig-default>2</span>,
<span class=sig-arg>public_base</span>=<span class=sig-default>1</span>)</span>
</h3>
Write HTML code for a list item describing a class and all of its
subclasses. This is used by <a
href="../private/epydoc.html.HTMLFormatter-class.html#_write_class_tree"
class="link"><code>_write_class_tree</code></a> to write the class
hierarchy.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>public</b></code> -
The output stream for the public version of the page.
<dd><code><b>private</b></code> -
The output stream for the private version of the page.
<dd><code><b>uid</b></code> -
The <code>UID</code> of the class tree to describe
<dd><code><b>depth</b></code> -
The indentation depth.
<dd><code><b>public_base</b></code> -
True if output should be generated for the public stream. This
is prevents public classes with private bases from being
listed.
</dd>
</dl>
<p><b>Bug:</b> This doesn't generate </li> close tags.
</p>
</dd></dl>
</td></tr></table>
<a name="_write_css"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_write_css</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>directory</span>,
<span class=sig-arg>cssname</span>)</span>
</h3>
Write the CSS stylesheet in the given directory. If
<code>cssname</code> contains a stylesheet file or name (from <a
href="epydoc.css-module.html"
class="link"><code>epydoc.css</code></a>), then use that stylesheet;
otherwise, if a stylesheet file already exists, use that stylesheet.
Otherwise, use the default stylesheet.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>None</code>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_write_frames"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_write_frames</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>public</span>,
<span class=sig-arg>private</span>)</span>
</h3>
Write the frames index file for the frames-based table of contents
to the given streams.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>public</b></code> -
The output stream for the public version of the page.
<dd><code><b>private</b></code> -
The output stream for the private version of the page.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_write_func_details"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_write_func_details</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>public</span>,
<span class=sig-arg>private</span>,
<span class=sig-arg>container</span>,
<span class=sig-arg>functions</span>,
<span class=sig-arg>heading</span>=<span class=sig-default>'Function Details'</span>)</span>
</h3>
Write HTML code for a function details section. This is used by <a
href="../private/epydoc.html.HTMLFormatter-class.html#_write_module"
class="link"><code>_write_module</code></a> to describe the functions
in a module; and by <a
href="../private/epydoc.html.HTMLFormatter-class.html#_write_class"
class="link"><code>_write_class</code></a> to describe the methods in a
class.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>public</b></code> -
The output stream for the public version of the page.
<dd><code><b>private</b></code> -
The output stream for the private version of the page.
<dd><code><b>container</b></code> -
The module or class that contains the functions.
<code>container</code> is used to group the functions.
<dd><code><b>functions</b></code> -
The functions that should be included in the section.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_write_func_summary"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_write_func_summary</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>public</span>,
<span class=sig-arg>private</span>,
<span class=sig-arg>container</span>,
<span class=sig-arg>functions</span>,
<span class=sig-arg>heading</span>=<span class=sig-default>'Function Summary'</span>)</span>
</h3>
Write HTML code for a function summary table. This is used by <a
href="../private/epydoc.html.HTMLFormatter-class.html#_write_module"
class="link"><code>_write_module</code></a> to list the functions in a
module; and by <a
href="../private/epydoc.html.HTMLFormatter-class.html#_write_class"
class="link"><code>_write_class</code></a> to list the methods in a
class.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>public</b></code> -
The output stream for the public version of the page.
<dd><code><b>private</b></code> -
The output stream for the private version of the page.
<dd><code><b>container</b></code> -
The module or class that contains the functions.
<code>container</code> is used to group the functions.
<dd><code><b>functions</b></code> -
The functions that should be included in the list.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_write_func_summary_row"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_write_func_summary_row</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>public</span>,
<span class=sig-arg>private</span>,
<span class=sig-arg>function</span>,
<span class=sig-arg>container</span>)</span>
</h3>
Write HTML code for a row in the function summary table. Each row
gives a breif description of a single function.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>public</b></code> -
The output stream for the public version of the page.
<dd><code><b>private</b></code> -
The output stream for the private version of the page.
<dd><code><b>function</b></code> -
The function that should be described by this row.
<br /><i>
(type=<a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_write_help"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_write_help</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>public</span>,
<span class=sig-arg>private</span>)</span>
</h3>
Write an HTML help file to the given streams. If
<code>self._helpfile</code> contains a help file, then use it;
otherwise, use the default helpfile from <a
href="epydoc.help-module.html"
class="link"><code>epydoc.help</code></a>.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>public</b></code> -
The output stream for the public version of the page.
<dd><code><b>private</b></code> -
The output stream for the private version of the page.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_write_index"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_write_index</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>directory</span>,
<span class=sig-arg>frombase</span>)</span>
</h3>
Write an <code>index.html</code> file in the given directory. The
contents of this file are copied or linked from an existing page. The
page used is determined by <a
href="../private/epydoc.html.HTMLFormatter-class.html#_frames_index"
class="link"><code>_frames_index</code></a> and <a
href="../private/epydoc.html.HTMLFormatter-class.html#_top_page"
class="link"><code>_top_page</code></a>:
<ul>
<li>
If <a
href="../private/epydoc.html.HTMLFormatter-class.html#_frames_index"
class="link"><code>_frames_index</code></a> is true, then
<code>frames.html</code> is copied.
</li>
<li>
Otherwise, the page specified by <a
href="../private/epydoc.html.HTMLFormatter-class.html#_top_page"
class="link"><code>_top_page</code></a> is copied.
</li>
</ul>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>frombase</b></code> -
True if this is the index file for the base directory when we
are generating both public and private documentation. In this
case, all local hyperlinks should be changed to point into the
<code>public</code> subdirectory.
<br /><i>
(type=<code>boolean</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_write_indices"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_write_indices</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>public</span>,
<span class=sig-arg>private</span>)</span>
</h3>
Write an HTML page containing the term and identifier indices to the
given streams.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>public</b></code> -
The output stream for the public version of the page.
<dd><code><b>private</b></code> -
The output stream for the private version of the page.
</dd>
</dl>
<p><b>Bug:</b> If there are private indexed terms, but no public indexed terms, then
this function will still write a header for the Term Index to the public
stream.
</p>
</dd></dl>
</td></tr></table>
<a name="_write_inheritance_list"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_write_inheritance_list</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>public</span>,
<span class=sig-arg>private</span>,
<span class=sig-arg>links</span>,
<span class=sig-arg>cls</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>links</b></code> -
The set of member objects of <code>cls</code> that should be
listed by ancestor.
<br /><i>
(type=<code>list</code> of <a
href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>)</i>
<dd><code><b>cls</b></code> -
The UID of the class whose inherited objects should be
listed.
<br /><i>
(type=<a href="epydoc.uid.UID-class.html"
class="link"><code>UID</code></a>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A string containing HTML that lists all objects from that were
inherited from a base ancestor of <code>cls</code>. Only the
objects linked to from one of the links in <code>links</code> are
considered. The HTML lists the objects in one row of a table,
grouped by ancestor.
</dd>
</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>public</span>,
<span class=sig-arg>private</span>,
<span class=sig-arg>uid</span>,
<span class=sig-arg>doc</span>,
<span class=sig-arg>body_only</span>=<span class=sig-default>0</span>)</span>
</h3>
Write an HTML page describing the given module to the given
streams.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>public</b></code> -
The output stream for the public version of the page.
<dd><code><b>private</b></code> -
The output stream for the private version of the page.
<dd><code><b>uid</b></code> -
The UID of the module to document.
<dd><code><b>doc</b></code> -
The <a href="epydoc.objdoc.ModuleDoc-class.html"
class="link"><code>ModuleDoc</code></a> of the module to
document.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_write_module_list"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_write_module_list</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>public</span>,
<span class=sig-arg>private</span>,
<span class=sig-arg>container</span>,
<span class=sig-arg>modules</span>)</span>
</h3>
Write HTML code for a list of the submodules to the given streams.
This is used by <a
href="../private/epydoc.html.HTMLFormatter-class.html#_write_module"
class="link"><code>_write_module</code></a> to list the submodules in a
package.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>public</b></code> -
The output stream for the public version of the page.
<dd><code><b>private</b></code> -
The output stream for the private version of the page.
<dd><code><b>container</b></code> -
The package that contains the modules (as submodules).
<code>container</code> is used to group the modules.
<dd><code><b>modules</b></code> -
The modules that should be included in the list.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_write_module_toc"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_write_module_toc</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>public</span>,
<span class=sig-arg>private</span>,
<span class=sig-arg>uid</span>,
<span class=sig-arg>doc</span>)</span>
</h3>
Write an HTML page containing the table of contents page for the
given module to the given streams. This page lists the modules,
classes, exceptions, functions, and variables defined by the
module.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>public</b></code> -
The output stream for the public version of the page.
<dd><code><b>private</b></code> -
The output stream for the private version of the page.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_write_module_tree"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_write_module_tree</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>public</span>,
<span class=sig-arg>private</span>)</span>
</h3>
Write HTML code for a nested list showing the submodule
relationships between all documented packages and modules. This is used
by <a
href="../private/epydoc.html.HTMLFormatter-class.html#_write_trees"
class="link"><code>_write_trees</code></a> to write the module
hierarchy.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>public</b></code> -
The output stream for the public version of the page.
<dd><code><b>private</b></code> -
The output stream for the private version of the page.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_write_module_tree_item"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_write_module_tree_item</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>public</span>,
<span class=sig-arg>private</span>,
<span class=sig-arg>uid</span>,
<span class=sig-arg>depth</span>=<span class=sig-default>0</span>)</span>
</h3>
Write HTML for a list item describing a package/module and all of
its submodules. This is used by both <a
href="../private/epydoc.html.HTMLFormatter-class.html#_write_module_tree"
class="link"><code>_write_module_tree</code></a> and <a
href="../private/epydoc.html.HTMLFormatter-class.html#_write_module_list"
class="link"><code>_write_module_list</code></a> to write package
hierarchies.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>public</b></code> -
The output stream for the public version of the page.
<dd><code><b>private</b></code> -
The output stream for the private version of the page.
<dd><code><b>uid</b></code> -
The <code>UID</code> of the module to describe
<dd><code><b>depth</b></code> -
The indentation depth.
</dd>
</dl>
<p><b>Bug:</b> This doesn't generate </li> close tags.
</p>
</dd></dl>
</td></tr></table>
<a name="_write_navbar"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_write_navbar</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>public</span>,
<span class=sig-arg>private</span>,
<span class=sig-arg>where</span>=<span class=sig-default>None</span>)</span>
</h3>
Write the HTML code for the navigation bar to the given streams. The
navigation bar typically looks like:
<pre class="literalblock">
[ Home Trees Index Help Project ]
</pre>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>public</b></code> -
The output stream for the public version of the page.
<dd><code><b>private</b></code> -
The output stream for the private version of the page.
<dd><code><b>where</b></code> -
An identifier indicating what page we're creating a navigation
bar for. This is either a UID (for an object documentation page);
or one of the strings <code>'tree'</code>, <code>'index'</code>,
and <code>'help'</code>.
<br /><i>
(type=<code>UID</code> or <code>string</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_write_project_toc"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_write_project_toc</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>public</span>,
<span class=sig-arg>private</span>)</span>
</h3>
Write an HTML page containing the table of contents page for the
whole project to the given streams. This page lists the classes,
exceptions, functions, and variables defined by any module or package
in the project.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>public</b></code> -
The output stream for the public version of the page.
<dd><code><b>private</b></code> -
The output stream for the private version of the page.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_write_property_details"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_write_property_details</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>public</span>,
<span class=sig-arg>private</span>,
<span class=sig-arg>container</span>,
<span class=sig-arg>properties</span>,
<span class=sig-arg>heading</span>=<span class=sig-default>'Property Details'</span>)</span>
</h3>
Write HTML code for a properties details section. This is used by <a
href="../private/epydoc.html.HTMLFormatter-class.html#_write_class"
class="link"><code>_write_class</code></a> to describe the properties
in a class.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>public</b></code> -
The output stream for the public version of the page.
<dd><code><b>private</b></code> -
The output stream for the private version of the page.
<dd><code><b>container</b></code> -
The or class that contains the properties.
<code>container</code> is used to group the functions.
<dd><code><b>properties</b></code> -
The properties that should be included in the section.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_write_property_details_entry"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_write_property_details_entry</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>public</span>,
<span class=sig-arg>private</span>,
<span class=sig-arg>property</span>,
<span class=sig-arg>container</span>)</span>
</h3>
Write HTML code for an individual property in the properties details
section. This is used by <a
href="../private/epydoc.html.HTMLFormatter-class.html#_write_property_details"
class="link"><code>_write_property_details</code></a>.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>public</b></code> -
The output stream for the public version of the page.
<dd><code><b>private</b></code> -
The output stream for the private version of the page.
<dd><code><b>property</b></code> -
The property that should be described by this entry.
<br /><i>
(type=<a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_write_property_summary"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_write_property_summary</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>public</span>,
<span class=sig-arg>private</span>,
<span class=sig-arg>container</span>,
<span class=sig-arg>properties</span>,
<span class=sig-arg>heading</span>=<span class=sig-default>'Property Summary'</span>)</span>
</h3>
Write HTML code for a property summary table. This is used by <a
href="../private/epydoc.html.HTMLFormatter-class.html#_write_class"
class="link"><code>_write_class</code></a> to list the properties in a
class.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>public</b></code> -
The output stream for the public version of the page.
<dd><code><b>private</b></code> -
The output stream for the private version of the page.
<dd><code><b>container</b></code> -
The module or class that contains the properties.
<code>container</code> is used to group the properties.
<dd><code><b>properties</b></code> -
The properties that should be included in the list.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_write_property_summary_row"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_write_property_summary_row</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>public</span>,
<span class=sig-arg>private</span>,
<span class=sig-arg>property</span>,
<span class=sig-arg>container</span>)</span>
</h3>
Write HTML code for a row in the property summary table. Each row
gives a brief description of a single property.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>public</b></code> -
The output stream for the public version of the page.
<dd><code><b>private</b></code> -
The output stream for the private version of the page.
<dd><code><b>property</b></code> -
The property that should be described by this row.
<br /><i>
(type=<a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_write_toc"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_write_toc</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>public</span>,
<span class=sig-arg>private</span>)</span>
</h3>
Write an HTML page containing the top-level table of contents. This
page is used to select a module table of contents page, or the
"everything" table of contents page.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>public</b></code> -
The output stream for the public version of the page.
<dd><code><b>private</b></code> -
The output stream for the private version of the page.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_write_trees"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_write_trees</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>public</span>,
<span class=sig-arg>private</span>)</span>
</h3>
Write an HTML page containing the module and class hierarchies to
the given streams.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>public</b></code> -
The output stream for the public version of the page.
<dd><code><b>private</b></code> -
The output stream for the private version of the page.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_write_var_details"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_write_var_details</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>public</span>,
<span class=sig-arg>private</span>,
<span class=sig-arg>container</span>,
<span class=sig-arg>vars</span>,
<span class=sig-arg>heading</span>=<span class=sig-default>'Variable Details'</span>)</span>
</h3>
Write HTML code for a variable details section. This is used by <a
href="../private/epydoc.html.HTMLFormatter-class.html#_write_module"
class="link"><code>_write_module</code></a> to describe the variables
in a module; and by <a
href="../private/epydoc.html.HTMLFormatter-class.html#_write_class"
class="link"><code>_write_class</code></a> to describe the instance and
class variables in a class.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>public</b></code> -
The output stream for the public version of the page.
<dd><code><b>private</b></code> -
The output stream for the private version of the page.
<dd><code><b>container</b></code> -
The module or class that contains the variables.
<code>container</code> is used to group the properties.
<dd><code><b>vars</b></code> -
The variables that should be included in the section.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_write_var_summary"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_write_var_summary</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>public</span>,
<span class=sig-arg>private</span>,
<span class=sig-arg>container</span>,
<span class=sig-arg>variables</span>,
<span class=sig-arg>heading</span>=<span class=sig-default>'Variable Summary'</span>)</span>
</h3>
Write HTML code for a variable summary table. This is used by <a
href="../private/epydoc.html.HTMLFormatter-class.html#_write_module"
class="link"><code>_write_module</code></a> to list the variables in a
module; and by <a
href="../private/epydoc.html.HTMLFormatter-class.html#_write_class"
class="link"><code>_write_class</code></a> to list the instance and
class variables in a class.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>public</b></code> -
The output stream for the public version of the page.
<dd><code><b>private</b></code> -
The output stream for the private version of the page.
<dd><code><b>container</b></code> -
The module or class that contains the variables.
<code>container</code> is used to group the properties.
<dd><code><b>variables</b></code> -
The variables that should be included in the list.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_write_var_summary_row"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_write_var_summary_row</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>public</span>,
<span class=sig-arg>private</span>,
<span class=sig-arg>var</span>,
<span class=sig-arg>container</span>)</span>
</h3>
Write HTML code for a row in the variable summary table. Each row
gives a brief description of a single variable.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>public</b></code> -
The output stream for the public version of the page.
<dd><code><b>private</b></code> -
The output stream for the private version of the page.
<dd><code><b>var</b></code> -
The variable that should be described by this row.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF STATIC METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Static Method Details</th></tr>
</table>
<a name="format"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">format</span>(<span class=sig-arg>object</span>,
<span class=sig-arg>error_stream</span>=<span class=sig-default>None</span>,
<span class=sig-arg>show_private</span>=<span class=sig-default>1</span>,
<span class=sig-arg>body_only</span>=<span class=sig-default>1</span>,
<span class="sig-kwarg">**options</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>object</b></code> -
The object to document. <code>object</code> can be a module, a
class, a function, a method, or a property; or it can be the <a
href="epydoc.uid.UID-class.html"
class="link"><code>UID</code></a> of any object; or it can be a
<a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a> to any object.
<dd><code><b>error_stream</b></code> -
A file or stream where errors and warnings will be written. If
<code>error_stream</code> is unspecified, then warnings and
errors are discarded.
<dd><code><b>show_private</b></code> -
If true, then include private objects in the output; if false,
then only include public objects.
<dd><code><b>body_only</b></code> -
If true, then don't include navigation bars and breadcrumbs
when generating the HTML documentation for a module or a class.
If false, then do include them.
<dd><code><b>options</b></code> -
Options for the <code>HTMLFormatter</code> object that will be
used to generate the HTML. See <a
href="epydoc.html.HTMLFormatter-class.html#__init__"
class="link"><code>HTMLFormatter.__init__</code></a> for a
complete list of options.
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A string containing the HTML documentation for the given
object.
</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="_create_private_docs"></a>
<h3>_create_private_docs</h3>
Whether or not to create documentation pages that include information
about private objects.
</td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_css"></a>
<h3>_css</h3>
The name of a file containing a CSS stylesheet; or the name of a CSS
stylesheet.
</td></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.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<a href="epydoc.objdoc.DocMap-class.html"
class="link"><code>DocMap</code></a>
</dd>
</dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_frames_index"></a>
<h3>_frames_index</h3>
Whether or not to create a frames-based table of contents for the
documentation.
</td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_prj_name"></a>
<h3>_prj_name</h3>
A name for the documentation (for the navbar).
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>string</code>
</dd>
</dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_prj_url"></a>
<h3>_prj_url</h3>
A URL for the documentation (for the navpar).
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>string</code>
</dd>
</dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_top_page"></a>
<h3>_top_page</h3>
The URI of the top page. This is the page shown in the main frame by
the frames index; and the page that is used as the noframes index.
</td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_variable_linelen"></a>
<h3>_variable_linelen</h3>
The maximum line length used for displaying the values of variables in
the variable details sections.
</td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_variable_maxlines"></a>
<h3>_variable_maxlines</h3>
The maximum number of lines that should be displayed for the value of
a variable in the variable details section.
</td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_variable_tooltip_linelen"></a>
<h3>_variable_tooltip_linelen</h3>
The maximum line length for variable value tooltips.
</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:11 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>
|
