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
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
|
<?xml version="1.0" encoding="ascii"?>
<!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.docwriter.html</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="epydoc-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="epydoc-module.html">Package epydoc</a> ::
<a href="epydoc.docwriter-module.html">Package docwriter</a> ::
Module html
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="epydoc.docwriter.html-pysrc.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<h1 class="epydoc">Source Code for <a href="epydoc.docwriter.html-module.html">Module epydoc.docwriter.html</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># epydoc -- HTML output generator</tt> </tt>
<a name="L3"></a><tt class="py-lineno"> 3</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Edward Loper</tt> </tt>
<a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#</tt> </tt>
<a name="L5"></a><tt class="py-lineno"> 5</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Created [01/30/01 05:18 PM]</tt> </tt>
<a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># $Id: html.py 1674 2008-01-29 06:03:36Z edloper $</tt> </tt>
<a name="L7"></a><tt class="py-lineno"> 7</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#</tt> </tt>
<a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L9"></a><tt class="py-lineno"> 9</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L10"></a><tt class="py-lineno"> 10</tt> <tt class="py-line"><tt class="py-docstring">The HTML output generator for epydoc. The main interface provided by</tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt> <tt class="py-line"><tt class="py-docstring">this module is the L{HTMLWriter} class.</tt> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt> <tt class="py-line"><tt class="py-docstring">@todo: Add a cache to L{HTMLWriter.url()}?</tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L15"></a><tt class="py-lineno"> 15</tt> <tt class="py-line"><tt class="py-name">__docformat__</tt> <tt class="py-op">=</tt> <tt class="py-string">'epytext en'</tt> </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt> <tt class="py-line"> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">re</tt><tt class="py-op">,</tt> <tt class="py-name">os</tt><tt class="py-op">,</tt> <tt class="py-name">sys</tt><tt class="py-op">,</tt> <tt class="py-name">codecs</tt><tt class="py-op">,</tt> <tt class="py-name">sre_constants</tt><tt class="py-op">,</tt> <tt class="py-name">pprint</tt><tt class="py-op">,</tt> <tt class="py-name">base64</tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">urllib</tt> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">__builtin__</tt> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-0" class="py-name" targets="Package epydoc=epydoc-module.html"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-0', 'epydoc', 'link-0');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-1" class="py-name" targets="Module epydoc.apidoc=epydoc.apidoc-module.html"><a title="epydoc.apidoc" class="py-name" href="#" onclick="return doclink('link-1', 'apidoc', 'link-1');">apidoc</a></tt> <tt class="py-keyword">import</tt> <tt class="py-op">*</tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt id="link-2" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-2', 'epydoc', 'link-0');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-3" class="py-name" targets="Module epydoc.docstringparser=epydoc.docstringparser-module.html"><a title="epydoc.docstringparser" class="py-name" href="#" onclick="return doclink('link-3', 'docstringparser', 'link-3');">docstringparser</a></tt> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">time</tt><tt class="py-op">,</tt> <tt id="link-4" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-4', 'epydoc', 'link-0');">epydoc</a></tt><tt class="py-op">,</tt> <tt id="link-5" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-5', 'epydoc', 'link-0');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-6" class="py-name" targets="Package epydoc.markup=epydoc.markup-module.html,Method epydoc.markup.doctest.DoctestColorizer.markup()=epydoc.markup.doctest.DoctestColorizer-class.html#markup,Method epydoc.markup.doctest.HTMLDoctestColorizer.markup()=epydoc.markup.doctest.HTMLDoctestColorizer-class.html#markup,Method epydoc.markup.doctest.LaTeXDoctestColorizer.markup()=epydoc.markup.doctest.LaTeXDoctestColorizer-class.html#markup,Method epydoc.markup.doctest.XMLDoctestColorizer.markup()=epydoc.markup.doctest.XMLDoctestColorizer-class.html#markup"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-6', 'markup', 'link-6');">markup</a></tt><tt class="py-op">,</tt> <tt id="link-7" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-7', 'epydoc', 'link-0');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-8" class="py-name"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-8', 'markup', 'link-6');">markup</a></tt><tt class="py-op">.</tt><tt id="link-9" class="py-name" targets="Module epydoc.markup.epytext=epydoc.markup.epytext-module.html"><a title="epydoc.markup.epytext" class="py-name" href="#" onclick="return doclink('link-9', 'epytext', 'link-9');">epytext</a></tt> </tt>
<a name="L23"></a><tt class="py-lineno"> 23</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-10" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-10', 'epydoc', 'link-0');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-11" class="py-name" targets="Package epydoc.docwriter=epydoc.docwriter-module.html"><a title="epydoc.docwriter" class="py-name" href="#" onclick="return doclink('link-11', 'docwriter', 'link-11');">docwriter</a></tt><tt class="py-op">.</tt><tt id="link-12" class="py-name" targets="Module epydoc.docwriter.html_colorize=epydoc.docwriter.html_colorize-module.html"><a title="epydoc.docwriter.html_colorize" class="py-name" href="#" onclick="return doclink('link-12', 'html_colorize', 'link-12');">html_colorize</a></tt> <tt class="py-keyword">import</tt> <tt id="link-13" class="py-name" targets="Class epydoc.docwriter.html_colorize.PythonSourceColorizer=epydoc.docwriter.html_colorize.PythonSourceColorizer-class.html"><a title="epydoc.docwriter.html_colorize.PythonSourceColorizer" class="py-name" href="#" onclick="return doclink('link-13', 'PythonSourceColorizer', 'link-13');">PythonSourceColorizer</a></tt> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-14" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-14', 'epydoc', 'link-0');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-15" class="py-name"><a title="epydoc.docwriter" class="py-name" href="#" onclick="return doclink('link-15', 'docwriter', 'link-11');">docwriter</a></tt> <tt class="py-keyword">import</tt> <tt id="link-16" class="py-name"><a title="epydoc.docwriter.html_colorize" class="py-name" href="#" onclick="return doclink('link-16', 'html_colorize', 'link-12');">html_colorize</a></tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-17" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-17', 'epydoc', 'link-0');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-18" class="py-name"><a title="epydoc.docwriter" class="py-name" href="#" onclick="return doclink('link-18', 'docwriter', 'link-11');">docwriter</a></tt><tt class="py-op">.</tt><tt id="link-19" class="py-name" targets="Module epydoc.docwriter.html_css=epydoc.docwriter.html_css-module.html"><a title="epydoc.docwriter.html_css" class="py-name" href="#" onclick="return doclink('link-19', 'html_css', 'link-19');">html_css</a></tt> <tt class="py-keyword">import</tt> <tt id="link-20" class="py-name" targets="Variable epydoc.docwriter.html_css.STYLESHEETS=epydoc.docwriter.html_css-module.html#STYLESHEETS"><a title="epydoc.docwriter.html_css.STYLESHEETS" class="py-name" href="#" onclick="return doclink('link-20', 'STYLESHEETS', 'link-20');">STYLESHEETS</a></tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-21" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-21', 'epydoc', 'link-0');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-22" class="py-name"><a title="epydoc.docwriter" class="py-name" href="#" onclick="return doclink('link-22', 'docwriter', 'link-11');">docwriter</a></tt><tt class="py-op">.</tt><tt id="link-23" class="py-name" targets="Module epydoc.docwriter.html_help=epydoc.docwriter.html_help-module.html"><a title="epydoc.docwriter.html_help" class="py-name" href="#" onclick="return doclink('link-23', 'html_help', 'link-23');">html_help</a></tt> <tt class="py-keyword">import</tt> <tt id="link-24" class="py-name" targets="Variable epydoc.docwriter.html_help.HTML_HELP=epydoc.docwriter.html_help-module.html#HTML_HELP"><a title="epydoc.docwriter.html_help.HTML_HELP" class="py-name" href="#" onclick="return doclink('link-24', 'HTML_HELP', 'link-24');">HTML_HELP</a></tt> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-25" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-25', 'epydoc', 'link-0');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-26" class="py-name"><a title="epydoc.docwriter" class="py-name" href="#" onclick="return doclink('link-26', 'docwriter', 'link-11');">docwriter</a></tt><tt class="py-op">.</tt><tt id="link-27" class="py-name" targets="Module epydoc.docwriter.dotgraph=epydoc.docwriter.dotgraph-module.html,Class epydoc.markup.restructuredtext.dotgraph=epydoc.markup.restructuredtext.dotgraph-class.html"><a title="epydoc.docwriter.dotgraph
epydoc.markup.restructuredtext.dotgraph" class="py-name" href="#" onclick="return doclink('link-27', 'dotgraph', 'link-27');">dotgraph</a></tt> <tt class="py-keyword">import</tt> <tt class="py-op">*</tt> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-28" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-28', 'epydoc', 'link-0');">epydoc</a></tt> <tt class="py-keyword">import</tt> <tt id="link-29" class="py-name" targets="Method epydoc.cli.ConsoleLogger.log()=epydoc.cli.ConsoleLogger-class.html#log,Method epydoc.cli.HTMLLogger.log()=epydoc.cli.HTMLLogger-class.html#log,Method epydoc.gui.GUILogger.log()=epydoc.gui.GUILogger-class.html#log,Module epydoc.log=epydoc.log-module.html,Method epydoc.log.Logger.log()=epydoc.log.Logger-class.html#log,Method epydoc.log.SimpleLogger.log()=epydoc.log.SimpleLogger-class.html#log"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-29', 'log', 'link-29');">log</a></tt> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-30" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-30', 'epydoc', 'link-0');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-31" class="py-name" targets="Module epydoc.test.util=epydoc.test.util-module.html,Module epydoc.util=epydoc.util-module.html"><a title="epydoc.test.util
epydoc.util" class="py-name" href="#" onclick="return doclink('link-31', 'util', 'link-31');">util</a></tt> <tt class="py-keyword">import</tt> <tt id="link-32" class="py-name" targets="Function epydoc.util.plaintext_to_html()=epydoc.util-module.html#plaintext_to_html"><a title="epydoc.util.plaintext_to_html" class="py-name" href="#" onclick="return doclink('link-32', 'plaintext_to_html', 'link-32');">plaintext_to_html</a></tt><tt class="py-op">,</tt> <tt id="link-33" class="py-name" targets="Function epydoc.util.is_src_filename()=epydoc.util-module.html#is_src_filename"><a title="epydoc.util.is_src_filename" class="py-name" href="#" onclick="return doclink('link-33', 'is_src_filename', 'link-33');">is_src_filename</a></tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-34" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-34', 'epydoc', 'link-0');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-35" class="py-name" targets="Module epydoc.compat=epydoc.compat-module.html"><a title="epydoc.compat" class="py-name" href="#" onclick="return doclink('link-35', 'compat', 'link-35');">compat</a></tt> <tt class="py-keyword">import</tt> <tt class="py-op">*</tt> <tt class="py-comment"># Backwards compatibility</tt> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt> <tt class="py-line"> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## Template Compiler</tt> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################################################################</tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># The compile_template() method defined in this section is used to</tt> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># define several of HTMLWriter's methods.</tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="compile_template"></a><div id="compile_template-def"><a name="L38"></a><tt class="py-lineno"> 38</tt> <a class="py-toggle" href="#" id="compile_template-toggle" onclick="return toggle('compile_template');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html-module.html#compile_template">compile_template</a><tt class="py-op">(</tt><tt class="py-param">docstring</tt><tt class="py-op">,</tt> <tt class="py-param">template_string</tt><tt class="py-op">,</tt> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"> <tt class="py-param">output_function</tt><tt class="py-op">=</tt><tt class="py-string">'out'</tt><tt class="py-op">,</tt> <tt class="py-param">debug</tt><tt class="py-op">=</tt><tt id="link-36" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-36', 'epydoc', 'link-0');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-37" class="py-name" targets="Variable epydoc.DEBUG=epydoc-module.html#DEBUG,Variable epydoc.gui.DEBUG=epydoc.gui-module.html#DEBUG,Variable epydoc.log.DEBUG=epydoc.log-module.html#DEBUG"><a title="epydoc.DEBUG
epydoc.gui.DEBUG
epydoc.log.DEBUG" class="py-name" href="#" onclick="return doclink('link-37', 'DEBUG', 'link-37');">DEBUG</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="compile_template-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="compile_template-expanded"><a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"><tt class="py-docstring"> Given a template string containing inline python source code,</tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"><tt class="py-docstring"> return a python function that will fill in the template, and</tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"><tt class="py-docstring"> output the result. The signature for this function is taken from</tt> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"><tt class="py-docstring"> the first line of C{docstring}. Output is generated by making</tt> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"><tt class="py-docstring"> repeated calls to the output function with the given name (which</tt> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"><tt class="py-docstring"> is typically one of the function's parameters).</tt> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"><tt class="py-docstring"> The templating language used by this function passes through all</tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"><tt class="py-docstring"> text as-is, with three exceptions:</tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"><tt class="py-docstring"> - If every line in the template string is indented by at least</tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"><tt class="py-docstring"> M{x} spaces, then the first M{x} spaces are stripped from each</tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"><tt class="py-docstring"> line.</tt> </tt>
<a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"><tt class="py-docstring"> - Any line that begins with '>>>' (with no indentation)</tt> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt> <tt class="py-line"><tt class="py-docstring"> should contain python code, and will be inserted as-is into</tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"><tt class="py-docstring"> the template-filling function. If the line begins a control</tt> </tt>
<a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"><tt class="py-docstring"> block (such as 'if' or 'for'), then the control block will</tt> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"><tt class="py-docstring"> be closed by the first '>>>'-marked line whose indentation is</tt> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"><tt class="py-docstring"> less than or equal to the line's own indentation (including</tt> </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"><tt class="py-docstring"> lines that only contain comments.)</tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"><tt class="py-docstring"> - In any other line, any expression between two '$' signs will</tt> </tt>
<a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"><tt class="py-docstring"> be evaluated and inserted into the line (using C{str()} to</tt> </tt>
<a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"><tt class="py-docstring"> convert the result to a string).</tt> </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"><tt class="py-docstring"> Here is a simple example:</tt> </tt>
<a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"><tt class="py-docstring"> >>> TEMPLATE = '''</tt> </tt>
<a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"><tt class="py-docstring"> ... <book></tt> </tt>
<a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"><tt class="py-docstring"> ... <title>$book.title$</title></tt> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"><tt class="py-docstring"> ... <pages>$book.count_pages()$</pages></tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"><tt class="py-docstring"> ... >>> for chapter in book.chapters:</tt> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"><tt class="py-docstring"> ... <chaptername>$chapter.name$</chaptername></tt> </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"><tt class="py-docstring"> ... >>> #endfor</tt> </tt>
<a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"><tt class="py-docstring"> ... </book></tt> </tt>
<a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"><tt class="py-docstring"> >>> write_book = compile_template('write_book(out, book)', TEMPLATE)</tt> </tt>
<a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"><tt class="py-docstring"> @newfield acknowledgements: Acknowledgements</tt> </tt>
<a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"><tt class="py-docstring"> @acknowledgements: The syntax used by C{compile_template} is</tt> </tt>
<a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"><tt class="py-docstring"> loosely based on Cheetah.</tt> </tt>
<a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"> <tt class="py-comment"># Extract signature from the docstring:</tt> </tt>
<a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">signature</tt> <tt class="py-op">=</tt> <tt id="link-38" class="py-name" targets="Variable epydoc.apidoc.APIDoc.docstring=epydoc.apidoc.APIDoc-class.html#docstring"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-38', 'docstring', 'link-38');">docstring</a></tt><tt class="py-op">.</tt><tt class="py-name">lstrip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'\n'</tt><tt class="py-op">,</tt><tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"> <tt class="py-name">func_name</tt> <tt class="py-op">=</tt> <tt class="py-name">signature</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'('</tt><tt class="py-op">,</tt><tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"> </tt>
<a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"> <tt class="py-comment"># Regexp to search for inline substitutions:</tt> </tt>
<a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">INLINE</tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-string">r'\$([^\$]+)\$'</tt><tt class="py-op">)</tt> </tt>
<a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"> <tt class="py-comment"># Regexp to search for python statements in the template:</tt> </tt>
<a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">COMMAND</tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-string">r'(^>>>.*)\n?'</tt><tt class="py-op">,</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">MULTILINE</tt><tt class="py-op">)</tt> </tt>
<a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"> </tt>
<a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"> <tt class="py-comment"># Strip indentation from the template.</tt> </tt>
<a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">template_string</tt> <tt class="py-op">=</tt> <tt id="link-39" class="py-name" targets="Function epydoc.docwriter.html.strip_indent()=epydoc.docwriter.html-module.html#strip_indent"><a title="epydoc.docwriter.html.strip_indent" class="py-name" href="#" onclick="return doclink('link-39', 'strip_indent', 'link-39');">strip_indent</a></tt><tt class="py-op">(</tt><tt class="py-name">template_string</tt><tt class="py-op">)</tt> </tt>
<a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"> </tt>
<a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"> <tt class="py-comment"># If we're debugging, then we'll store the generated function,</tt> </tt>
<a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># so we can print it along with any tracebacks that depend on it.</tt> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt id="link-40" class="py-name" targets="Function epydoc.log.debug()=epydoc.log-module.html#debug,Method epydoc.markup.restructuredtext.OptimizedReporter.debug()=epydoc.markup.restructuredtext.OptimizedReporter-class.html#debug"><a title="epydoc.log.debug
epydoc.markup.restructuredtext.OptimizedReporter.debug" class="py-name" href="#" onclick="return doclink('link-40', 'debug', 'link-40');">debug</a></tt><tt class="py-op">:</tt> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"> <tt class="py-name">signature</tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">sub</tt><tt class="py-op">(</tt><tt class="py-string">r'\)\s*$'</tt><tt class="py-op">,</tt> <tt class="py-string">', __debug=__debug)'</tt><tt class="py-op">,</tt> <tt class="py-name">signature</tt><tt class="py-op">)</tt> </tt>
<a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"> </tt>
<a name="L100"></a><tt class="py-lineno"> 100</tt> <tt class="py-line"> <tt class="py-comment"># Funciton declaration line</tt> </tt>
<a name="L101"></a><tt class="py-lineno"> 101</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">pysrc_lines</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">'def %s:'</tt> <tt class="py-op">%</tt> <tt class="py-name">signature</tt><tt class="py-op">]</tt> </tt>
<a name="L102"></a><tt class="py-lineno"> 102</tt> <tt class="py-line"> <tt class="py-name">indents</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt>
<a name="L103"></a><tt class="py-lineno"> 103</tt> <tt class="py-line"> </tt>
<a name="L104"></a><tt class="py-lineno"> 104</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-41" class="py-name"><a title="epydoc.log.debug
epydoc.markup.restructuredtext.OptimizedReporter.debug" class="py-name" href="#" onclick="return doclink('link-41', 'debug', 'link-40');">debug</a></tt><tt class="py-op">:</tt> </tt>
<a name="L105"></a><tt class="py-lineno"> 105</tt> <tt class="py-line"> <tt class="py-name">pysrc_lines</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">' try:'</tt><tt class="py-op">)</tt> </tt>
<a name="L106"></a><tt class="py-lineno"> 106</tt> <tt class="py-line"> <tt class="py-name">indents</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
<a name="L107"></a><tt class="py-lineno"> 107</tt> <tt class="py-line"> </tt>
<a name="L108"></a><tt class="py-lineno"> 108</tt> <tt class="py-line"> <tt class="py-name">commands</tt> <tt class="py-op">=</tt> <tt class="py-name">COMMAND</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-name">template_string</tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">+</tt><tt class="py-string">'\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L109"></a><tt class="py-lineno"> 109</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">i</tt><tt class="py-op">,</tt> <tt class="py-name">command</tt> <tt class="py-keyword">in</tt> <tt class="py-name">enumerate</tt><tt class="py-op">(</tt><tt class="py-name">commands</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L110"></a><tt class="py-lineno"> 110</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">command</tt> <tt class="py-op">==</tt> <tt class="py-string">''</tt><tt class="py-op">:</tt> <tt class="py-keyword">continue</tt> </tt>
<a name="L111"></a><tt class="py-lineno"> 111</tt> <tt class="py-line"> </tt>
<a name="L112"></a><tt class="py-lineno"> 112</tt> <tt class="py-line"> <tt class="py-comment"># String literal segment:</tt> </tt>
<a name="L113"></a><tt class="py-lineno"> 113</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">i</tt><tt class="py-op">%</tt><tt class="py-number">2</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L114"></a><tt class="py-lineno"> 114</tt> <tt class="py-line"> <tt class="py-name">pieces</tt> <tt class="py-op">=</tt> <tt class="py-name">INLINE</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-name">command</tt><tt class="py-op">)</tt> </tt>
<a name="L115"></a><tt class="py-lineno"> 115</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">j</tt><tt class="py-op">,</tt> <tt class="py-name">piece</tt> <tt class="py-keyword">in</tt> <tt class="py-name">enumerate</tt><tt class="py-op">(</tt><tt class="py-name">pieces</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L116"></a><tt class="py-lineno"> 116</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">j</tt><tt class="py-op">%</tt><tt class="py-number">2</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L117"></a><tt class="py-lineno"> 117</tt> <tt class="py-line"> <tt class="py-comment"># String piece</tt> </tt>
<a name="L118"></a><tt class="py-lineno"> 118</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">pysrc_lines</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">*</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">indents</tt><tt class="py-op">)</tt><tt class="py-op">+</tt> </tt>
<a name="L119"></a><tt class="py-lineno"> 119</tt> <tt class="py-line"> <tt class="py-string">'%s(%r)'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">output_function</tt><tt class="py-op">,</tt> <tt class="py-name">piece</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L120"></a><tt class="py-lineno"> 120</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L121"></a><tt class="py-lineno"> 121</tt> <tt class="py-line"> <tt class="py-comment"># Variable piece</tt> </tt>
<a name="L122"></a><tt class="py-lineno"> 122</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">pysrc_lines</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">*</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">indents</tt><tt class="py-op">)</tt><tt class="py-op">+</tt> </tt>
<a name="L123"></a><tt class="py-lineno"> 123</tt> <tt class="py-line"> <tt class="py-string">'%s(unicode(%s))'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">output_function</tt><tt class="py-op">,</tt> <tt class="py-name">piece</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L124"></a><tt class="py-lineno"> 124</tt> <tt class="py-line"> </tt>
<a name="L125"></a><tt class="py-lineno"> 125</tt> <tt class="py-line"> <tt class="py-comment"># Python command:</tt> </tt>
<a name="L126"></a><tt class="py-lineno"> 126</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L127"></a><tt class="py-lineno"> 127</tt> <tt class="py-line"> <tt class="py-name">srcline</tt> <tt class="py-op">=</tt> <tt class="py-name">command</tt><tt class="py-op">[</tt><tt class="py-number">3</tt><tt class="py-op">:</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">lstrip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L128"></a><tt class="py-lineno"> 128</tt> <tt class="py-line"> <tt class="py-comment"># Update indentation</tt> </tt>
<a name="L129"></a><tt class="py-lineno"> 129</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">indent</tt> <tt class="py-op">=</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">command</tt><tt class="py-op">)</tt><tt class="py-op">-</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">srcline</tt><tt class="py-op">)</tt> </tt>
<a name="L130"></a><tt class="py-lineno"> 130</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt class="py-name">indent</tt> <tt class="py-op"><=</tt> <tt class="py-name">indents</tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> <tt class="py-name">indents</tt><tt class="py-op">.</tt><tt class="py-name">pop</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L131"></a><tt class="py-lineno"> 131</tt> <tt class="py-line"> <tt class="py-comment"># Add on the line.</tt> </tt>
<a name="L132"></a><tt class="py-lineno"> 132</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">srcline</tt> <tt class="py-op">=</tt> <tt class="py-name">srcline</tt><tt class="py-op">.</tt><tt class="py-name">rstrip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L133"></a><tt class="py-lineno"> 133</tt> <tt class="py-line"> <tt class="py-name">pysrc_lines</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">*</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">indents</tt><tt class="py-op">)</tt><tt class="py-op">+</tt><tt class="py-name">srcline</tt><tt class="py-op">)</tt> </tt>
<a name="L134"></a><tt class="py-lineno"> 134</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">srcline</tt><tt class="py-op">.</tt><tt class="py-name">endswith</tt><tt class="py-op">(</tt><tt class="py-string">':'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L135"></a><tt class="py-lineno"> 135</tt> <tt class="py-line"> <tt class="py-name">indents</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">indent</tt><tt class="py-op">)</tt> </tt>
<a name="L136"></a><tt class="py-lineno"> 136</tt> <tt class="py-line"> </tt>
<a name="L137"></a><tt class="py-lineno"> 137</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-42" class="py-name"><a title="epydoc.log.debug
epydoc.markup.restructuredtext.OptimizedReporter.debug" class="py-name" href="#" onclick="return doclink('link-42', 'debug', 'link-40');">debug</a></tt><tt class="py-op">:</tt> </tt>
<a name="L138"></a><tt class="py-lineno"> 138</tt> <tt class="py-line"> <tt class="py-name">pysrc_lines</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">' except Exception,e:'</tt><tt class="py-op">)</tt> </tt>
<a name="L139"></a><tt class="py-lineno"> 139</tt> <tt class="py-line"> <tt class="py-name">pysrc_lines</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">' pysrc, func_name = __debug '</tt><tt class="py-op">)</tt> </tt>
<a name="L140"></a><tt class="py-lineno"> 140</tt> <tt class="py-line"> <tt class="py-name">pysrc_lines</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">' lineno = sys.exc_info()[2].tb_lineno'</tt><tt class="py-op">)</tt> </tt>
<a name="L141"></a><tt class="py-lineno"> 141</tt> <tt class="py-line"> <tt class="py-name">pysrc_lines</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">' print ("Exception in template %s() on "'</tt><tt class="py-op">)</tt> </tt>
<a name="L142"></a><tt class="py-lineno"> 142</tt> <tt class="py-line"> <tt class="py-name">pysrc_lines</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">' "line %d:" % (func_name, lineno))'</tt><tt class="py-op">)</tt> </tt>
<a name="L143"></a><tt class="py-lineno"> 143</tt> <tt class="py-line"> <tt class="py-name">pysrc_lines</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">' print pysrc[lineno-1]'</tt><tt class="py-op">)</tt> </tt>
<a name="L144"></a><tt class="py-lineno"> 144</tt> <tt class="py-line"> <tt class="py-name">pysrc_lines</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">' raise'</tt><tt class="py-op">)</tt> </tt>
<a name="L145"></a><tt class="py-lineno"> 145</tt> <tt class="py-line"> </tt>
<a name="L146"></a><tt class="py-lineno"> 146</tt> <tt class="py-line"> <tt class="py-name">pysrc</tt> <tt class="py-op">=</tt> <tt class="py-string">'\n'</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">pysrc_lines</tt><tt class="py-op">)</tt><tt class="py-op">+</tt><tt class="py-string">'\n'</tt> </tt>
<a name="L147"></a><tt class="py-lineno"> 147</tt> <tt class="py-line"> <tt class="py-comment">#log.debug(pysrc)</tt> </tt>
<a name="L148"></a><tt class="py-lineno"> 148</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt id="link-43" class="py-name"><a title="epydoc.log.debug
epydoc.markup.restructuredtext.OptimizedReporter.debug" class="py-name" href="#" onclick="return doclink('link-43', 'debug', 'link-40');">debug</a></tt><tt class="py-op">:</tt> <tt class="py-name">localdict</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-string">'__debug'</tt><tt class="py-op">:</tt> <tt class="py-op">(</tt><tt class="py-name">pysrc_lines</tt><tt class="py-op">,</tt> <tt class="py-name">func_name</tt><tt class="py-op">)</tt><tt class="py-op">}</tt> </tt>
<a name="L149"></a><tt class="py-lineno"> 149</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-name">localdict</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L150"></a><tt class="py-lineno"> 150</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> <tt class="py-keyword">exec</tt> <tt class="py-name">pysrc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">globals</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">localdict</tt> </tt>
<a name="L151"></a><tt class="py-lineno"> 151</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">SyntaxError</tt><tt class="py-op">:</tt> </tt>
<a name="L152"></a><tt class="py-lineno"> 152</tt> <tt class="py-line"> <tt id="link-44" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-44', 'log', 'link-29');">log</a></tt><tt class="py-op">.</tt><tt id="link-45" class="py-name" targets="Function epydoc.log.error()=epydoc.log-module.html#error"><a title="epydoc.log.error" class="py-name" href="#" onclick="return doclink('link-45', 'error', 'link-45');">error</a></tt><tt class="py-op">(</tt><tt class="py-string">'Error in script:\n'</tt> <tt class="py-op">+</tt> <tt class="py-name">pysrc</tt> <tt class="py-op">+</tt> <tt class="py-string">'\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L153"></a><tt class="py-lineno"> 153</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> </tt>
<a name="L154"></a><tt class="py-lineno"> 154</tt> <tt class="py-line"> <tt class="py-name">template_func</tt> <tt class="py-op">=</tt> <tt class="py-name">localdict</tt><tt class="py-op">[</tt><tt class="py-name">func_name</tt><tt class="py-op">]</tt> </tt>
<a name="L155"></a><tt class="py-lineno"> 155</tt> <tt class="py-line"> <tt class="py-name">template_func</tt><tt class="py-op">.</tt><tt id="link-46" class="py-name" targets="Variable epydoc.markup.epytext.__doc__=epydoc.markup.epytext-module.html#__doc__"><a title="epydoc.markup.epytext.__doc__" class="py-name" href="#" onclick="return doclink('link-46', '__doc__', 'link-46');">__doc__</a></tt> <tt class="py-op">=</tt> <tt id="link-47" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-47', 'docstring', 'link-38');">docstring</a></tt> </tt>
<a name="L156"></a><tt class="py-lineno"> 156</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">template_func</tt> </tt>
</div><a name="L157"></a><tt class="py-lineno"> 157</tt> <tt class="py-line"> </tt>
<a name="strip_indent"></a><div id="strip_indent-def"><a name="L158"></a><tt class="py-lineno"> 158</tt> <a class="py-toggle" href="#" id="strip_indent-toggle" onclick="return toggle('strip_indent');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html-module.html#strip_indent">strip_indent</a><tt class="py-op">(</tt><tt class="py-param">s</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="strip_indent-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="strip_indent-expanded"><a name="L159"></a><tt class="py-lineno"> 159</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L160"></a><tt class="py-lineno"> 160</tt> <tt class="py-line"><tt class="py-docstring"> Given a multiline string C{s}, find the minimum indentation for</tt> </tt>
<a name="L161"></a><tt class="py-lineno"> 161</tt> <tt class="py-line"><tt class="py-docstring"> all non-blank lines, and return a new string formed by stripping</tt> </tt>
<a name="L162"></a><tt class="py-lineno"> 162</tt> <tt class="py-line"><tt class="py-docstring"> that amount of indentation from all lines in C{s}.</tt> </tt>
<a name="L163"></a><tt class="py-lineno"> 163</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L164"></a><tt class="py-lineno"> 164</tt> <tt class="py-line"> <tt class="py-comment"># Strip indentation from the template.</tt> </tt>
<a name="L165"></a><tt class="py-lineno"> 165</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">minindent</tt> <tt class="py-op">=</tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">maxint</tt> </tt>
<a name="L166"></a><tt class="py-lineno"> 166</tt> <tt class="py-line"> <tt class="py-name">lines</tt> <tt class="py-op">=</tt> <tt class="py-name">s</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L167"></a><tt class="py-lineno"> 167</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">line</tt> <tt class="py-keyword">in</tt> <tt class="py-name">lines</tt><tt class="py-op">:</tt> </tt>
<a name="L168"></a><tt class="py-lineno"> 168</tt> <tt class="py-line"> <tt class="py-name">stripline</tt> <tt class="py-op">=</tt> <tt class="py-name">line</tt><tt class="py-op">.</tt><tt class="py-name">lstrip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L169"></a><tt class="py-lineno"> 169</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">stripline</tt><tt class="py-op">:</tt> </tt>
<a name="L170"></a><tt class="py-lineno"> 170</tt> <tt class="py-line"> <tt class="py-name">minindent</tt> <tt class="py-op">=</tt> <tt class="py-name">min</tt><tt class="py-op">(</tt><tt class="py-name">minindent</tt><tt class="py-op">,</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">)</tt><tt class="py-op">-</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">stripline</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L171"></a><tt class="py-lineno"> 171</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'\n'</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">l</tt><tt class="py-op">[</tt><tt class="py-name">minindent</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> <tt class="py-keyword">for</tt> <tt class="py-name">l</tt> <tt class="py-keyword">in</tt> <tt class="py-name">lines</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
</div><a name="L172"></a><tt class="py-lineno"> 172</tt> <tt class="py-line"> </tt>
<a name="L173"></a><tt class="py-lineno"> 173</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L174"></a><tt class="py-lineno"> 174</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## HTML Writer</tt> </tt>
<a name="L175"></a><tt class="py-lineno"> 175</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################################################################</tt> </tt>
<a name="L176"></a><tt class="py-lineno"> 176</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="HTMLWriter"></a><div id="HTMLWriter-def"><a name="L177"></a><tt class="py-lineno"> 177</tt> <a class="py-toggle" href="#" id="HTMLWriter-toggle" onclick="return toggle('HTMLWriter');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html">HTMLWriter</a><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="HTMLWriter-expanded"><a name="L178"></a><tt class="py-lineno"> 178</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L179"></a><tt class="py-lineno"> 179</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># Table of Contents</tt> </tt>
<a name="L180"></a><tt class="py-lineno"> 180</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L181"></a><tt class="py-lineno"> 181</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#</tt> </tt>
<a name="L182"></a><tt class="py-lineno"> 182</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># 1. Interface Methods</tt> </tt>
<a name="L183"></a><tt class="py-lineno"> 183</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#</tt> </tt>
<a name="L184"></a><tt class="py-lineno"> 184</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># 2. Page Generation -- write complete web page files</tt> </tt>
<a name="L185"></a><tt class="py-lineno"> 185</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># 2.1. Module Pages</tt> </tt>
<a name="L186"></a><tt class="py-lineno"> 186</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># 2.2. Class Pages</tt> </tt>
<a name="L187"></a><tt class="py-lineno"> 187</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># 2.3. Trees Page</tt> </tt>
<a name="L188"></a><tt class="py-lineno"> 188</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># 2.4. Indices Page</tt> </tt>
<a name="L189"></a><tt class="py-lineno"> 189</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># 2.5. Help Page</tt> </tt>
<a name="L190"></a><tt class="py-lineno"> 190</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># 2.6. Frames-based table of contents pages</tt> </tt>
<a name="L191"></a><tt class="py-lineno"> 191</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># 2.7. Homepage (index.html)</tt> </tt>
<a name="L192"></a><tt class="py-lineno"> 192</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># 2.8. CSS Stylesheet</tt> </tt>
<a name="L193"></a><tt class="py-lineno"> 193</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># 2.9. Javascript file</tt> </tt>
<a name="L194"></a><tt class="py-lineno"> 194</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># 2.10. Graphs</tt> </tt>
<a name="L195"></a><tt class="py-lineno"> 195</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># 2.11. Images</tt> </tt>
<a name="L196"></a><tt class="py-lineno"> 196</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#</tt> </tt>
<a name="L197"></a><tt class="py-lineno"> 197</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># 3. Page Element Generation -- write pieces of a web page file</tt> </tt>
<a name="L198"></a><tt class="py-lineno"> 198</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># 3.1. Page Header</tt> </tt>
<a name="L199"></a><tt class="py-lineno"> 199</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># 3.2. Page Footer</tt> </tt>
<a name="L200"></a><tt class="py-lineno"> 200</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># 3.3. Navigation Bar</tt> </tt>
<a name="L201"></a><tt class="py-lineno"> 201</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># 3.4. Breadcrumbs</tt> </tt>
<a name="L202"></a><tt class="py-lineno"> 202</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># 3.5. Summary Tables</tt> </tt>
<a name="L203"></a><tt class="py-lineno"> 203</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#</tt> </tt>
<a name="L204"></a><tt class="py-lineno"> 204</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># 4. Helper functions</tt> </tt>
<a name="L205"></a><tt class="py-lineno"> 205</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="HTMLWriter.__init__"></a><div id="HTMLWriter.__init__-def"><a name="L206"></a><tt class="py-lineno"> 206</tt> <a class="py-toggle" href="#" id="HTMLWriter.__init__-toggle" onclick="return toggle('HTMLWriter.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">docindex</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.__init__-expanded"><a name="L207"></a><tt class="py-lineno"> 207</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L208"></a><tt class="py-lineno"> 208</tt> <tt class="py-line"><tt class="py-docstring"> Construct a new HTML writer, using the given documentation</tt> </tt>
<a name="L209"></a><tt class="py-lineno"> 209</tt> <tt class="py-line"><tt class="py-docstring"> index.</tt> </tt>
<a name="L210"></a><tt class="py-lineno"> 210</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L211"></a><tt class="py-lineno"> 211</tt> <tt class="py-line"><tt class="py-docstring"> @param docindex: The documentation index.</tt> </tt>
<a name="L212"></a><tt class="py-lineno"> 212</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L213"></a><tt class="py-lineno"> 213</tt> <tt class="py-line"><tt class="py-docstring"> @type prj_name: C{string}</tt> </tt>
<a name="L214"></a><tt class="py-lineno"> 214</tt> <tt class="py-line"><tt class="py-docstring"> @keyword prj_name: The name of the project. Defaults to</tt> </tt>
<a name="L215"></a><tt class="py-lineno"> 215</tt> <tt class="py-line"><tt class="py-docstring"> none.</tt> </tt>
<a name="L216"></a><tt class="py-lineno"> 216</tt> <tt class="py-line"><tt class="py-docstring"> @type prj_url: C{string}</tt> </tt>
<a name="L217"></a><tt class="py-lineno"> 217</tt> <tt class="py-line"><tt class="py-docstring"> @keyword prj_url: The target for the project hopeage link on</tt> </tt>
<a name="L218"></a><tt class="py-lineno"> 218</tt> <tt class="py-line"><tt class="py-docstring"> the navigation bar. If C{prj_url} is not specified,</tt> </tt>
<a name="L219"></a><tt class="py-lineno"> 219</tt> <tt class="py-line"><tt class="py-docstring"> then no hyperlink is created.</tt> </tt>
<a name="L220"></a><tt class="py-lineno"> 220</tt> <tt class="py-line"><tt class="py-docstring"> @type prj_link: C{string}</tt> </tt>
<a name="L221"></a><tt class="py-lineno"> 221</tt> <tt class="py-line"><tt class="py-docstring"> @keyword prj_link: The label for the project link on the</tt> </tt>
<a name="L222"></a><tt class="py-lineno"> 222</tt> <tt class="py-line"><tt class="py-docstring"> navigation bar. This link can contain arbitrary HTML</tt> </tt>
<a name="L223"></a><tt class="py-lineno"> 223</tt> <tt class="py-line"><tt class="py-docstring"> code (e.g. images). By default, a label is constructed</tt> </tt>
<a name="L224"></a><tt class="py-lineno"> 224</tt> <tt class="py-line"><tt class="py-docstring"> from C{prj_name}.</tt> </tt>
<a name="L225"></a><tt class="py-lineno"> 225</tt> <tt class="py-line"><tt class="py-docstring"> @type top_page: C{string}</tt> </tt>
<a name="L226"></a><tt class="py-lineno"> 226</tt> <tt class="py-line"><tt class="py-docstring"> @keyword top_page: The top page for the documentation. This</tt> </tt>
<a name="L227"></a><tt class="py-lineno"> 227</tt> <tt class="py-line"><tt class="py-docstring"> is the default page shown main frame, when frames are</tt> </tt>
<a name="L228"></a><tt class="py-lineno"> 228</tt> <tt class="py-line"><tt class="py-docstring"> enabled. C{top} can be a URL, the name of a</tt> </tt>
<a name="L229"></a><tt class="py-lineno"> 229</tt> <tt class="py-line"><tt class="py-docstring"> module, the name of a class, or one of the special</tt> </tt>
<a name="L230"></a><tt class="py-lineno"> 230</tt> <tt class="py-line"><tt class="py-docstring"> strings C{"trees.html"}, C{"indices.html"}, or</tt> </tt>
<a name="L231"></a><tt class="py-lineno"> 231</tt> <tt class="py-line"><tt class="py-docstring"> C{"help.html"}. By default, the top-level package or</tt> </tt>
<a name="L232"></a><tt class="py-lineno"> 232</tt> <tt class="py-line"><tt class="py-docstring"> module is used, if there is one; otherwise, C{"trees"}</tt> </tt>
<a name="L233"></a><tt class="py-lineno"> 233</tt> <tt class="py-line"><tt class="py-docstring"> is used.</tt> </tt>
<a name="L234"></a><tt class="py-lineno"> 234</tt> <tt class="py-line"><tt class="py-docstring"> @type css: C{string}</tt> </tt>
<a name="L235"></a><tt class="py-lineno"> 235</tt> <tt class="py-line"><tt class="py-docstring"> @keyword css: The CSS stylesheet file. If C{css} is a file</tt> </tt>
<a name="L236"></a><tt class="py-lineno"> 236</tt> <tt class="py-line"><tt class="py-docstring"> name, then the specified file's conents will be used.</tt> </tt>
<a name="L237"></a><tt class="py-lineno"> 237</tt> <tt class="py-line"><tt class="py-docstring"> Otherwise, if C{css} is the name of a CSS stylesheet in</tt> </tt>
<a name="L238"></a><tt class="py-lineno"> 238</tt> <tt class="py-line"><tt class="py-docstring"> L{epydoc.docwriter.html_css}, then that stylesheet will</tt> </tt>
<a name="L239"></a><tt class="py-lineno"> 239</tt> <tt class="py-line"><tt class="py-docstring"> be used. Otherwise, an error is reported. If no stylesheet </tt> </tt>
<a name="L240"></a><tt class="py-lineno"> 240</tt> <tt class="py-line"><tt class="py-docstring"> is specified, then the default stylesheet is used.</tt> </tt>
<a name="L241"></a><tt class="py-lineno"> 241</tt> <tt class="py-line"><tt class="py-docstring"> @type help_file: C{string}</tt> </tt>
<a name="L242"></a><tt class="py-lineno"> 242</tt> <tt class="py-line"><tt class="py-docstring"> @keyword help_file: The name of the help file. If no help file is</tt> </tt>
<a name="L243"></a><tt class="py-lineno"> 243</tt> <tt class="py-line"><tt class="py-docstring"> specified, then the default help file will be used.</tt> </tt>
<a name="L244"></a><tt class="py-lineno"> 244</tt> <tt class="py-line"><tt class="py-docstring"> @type show_private: C{boolean}</tt> </tt>
<a name="L245"></a><tt class="py-lineno"> 245</tt> <tt class="py-line"><tt class="py-docstring"> @keyword show_private: Whether to create documentation for</tt> </tt>
<a name="L246"></a><tt class="py-lineno"> 246</tt> <tt class="py-line"><tt class="py-docstring"> private objects. By default, private objects are documented.</tt> </tt>
<a name="L247"></a><tt class="py-lineno"> 247</tt> <tt class="py-line"><tt class="py-docstring"> @type show_frames: C{boolean})</tt> </tt>
<a name="L248"></a><tt class="py-lineno"> 248</tt> <tt class="py-line"><tt class="py-docstring"> @keyword show_frames: Whether to create a frames-based table of</tt> </tt>
<a name="L249"></a><tt class="py-lineno"> 249</tt> <tt class="py-line"><tt class="py-docstring"> contents. By default, it is produced.</tt> </tt>
<a name="L250"></a><tt class="py-lineno"> 250</tt> <tt class="py-line"><tt class="py-docstring"> @type show_imports: C{boolean}</tt> </tt>
<a name="L251"></a><tt class="py-lineno"> 251</tt> <tt class="py-line"><tt class="py-docstring"> @keyword show_imports: Whether or not to display lists of</tt> </tt>
<a name="L252"></a><tt class="py-lineno"> 252</tt> <tt class="py-line"><tt class="py-docstring"> imported functions and classes. By default, they are</tt> </tt>
<a name="L253"></a><tt class="py-lineno"> 253</tt> <tt class="py-line"><tt class="py-docstring"> not shown.</tt> </tt>
<a name="L254"></a><tt class="py-lineno"> 254</tt> <tt class="py-line"><tt class="py-docstring"> @type variable_maxlines: C{int}</tt> </tt>
<a name="L255"></a><tt class="py-lineno"> 255</tt> <tt class="py-line"><tt class="py-docstring"> @keyword variable_maxlines: The maximum number of lines that</tt> </tt>
<a name="L256"></a><tt class="py-lineno"> 256</tt> <tt class="py-line"><tt class="py-docstring"> should be displayed for the value of a variable in the</tt> </tt>
<a name="L257"></a><tt class="py-lineno"> 257</tt> <tt class="py-line"><tt class="py-docstring"> variable details section. By default, 8 lines are</tt> </tt>
<a name="L258"></a><tt class="py-lineno"> 258</tt> <tt class="py-line"><tt class="py-docstring"> displayed.</tt> </tt>
<a name="L259"></a><tt class="py-lineno"> 259</tt> <tt class="py-line"><tt class="py-docstring"> @type variable_linelength: C{int}</tt> </tt>
<a name="L260"></a><tt class="py-lineno"> 260</tt> <tt class="py-line"><tt class="py-docstring"> @keyword variable_linelength: The maximum line length used for</tt> </tt>
<a name="L261"></a><tt class="py-lineno"> 261</tt> <tt class="py-line"><tt class="py-docstring"> displaying the values of variables in the variable</tt> </tt>
<a name="L262"></a><tt class="py-lineno"> 262</tt> <tt class="py-line"><tt class="py-docstring"> details sections. If a line is longer than this length,</tt> </tt>
<a name="L263"></a><tt class="py-lineno"> 263</tt> <tt class="py-line"><tt class="py-docstring"> then it will be wrapped to the next line. The default</tt> </tt>
<a name="L264"></a><tt class="py-lineno"> 264</tt> <tt class="py-line"><tt class="py-docstring"> line length is 70 characters.</tt> </tt>
<a name="L265"></a><tt class="py-lineno"> 265</tt> <tt class="py-line"><tt class="py-docstring"> @type variable_summary_linelength: C{int}</tt> </tt>
<a name="L266"></a><tt class="py-lineno"> 266</tt> <tt class="py-line"><tt class="py-docstring"> @keyword variable_summary_linelength: The maximum line length</tt> </tt>
<a name="L267"></a><tt class="py-lineno"> 267</tt> <tt class="py-line"><tt class="py-docstring"> used for displaying the values of variables in the summary</tt> </tt>
<a name="L268"></a><tt class="py-lineno"> 268</tt> <tt class="py-line"><tt class="py-docstring"> section. If a line is longer than this length, then it</tt> </tt>
<a name="L269"></a><tt class="py-lineno"> 269</tt> <tt class="py-line"><tt class="py-docstring"> will be truncated. The default is 40 characters.</tt> </tt>
<a name="L270"></a><tt class="py-lineno"> 270</tt> <tt class="py-line"><tt class="py-docstring"> @type variable_tooltip_linelength: C{int}</tt> </tt>
<a name="L271"></a><tt class="py-lineno"> 271</tt> <tt class="py-line"><tt class="py-docstring"> @keyword variable_tooltip_linelength: The maximum line length</tt> </tt>
<a name="L272"></a><tt class="py-lineno"> 272</tt> <tt class="py-line"><tt class="py-docstring"> used for tooltips for the values of variables. If a</tt> </tt>
<a name="L273"></a><tt class="py-lineno"> 273</tt> <tt class="py-line"><tt class="py-docstring"> line is longer than this length, then it will be</tt> </tt>
<a name="L274"></a><tt class="py-lineno"> 274</tt> <tt class="py-line"><tt class="py-docstring"> truncated. The default is 600 characters.</tt> </tt>
<a name="L275"></a><tt class="py-lineno"> 275</tt> <tt class="py-line"><tt class="py-docstring"> @type property_function_linelength: C{int}</tt> </tt>
<a name="L276"></a><tt class="py-lineno"> 276</tt> <tt class="py-line"><tt class="py-docstring"> @keyword property_function_linelength: The maximum line length</tt> </tt>
<a name="L277"></a><tt class="py-lineno"> 277</tt> <tt class="py-line"><tt class="py-docstring"> used to dispaly property functions (C{fget}, C{fset}, and</tt> </tt>
<a name="L278"></a><tt class="py-lineno"> 278</tt> <tt class="py-line"><tt class="py-docstring"> C{fdel}) that contain something other than a function</tt> </tt>
<a name="L279"></a><tt class="py-lineno"> 279</tt> <tt class="py-line"><tt class="py-docstring"> object. The default length is 40 characters.</tt> </tt>
<a name="L280"></a><tt class="py-lineno"> 280</tt> <tt class="py-line"><tt class="py-docstring"> @type inheritance: C{string}</tt> </tt>
<a name="L281"></a><tt class="py-lineno"> 281</tt> <tt class="py-line"><tt class="py-docstring"> @keyword inheritance: How inherited objects should be displayed.</tt> </tt>
<a name="L282"></a><tt class="py-lineno"> 282</tt> <tt class="py-line"><tt class="py-docstring"> If C{inheritance='grouped'}, then inherited objects are</tt> </tt>
<a name="L283"></a><tt class="py-lineno"> 283</tt> <tt class="py-line"><tt class="py-docstring"> gathered into groups; if C{inheritance='listed'}, then</tt> </tt>
<a name="L284"></a><tt class="py-lineno"> 284</tt> <tt class="py-line"><tt class="py-docstring"> inherited objects are listed in a short list at the</tt> </tt>
<a name="L285"></a><tt class="py-lineno"> 285</tt> <tt class="py-line"><tt class="py-docstring"> end of their group; if C{inheritance='included'}, then</tt> </tt>
<a name="L286"></a><tt class="py-lineno"> 286</tt> <tt class="py-line"><tt class="py-docstring"> inherited objects are mixed in with non-inherited</tt> </tt>
<a name="L287"></a><tt class="py-lineno"> 287</tt> <tt class="py-line"><tt class="py-docstring"> objects. The default is 'grouped'.</tt> </tt>
<a name="L288"></a><tt class="py-lineno"> 288</tt> <tt class="py-line"><tt class="py-docstring"> @type include_source_code: C{boolean}</tt> </tt>
<a name="L289"></a><tt class="py-lineno"> 289</tt> <tt class="py-line"><tt class="py-docstring"> @keyword include_source_code: If true, then generate colorized</tt> </tt>
<a name="L290"></a><tt class="py-lineno"> 290</tt> <tt class="py-line"><tt class="py-docstring"> source code files for each python module.</tt> </tt>
<a name="L291"></a><tt class="py-lineno"> 291</tt> <tt class="py-line"><tt class="py-docstring"> @type include_log: C{boolean}</tt> </tt>
<a name="L292"></a><tt class="py-lineno"> 292</tt> <tt class="py-line"><tt class="py-docstring"> @keyword include_log: If true, the the footer will include an</tt> </tt>
<a name="L293"></a><tt class="py-lineno"> 293</tt> <tt class="py-line"><tt class="py-docstring"> href to the page 'epydoc-log.html'.</tt> </tt>
<a name="L294"></a><tt class="py-lineno"> 294</tt> <tt class="py-line"><tt class="py-docstring"> @type src_code_tab_width: C{int}</tt> </tt>
<a name="L295"></a><tt class="py-lineno"> 295</tt> <tt class="py-line"><tt class="py-docstring"> @keyword src_code_tab_width: Number of spaces to replace each tab</tt> </tt>
<a name="L296"></a><tt class="py-lineno"> 296</tt> <tt class="py-line"><tt class="py-docstring"> with in source code listings.</tt> </tt>
<a name="L297"></a><tt class="py-lineno"> 297</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L298"></a><tt class="py-lineno"> 298</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">docindex</tt> <tt class="py-op">=</tt> <tt class="py-name">docindex</tt> </tt>
<a name="L299"></a><tt class="py-lineno"> 299</tt> <tt class="py-line"> </tt>
<a name="L300"></a><tt class="py-lineno"> 300</tt> <tt class="py-line"> <tt class="py-comment"># Process keyword arguments.</tt> </tt>
<a name="L301"></a><tt class="py-lineno"> 301</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_show_private</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'show_private'</tt><tt class="py-op">,</tt> <tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
<a name="L302"></a><tt class="py-lineno"> 302</tt> <tt class="py-line"> <tt class="py-string">"""Should private docs be included?"""</tt> </tt>
<a name="L303"></a><tt class="py-lineno"> 303</tt> <tt class="py-line"> </tt>
<a name="L304"></a><tt class="py-lineno"> 304</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_prj_name</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'prj_name'</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
<a name="L305"></a><tt class="py-lineno"> 305</tt> <tt class="py-line"> <tt class="py-string">"""The project's name (for the project link in the navbar)"""</tt> </tt>
<a name="L306"></a><tt class="py-lineno"> 306</tt> <tt class="py-line"> </tt>
<a name="L307"></a><tt class="py-lineno"> 307</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_prj_url</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'prj_url'</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
<a name="L308"></a><tt class="py-lineno"> 308</tt> <tt class="py-line"> <tt class="py-string">"""URL for the project link in the navbar"""</tt> </tt>
<a name="L309"></a><tt class="py-lineno"> 309</tt> <tt class="py-line"> </tt>
<a name="L310"></a><tt class="py-lineno"> 310</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_prj_link</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'prj_link'</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
<a name="L311"></a><tt class="py-lineno"> 311</tt> <tt class="py-line"> <tt class="py-string">"""HTML code for the project link in the navbar"""</tt> </tt>
<a name="L312"></a><tt class="py-lineno"> 312</tt> <tt class="py-line"> </tt>
<a name="L313"></a><tt class="py-lineno"> 313</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_top_page</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'top_page'</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
<a name="L314"></a><tt class="py-lineno"> 314</tt> <tt class="py-line"> <tt class="py-string">"""The 'main' page"""</tt> </tt>
<a name="L315"></a><tt class="py-lineno"> 315</tt> <tt class="py-line"> </tt>
<a name="L316"></a><tt class="py-lineno"> 316</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_css</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'css'</tt><tt class="py-op">)</tt> </tt>
<a name="L317"></a><tt class="py-lineno"> 317</tt> <tt class="py-line"> <tt class="py-string">"""CSS stylesheet to use"""</tt> </tt>
<a name="L318"></a><tt class="py-lineno"> 318</tt> <tt class="py-line"> </tt>
<a name="L319"></a><tt class="py-lineno"> 319</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_helpfile</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'help_file'</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
<a name="L320"></a><tt class="py-lineno"> 320</tt> <tt class="py-line"> <tt class="py-string">"""Filename of file to extract help contents from"""</tt> </tt>
<a name="L321"></a><tt class="py-lineno"> 321</tt> <tt class="py-line"> </tt>
<a name="L322"></a><tt class="py-lineno"> 322</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_frames_index</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'show_frames'</tt><tt class="py-op">,</tt> <tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
<a name="L323"></a><tt class="py-lineno"> 323</tt> <tt class="py-line"> <tt class="py-string">"""Should a frames index be created?"""</tt> </tt>
<a name="L324"></a><tt class="py-lineno"> 324</tt> <tt class="py-line"> </tt>
<a name="L325"></a><tt class="py-lineno"> 325</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_show_imports</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'show_imports'</tt><tt class="py-op">,</tt> <tt class="py-name">False</tt><tt class="py-op">)</tt> </tt>
<a name="L326"></a><tt class="py-lineno"> 326</tt> <tt class="py-line"> <tt class="py-string">"""Should imports be listed?"""</tt> </tt>
<a name="L327"></a><tt class="py-lineno"> 327</tt> <tt class="py-line"> </tt>
<a name="L328"></a><tt class="py-lineno"> 328</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_propfunc_linelen</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'property_function_linelength'</tt><tt class="py-op">,</tt> <tt class="py-number">40</tt><tt class="py-op">)</tt> </tt>
<a name="L329"></a><tt class="py-lineno"> 329</tt> <tt class="py-line"> <tt class="py-string">"""[XXX] Not used!"""</tt> </tt>
<a name="L330"></a><tt class="py-lineno"> 330</tt> <tt class="py-line"> </tt>
<a name="L331"></a><tt class="py-lineno"> 331</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_variable_maxlines</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'variable_maxlines'</tt><tt class="py-op">,</tt> <tt class="py-number">8</tt><tt class="py-op">)</tt> </tt>
<a name="L332"></a><tt class="py-lineno"> 332</tt> <tt class="py-line"> <tt class="py-string">"""Max lines for variable values"""</tt> </tt>
<a name="L333"></a><tt class="py-lineno"> 333</tt> <tt class="py-line"> </tt>
<a name="L334"></a><tt class="py-lineno"> 334</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_variable_linelen</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'variable_linelength'</tt><tt class="py-op">,</tt> <tt class="py-number">70</tt><tt class="py-op">)</tt> </tt>
<a name="L335"></a><tt class="py-lineno"> 335</tt> <tt class="py-line"> <tt class="py-string">"""Max line length for variable values"""</tt> </tt>
<a name="L336"></a><tt class="py-lineno"> 336</tt> <tt class="py-line"> </tt>
<a name="L337"></a><tt class="py-lineno"> 337</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_variable_summary_linelen</tt> <tt class="py-op">=</tt> \ </tt>
<a name="L338"></a><tt class="py-lineno"> 338</tt> <tt class="py-line"> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'variable_summary_linelength'</tt><tt class="py-op">,</tt> <tt class="py-number">65</tt><tt class="py-op">)</tt> </tt>
<a name="L339"></a><tt class="py-lineno"> 339</tt> <tt class="py-line"> <tt class="py-string">"""Max length for variable value summaries"""</tt> </tt>
<a name="L340"></a><tt class="py-lineno"> 340</tt> <tt class="py-line"> </tt>
<a name="L341"></a><tt class="py-lineno"> 341</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_variable_tooltip_linelen</tt> <tt class="py-op">=</tt> \ </tt>
<a name="L342"></a><tt class="py-lineno"> 342</tt> <tt class="py-line"> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'variable_tooltip_linelength'</tt><tt class="py-op">,</tt> <tt class="py-number">600</tt><tt class="py-op">)</tt> </tt>
<a name="L343"></a><tt class="py-lineno"> 343</tt> <tt class="py-line"> <tt class="py-string">"""Max length for variable tooltips"""</tt> </tt>
<a name="L344"></a><tt class="py-lineno"> 344</tt> <tt class="py-line"> </tt>
<a name="L345"></a><tt class="py-lineno"> 345</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_inheritance</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'inheritance'</tt><tt class="py-op">,</tt> <tt class="py-string">'listed'</tt><tt class="py-op">)</tt> </tt>
<a name="L346"></a><tt class="py-lineno"> 346</tt> <tt class="py-line"> <tt class="py-string">"""How should inheritance be displayed? 'listed', 'included',</tt> </tt>
<a name="L347"></a><tt class="py-lineno"> 347</tt> <tt class="py-line"><tt class="py-string"> or 'grouped'"""</tt> </tt>
<a name="L348"></a><tt class="py-lineno"> 348</tt> <tt class="py-line"> </tt>
<a name="L349"></a><tt class="py-lineno"> 349</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_incl_sourcecode</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'include_source_code'</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L350"></a><tt class="py-lineno"> 350</tt> <tt class="py-line"> <tt class="py-string">"""Should pages be generated for source code of modules?"""</tt> </tt>
<a name="L351"></a><tt class="py-lineno"> 351</tt> <tt class="py-line"> </tt>
<a name="L352"></a><tt class="py-lineno"> 352</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_mark_docstrings</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'mark_docstrings'</tt><tt class="py-op">,</tt> <tt class="py-name">False</tt><tt class="py-op">)</tt> </tt>
<a name="L353"></a><tt class="py-lineno"> 353</tt> <tt class="py-line"> <tt class="py-string">"""Wrap <span class='docstring'>...</span> around docstrings?"""</tt> </tt>
<a name="L354"></a><tt class="py-lineno"> 354</tt> <tt class="py-line"> </tt>
<a name="L355"></a><tt class="py-lineno"> 355</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_graph_types</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'graphs'</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L356"></a><tt class="py-lineno"> 356</tt> <tt class="py-line"> <tt class="py-string">"""Graphs that we should include in our output."""</tt> </tt>
<a name="L357"></a><tt class="py-lineno"> 357</tt> <tt class="py-line"> </tt>
<a name="L358"></a><tt class="py-lineno"> 358</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_include_log</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'include_log'</tt><tt class="py-op">,</tt> <tt class="py-name">False</tt><tt class="py-op">)</tt> </tt>
<a name="L359"></a><tt class="py-lineno"> 359</tt> <tt class="py-line"> <tt class="py-string">"""Are we generating an HTML log page?"""</tt> </tt>
<a name="L360"></a><tt class="py-lineno"> 360</tt> <tt class="py-line"> </tt>
<a name="L361"></a><tt class="py-lineno"> 361</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_src_code_tab_width</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'src_code_tab_width'</tt><tt class="py-op">,</tt> <tt class="py-number">8</tt><tt class="py-op">)</tt> </tt>
<a name="L362"></a><tt class="py-lineno"> 362</tt> <tt class="py-line"> <tt class="py-string">"""Number of spaces to replace each tab with in source code</tt> </tt>
<a name="L363"></a><tt class="py-lineno"> 363</tt> <tt class="py-line"><tt class="py-string"> listings."""</tt> </tt>
<a name="L364"></a><tt class="py-lineno"> 364</tt> <tt class="py-line"> </tt>
<a name="L365"></a><tt class="py-lineno"> 365</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_callgraph_cache</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L366"></a><tt class="py-lineno"> 366</tt> <tt class="py-line"> <tt class="py-string">"""Map the callgraph L{uid<DotGraph.uid>} to their HTML</tt> </tt>
<a name="L367"></a><tt class="py-lineno"> 367</tt> <tt class="py-line"><tt class="py-string"> representation."""</tt> </tt>
<a name="L368"></a><tt class="py-lineno"> 368</tt> <tt class="py-line"> </tt>
<a name="L369"></a><tt class="py-lineno"> 369</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_redundant_details</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'redundant_details'</tt><tt class="py-op">,</tt> <tt class="py-name">False</tt><tt class="py-op">)</tt> </tt>
<a name="L370"></a><tt class="py-lineno"> 370</tt> <tt class="py-line"> <tt class="py-string">"""If true, then include objects in the details list even if all</tt> </tt>
<a name="L371"></a><tt class="py-lineno"> 371</tt> <tt class="py-line"><tt class="py-string"> info about them is already provided by the summary table."""</tt> </tt>
<a name="L372"></a><tt class="py-lineno"> 372</tt> <tt class="py-line"> </tt>
<a name="L373"></a><tt class="py-lineno"> 373</tt> <tt class="py-line"> <tt class="py-comment"># For use with select_variables():</tt> </tt>
<a name="L374"></a><tt class="py-lineno"> 374</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_show_private</tt><tt class="py-op">:</tt> </tt>
<a name="L375"></a><tt class="py-lineno"> 375</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_public_filter</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L376"></a><tt class="py-lineno"> 376</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L377"></a><tt class="py-lineno"> 377</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_public_filter</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L378"></a><tt class="py-lineno"> 378</tt> <tt class="py-line"> </tt>
<a name="L379"></a><tt class="py-lineno"> 379</tt> <tt class="py-line"> <tt class="py-comment"># Make sure inheritance has a sane value.</tt> </tt>
<a name="L380"></a><tt class="py-lineno"> 380</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_inheritance</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-string">'listed'</tt><tt class="py-op">,</tt> <tt class="py-string">'included'</tt><tt class="py-op">,</tt> <tt class="py-string">'grouped'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L381"></a><tt class="py-lineno"> 381</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">,</tt> <tt class="py-string">'Bad value for inheritance'</tt> </tt>
<a name="L382"></a><tt class="py-lineno"> 382</tt> <tt class="py-line"> </tt>
<a name="L383"></a><tt class="py-lineno"> 383</tt> <tt class="py-line"> <tt class="py-comment"># Create the project homepage link, if it was not specified.</tt> </tt>
<a name="L384"></a><tt class="py-lineno"> 384</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_prj_name</tt> <tt class="py-keyword">or</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_prj_url</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_prj_link</tt><tt class="py-op">:</tt> </tt>
<a name="L385"></a><tt class="py-lineno"> 385</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_prj_link</tt> <tt class="py-op">=</tt> <tt id="link-48" class="py-name"><a title="epydoc.util.plaintext_to_html" class="py-name" href="#" onclick="return doclink('link-48', 'plaintext_to_html', 'link-32');">plaintext_to_html</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_prj_name</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L386"></a><tt class="py-lineno"> 386</tt> <tt class="py-line"> <tt class="py-string">'Project Homepage'</tt><tt class="py-op">)</tt> </tt>
<a name="L387"></a><tt class="py-lineno"> 387</tt> <tt class="py-line"> </tt>
<a name="L388"></a><tt class="py-lineno"> 388</tt> <tt class="py-line"> <tt class="py-comment"># Add a hyperlink to _prj_url, if _prj_link doesn't already</tt> </tt>
<a name="L389"></a><tt class="py-lineno"> 389</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># contain any hyperlinks.</tt> </tt>
<a name="L390"></a><tt class="py-lineno"> 390</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_prj_link</tt> <tt class="py-keyword">and</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_prj_url</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L391"></a><tt class="py-lineno"> 391</tt> <tt class="py-line"> <tt class="py-keyword">not</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">search</tt><tt class="py-op">(</tt><tt class="py-string">r'<a[^>]*\shref'</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_prj_link</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L392"></a><tt class="py-lineno"> 392</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_prj_link</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">'<a class="navbar" target="_top" href="'</tt><tt class="py-op">+</tt> </tt>
<a name="L393"></a><tt class="py-lineno"> 393</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_prj_url</tt><tt class="py-op">+</tt><tt class="py-string">'">'</tt><tt class="py-op">+</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_prj_link</tt><tt class="py-op">+</tt><tt class="py-string">'</a>'</tt><tt class="py-op">)</tt> </tt>
<a name="L394"></a><tt class="py-lineno"> 394</tt> <tt class="py-line"> </tt>
<a name="L395"></a><tt class="py-lineno"> 395</tt> <tt class="py-line"> <tt class="py-comment"># Precompute lists & sets of APIDoc objects that we're</tt> </tt>
<a name="L396"></a><tt class="py-lineno"> 396</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># interested in.</tt> </tt>
<a name="L397"></a><tt class="py-lineno"> 397</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">valdocs</tt> <tt class="py-op">=</tt> <tt class="py-name">valdocs</tt> <tt class="py-op">=</tt> <tt id="link-49" class="py-name" targets="Function epydoc.compat.sorted()=epydoc.compat-module.html#sorted"><a title="epydoc.compat.sorted" class="py-name" href="#" onclick="return doclink('link-49', 'sorted', 'link-49');">sorted</a></tt><tt class="py-op">(</tt><tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt id="link-50" class="py-name" targets="Method epydoc.apidoc.DocIndex.reachable_valdocs()=epydoc.apidoc.DocIndex-class.html#reachable_valdocs,Function epydoc.apidoc.reachable_valdocs()=epydoc.apidoc-module.html#reachable_valdocs"><a title="epydoc.apidoc.DocIndex.reachable_valdocs
epydoc.apidoc.reachable_valdocs" class="py-name" href="#" onclick="return doclink('link-50', 'reachable_valdocs', 'link-50');">reachable_valdocs</a></tt><tt class="py-op">(</tt> </tt>
<a name="L398"></a><tt class="py-lineno"> 398</tt> <tt class="py-line"> <tt id="link-51" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.imports=epydoc.apidoc.ModuleDoc-class.html#imports"><a title="epydoc.apidoc.ModuleDoc.imports" class="py-name" href="#" onclick="return doclink('link-51', 'imports', 'link-51');">imports</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-name">packages</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt id="link-52" class="py-name" targets="Variable epydoc.apidoc.ClassDoc.bases=epydoc.apidoc.ClassDoc-class.html#bases"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-52', 'bases', 'link-52');">bases</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt id="link-53" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.submodules=epydoc.apidoc.ModuleDoc-class.html#submodules"><a title="epydoc.apidoc.ModuleDoc.submodules" class="py-name" href="#" onclick="return doclink('link-53', 'submodules', 'link-53');">submodules</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L399"></a><tt class="py-lineno"> 399</tt> <tt class="py-line"> <tt id="link-54" class="py-name" targets="Variable epydoc.apidoc.ClassDoc.subclasses=epydoc.apidoc.ClassDoc-class.html#subclasses"><a title="epydoc.apidoc.ClassDoc.subclasses" class="py-name" href="#" onclick="return doclink('link-54', 'subclasses', 'link-54');">subclasses</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-name">private</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_show_private</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L400"></a><tt class="py-lineno"> 400</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">module_list</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">d</tt> <tt class="py-keyword">for</tt> <tt class="py-name">d</tt> <tt class="py-keyword">in</tt> <tt class="py-name">valdocs</tt> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">d</tt><tt class="py-op">,</tt> <tt id="link-55" class="py-name" targets="Class epydoc.apidoc.ModuleDoc=epydoc.apidoc.ModuleDoc-class.html"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-55', 'ModuleDoc', 'link-55');">ModuleDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L401"></a><tt class="py-lineno"> 401</tt> <tt class="py-line"> <tt class="py-string">"""The list of L{ModuleDoc}s for the documented modules."""</tt> </tt>
<a name="L402"></a><tt class="py-lineno"> 402</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">module_set</tt> <tt class="py-op">=</tt> <tt class="py-name">set</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">module_list</tt><tt class="py-op">)</tt> </tt>
<a name="L403"></a><tt class="py-lineno"> 403</tt> <tt class="py-line"> <tt class="py-string">"""The set of L{ModuleDoc}s for the documented modules."""</tt> </tt>
<a name="L404"></a><tt class="py-lineno"> 404</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">class_list</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">d</tt> <tt class="py-keyword">for</tt> <tt class="py-name">d</tt> <tt class="py-keyword">in</tt> <tt class="py-name">valdocs</tt> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">d</tt><tt class="py-op">,</tt> <tt id="link-56" class="py-name" targets="Class epydoc.apidoc.ClassDoc=epydoc.apidoc.ClassDoc-class.html"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-56', 'ClassDoc', 'link-56');">ClassDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L405"></a><tt class="py-lineno"> 405</tt> <tt class="py-line"> <tt class="py-string">"""The list of L{ClassDoc}s for the documented classes."""</tt> </tt>
<a name="L406"></a><tt class="py-lineno"> 406</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">class_set</tt> <tt class="py-op">=</tt> <tt class="py-name">set</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">class_list</tt><tt class="py-op">)</tt> </tt>
<a name="L407"></a><tt class="py-lineno"> 407</tt> <tt class="py-line"> <tt class="py-string">"""The set of L{ClassDoc}s for the documented classes."""</tt> </tt>
<a name="L408"></a><tt class="py-lineno"> 408</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">routine_list</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">d</tt> <tt class="py-keyword">for</tt> <tt class="py-name">d</tt> <tt class="py-keyword">in</tt> <tt class="py-name">valdocs</tt> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">d</tt><tt class="py-op">,</tt> <tt id="link-57" class="py-name" targets="Class epydoc.apidoc.RoutineDoc=epydoc.apidoc.RoutineDoc-class.html"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-57', 'RoutineDoc', 'link-57');">RoutineDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L409"></a><tt class="py-lineno"> 409</tt> <tt class="py-line"> <tt class="py-string">"""The list of L{RoutineDoc}s for the documented routines."""</tt> </tt>
<a name="L410"></a><tt class="py-lineno"> 410</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">indexed_docs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L411"></a><tt class="py-lineno"> 411</tt> <tt class="py-line"> <tt class="py-string">"""The list of L{APIDoc}s for variables and values that should</tt> </tt>
<a name="L412"></a><tt class="py-lineno"> 412</tt> <tt class="py-line"><tt class="py-string"> be included in the index."""</tt> </tt>
<a name="L413"></a><tt class="py-lineno"> 413</tt> <tt class="py-line"> </tt>
<a name="L414"></a><tt class="py-lineno"> 414</tt> <tt class="py-line"> <tt class="py-comment"># URL for 'trees' page</tt> </tt>
<a name="L415"></a><tt class="py-lineno"> 415</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">module_list</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_trees_url</tt> <tt class="py-op">=</tt> <tt class="py-string">'module-tree.html'</tt> </tt>
<a name="L416"></a><tt class="py-lineno"> 416</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_trees_url</tt> <tt class="py-op">=</tt> <tt class="py-string">'class-tree.html'</tt> </tt>
<a name="L417"></a><tt class="py-lineno"> 417</tt> <tt class="py-line"> </tt>
<a name="L418"></a><tt class="py-lineno"> 418</tt> <tt class="py-line"> <tt class="py-comment"># Construct the value for self.indexed_docs.</tt> </tt>
<a name="L419"></a><tt class="py-lineno"> 419</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">indexed_docs</tt> <tt class="py-op">+=</tt> <tt class="py-op">[</tt><tt class="py-name">d</tt> <tt class="py-keyword">for</tt> <tt class="py-name">d</tt> <tt class="py-keyword">in</tt> <tt class="py-name">valdocs</tt> </tt>
<a name="L420"></a><tt class="py-lineno"> 420</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">d</tt><tt class="py-op">,</tt> <tt id="link-58" class="py-name" targets="Class epydoc.apidoc.GenericValueDoc=epydoc.apidoc.GenericValueDoc-class.html"><a title="epydoc.apidoc.GenericValueDoc" class="py-name" href="#" onclick="return doclink('link-58', 'GenericValueDoc', 'link-58');">GenericValueDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L421"></a><tt class="py-lineno"> 421</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">valdocs</tt><tt class="py-op">:</tt> </tt>
<a name="L422"></a><tt class="py-lineno"> 422</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-59" class="py-name" targets="Class epydoc.apidoc.NamespaceDoc=epydoc.apidoc.NamespaceDoc-class.html"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-59', 'NamespaceDoc', 'link-59');">NamespaceDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L423"></a><tt class="py-lineno"> 423</tt> <tt class="py-line"> <tt class="py-comment"># add any vars with generic values; but don't include</tt> </tt>
<a name="L424"></a><tt class="py-lineno"> 424</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># inherited vars.</tt> </tt>
<a name="L425"></a><tt class="py-lineno"> 425</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">indexed_docs</tt> <tt class="py-op">+=</tt> <tt class="py-op">[</tt><tt class="py-name">d</tt> <tt class="py-keyword">for</tt> <tt class="py-name">d</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-60" class="py-name" targets="Variable epydoc.apidoc.NamespaceDoc.variables=epydoc.apidoc.NamespaceDoc-class.html#variables"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-60', 'variables', 'link-60');">variables</a></tt><tt class="py-op">.</tt><tt class="py-name">values</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-keyword">if</tt> </tt>
<a name="L426"></a><tt class="py-lineno"> 426</tt> <tt class="py-line"> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">d</tt><tt class="py-op">.</tt><tt id="link-61" class="py-name" targets="Variable epydoc.apidoc.VariableDoc.value=epydoc.apidoc.VariableDoc-class.html#value"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-61', 'value', 'link-61');">value</a></tt><tt class="py-op">,</tt> <tt id="link-62" class="py-name"><a title="epydoc.apidoc.GenericValueDoc" class="py-name" href="#" onclick="return doclink('link-62', 'GenericValueDoc', 'link-58');">GenericValueDoc</a></tt><tt class="py-op">)</tt> </tt>
<a name="L427"></a><tt class="py-lineno"> 427</tt> <tt class="py-line"> <tt class="py-keyword">and</tt> <tt class="py-name">d</tt><tt class="py-op">.</tt><tt id="link-63" class="py-name" targets="Method epydoc.apidoc.DocIndex.container()=epydoc.apidoc.DocIndex-class.html#container,Method epydoc.apidoc.DottedName.container()=epydoc.apidoc.DottedName-class.html#container,Variable epydoc.apidoc.VariableDoc.container=epydoc.apidoc.VariableDoc-class.html#container"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-63', 'container', 'link-63');">container</a></tt> <tt class="py-op">==</tt> <tt class="py-name">doc</tt><tt class="py-op">]</tt> </tt>
<a name="L428"></a><tt class="py-lineno"> 428</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">indexed_docs</tt><tt class="py-op">.</tt><tt class="py-name">sort</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L429"></a><tt class="py-lineno"> 429</tt> <tt class="py-line"> </tt>
<a name="L430"></a><tt class="py-lineno"> 430</tt> <tt class="py-line"> <tt class="py-comment"># Figure out the url for the top page.</tt> </tt>
<a name="L431"></a><tt class="py-lineno"> 431</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_top_page_url</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-64" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter._find_top_page()=epydoc.docwriter.html.HTMLWriter-class.html#_find_top_page"><a title="epydoc.docwriter.html.HTMLWriter._find_top_page" class="py-name" href="#" onclick="return doclink('link-64', '_find_top_page', 'link-64');">_find_top_page</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_top_page</tt><tt class="py-op">)</tt> </tt>
<a name="L432"></a><tt class="py-lineno"> 432</tt> <tt class="py-line"> </tt>
<a name="L433"></a><tt class="py-lineno"> 433</tt> <tt class="py-line"> <tt class="py-comment"># Decide whether or not to split the identifier index.</tt> </tt>
<a name="L434"></a><tt class="py-lineno"> 434</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_split_ident_index</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">indexed_docs</tt><tt class="py-op">)</tt> <tt class="py-op">>=</tt> </tt>
<a name="L435"></a><tt class="py-lineno"> 435</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-65" class="py-name" targets="Variable epydoc.docwriter.html.HTMLWriter.SPLIT_IDENT_INDEX_SIZE=epydoc.docwriter.html.HTMLWriter-class.html#SPLIT_IDENT_INDEX_SIZE"><a title="epydoc.docwriter.html.HTMLWriter.SPLIT_IDENT_INDEX_SIZE" class="py-name" href="#" onclick="return doclink('link-65', 'SPLIT_IDENT_INDEX_SIZE', 'link-65');">SPLIT_IDENT_INDEX_SIZE</a></tt><tt class="py-op">)</tt> </tt>
<a name="L436"></a><tt class="py-lineno"> 436</tt> <tt class="py-line"> </tt>
<a name="L437"></a><tt class="py-lineno"> 437</tt> <tt class="py-line"> <tt class="py-comment"># Figure out how many output files there will be (for progress</tt> </tt>
<a name="L438"></a><tt class="py-lineno"> 438</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># reporting).</tt> </tt>
<a name="L439"></a><tt class="py-lineno"> 439</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">modules_with_sourcecode</tt> <tt class="py-op">=</tt> <tt class="py-name">set</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L440"></a><tt class="py-lineno"> 440</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">module_list</tt><tt class="py-op">:</tt> </tt>
<a name="L441"></a><tt class="py-lineno"> 441</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-66" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-66', 'ModuleDoc', 'link-55');">ModuleDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt id="link-67" class="py-name"><a title="epydoc.util.is_src_filename" class="py-name" href="#" onclick="return doclink('link-67', 'is_src_filename', 'link-33');">is_src_filename</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-68" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.filename=epydoc.apidoc.ModuleDoc-class.html#filename"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-68', 'filename', 'link-68');">filename</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L442"></a><tt class="py-lineno"> 442</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">modules_with_sourcecode</tt><tt class="py-op">.</tt><tt class="py-name">add</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L443"></a><tt class="py-lineno"> 443</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_num_files</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">class_list</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">module_list</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> </tt>
<a name="L444"></a><tt class="py-lineno"> 444</tt> <tt class="py-line"> <tt class="py-number">10</tt> <tt class="py-op">+</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-69" class="py-name" targets="Variable epydoc.docwriter.html.HTMLWriter.METADATA_INDICES=epydoc.docwriter.html.HTMLWriter-class.html#METADATA_INDICES"><a title="epydoc.docwriter.html.HTMLWriter.METADATA_INDICES" class="py-name" href="#" onclick="return doclink('link-69', 'METADATA_INDICES', 'link-69');">METADATA_INDICES</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L445"></a><tt class="py-lineno"> 445</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_frames_index</tt><tt class="py-op">:</tt> </tt>
<a name="L446"></a><tt class="py-lineno"> 446</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_num_files</tt> <tt class="py-op">+=</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">module_list</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-number">3</tt> </tt>
<a name="L447"></a><tt class="py-lineno"> 447</tt> <tt class="py-line"> </tt>
<a name="L448"></a><tt class="py-lineno"> 448</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_incl_sourcecode</tt><tt class="py-op">:</tt> </tt>
<a name="L449"></a><tt class="py-lineno"> 449</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_num_files</tt> <tt class="py-op">+=</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">modules_with_sourcecode</tt><tt class="py-op">)</tt> </tt>
<a name="L450"></a><tt class="py-lineno"> 450</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_split_ident_index</tt><tt class="py-op">:</tt> </tt>
<a name="L451"></a><tt class="py-lineno"> 451</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_num_files</tt> <tt class="py-op">+=</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-70" class="py-name" targets="Variable epydoc.docwriter.html.HTMLWriter.LETTERS=epydoc.docwriter.html.HTMLWriter-class.html#LETTERS"><a title="epydoc.docwriter.html.HTMLWriter.LETTERS" class="py-name" href="#" onclick="return doclink('link-70', 'LETTERS', 'link-70');">LETTERS</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L452"></a><tt class="py-lineno"> 452</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter._find_top_page"></a><div id="HTMLWriter._find_top_page-def"><a name="L453"></a><tt class="py-lineno"> 453</tt> <a class="py-toggle" href="#" id="HTMLWriter._find_top_page-toggle" onclick="return toggle('HTMLWriter._find_top_page');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#_find_top_page">_find_top_page</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">pagename</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter._find_top_page-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter._find_top_page-expanded"><a name="L454"></a><tt class="py-lineno"> 454</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L455"></a><tt class="py-lineno"> 455</tt> <tt class="py-line"><tt class="py-docstring"> Find the top page for the API documentation. This page is</tt> </tt>
<a name="L456"></a><tt class="py-lineno"> 456</tt> <tt class="py-line"><tt class="py-docstring"> used as the default page shown in the main frame, when frames</tt> </tt>
<a name="L457"></a><tt class="py-lineno"> 457</tt> <tt class="py-line"><tt class="py-docstring"> are used. When frames are not used, this page is copied to </tt> </tt>
<a name="L458"></a><tt class="py-lineno"> 458</tt> <tt class="py-line"><tt class="py-docstring"> C{index.html}.</tt> </tt>
<a name="L459"></a><tt class="py-lineno"> 459</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L460"></a><tt class="py-lineno"> 460</tt> <tt class="py-line"><tt class="py-docstring"> @param pagename: The name of the page, as specified by the</tt> </tt>
<a name="L461"></a><tt class="py-lineno"> 461</tt> <tt class="py-line"><tt class="py-docstring"> keyword argument C{top} to the constructor.</tt> </tt>
<a name="L462"></a><tt class="py-lineno"> 462</tt> <tt class="py-line"><tt class="py-docstring"> @type pagename: C{string}</tt> </tt>
<a name="L463"></a><tt class="py-lineno"> 463</tt> <tt class="py-line"><tt class="py-docstring"> @return: The URL of the top page.</tt> </tt>
<a name="L464"></a><tt class="py-lineno"> 464</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{string}</tt> </tt>
<a name="L465"></a><tt class="py-lineno"> 465</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L466"></a><tt class="py-lineno"> 466</tt> <tt class="py-line"> <tt class="py-comment"># If a page name was specified, then we need to figure out</tt> </tt>
<a name="L467"></a><tt class="py-lineno"> 467</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># what it points to.</tt> </tt>
<a name="L468"></a><tt class="py-lineno"> 468</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">pagename</tt><tt class="py-op">:</tt> </tt>
<a name="L469"></a><tt class="py-lineno"> 469</tt> <tt class="py-line"> <tt class="py-comment"># If it's a URL, then use it directly.</tt> </tt>
<a name="L470"></a><tt class="py-lineno"> 470</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">pagename</tt><tt class="py-op">.</tt><tt class="py-name">lower</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">'http:'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L471"></a><tt class="py-lineno"> 471</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">pagename</tt> </tt>
<a name="L472"></a><tt class="py-lineno"> 472</tt> <tt class="py-line"> </tt>
<a name="L473"></a><tt class="py-lineno"> 473</tt> <tt class="py-line"> <tt class="py-comment"># If it's an object, then use that object's page.</tt> </tt>
<a name="L474"></a><tt class="py-lineno"> 474</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L475"></a><tt class="py-lineno"> 475</tt> <tt class="py-line"> <tt class="py-name">doc</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt id="link-71" class="py-name" targets="Method epydoc.apidoc.DocIndex.get_valdoc()=epydoc.apidoc.DocIndex-class.html#get_valdoc"><a title="epydoc.apidoc.DocIndex.get_valdoc" class="py-name" href="#" onclick="return doclink('link-71', 'get_valdoc', 'link-71');">get_valdoc</a></tt><tt class="py-op">(</tt><tt class="py-name">pagename</tt><tt class="py-op">)</tt> </tt>
<a name="L476"></a><tt class="py-lineno"> 476</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-72" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.url()=epydoc.docwriter.html.HTMLWriter-class.html#url"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-72', 'url', 'link-72');">url</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L477"></a><tt class="py-lineno"> 477</tt> <tt class="py-line"> <tt class="py-keyword">except</tt><tt class="py-op">:</tt> </tt>
<a name="L478"></a><tt class="py-lineno"> 478</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
<a name="L479"></a><tt class="py-lineno"> 479</tt> <tt class="py-line"> </tt>
<a name="L480"></a><tt class="py-lineno"> 480</tt> <tt class="py-line"> <tt class="py-comment"># Otherwise, give up.</tt> </tt>
<a name="L481"></a><tt class="py-lineno"> 481</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-73" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-73', 'log', 'link-29');">log</a></tt><tt class="py-op">.</tt><tt id="link-74" class="py-name" targets="Method epydoc.checker.DocChecker.warning()=epydoc.checker.DocChecker-class.html#warning,Function epydoc.log.warning()=epydoc.log-module.html#warning"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-74', 'warning', 'link-74');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">'Could not find top page %r; using %s '</tt> </tt>
<a name="L482"></a><tt class="py-lineno"> 482</tt> <tt class="py-line"> <tt class="py-string">'instead'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">pagename</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_trees_url</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L483"></a><tt class="py-lineno"> 483</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_trees_url</tt> </tt>
<a name="L484"></a><tt class="py-lineno"> 484</tt> <tt class="py-line"> </tt>
<a name="L485"></a><tt class="py-lineno"> 485</tt> <tt class="py-line"> <tt class="py-comment"># If no page name was specified, then try to choose one</tt> </tt>
<a name="L486"></a><tt class="py-lineno"> 486</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># automatically.</tt> </tt>
<a name="L487"></a><tt class="py-lineno"> 487</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L488"></a><tt class="py-lineno"> 488</tt> <tt class="py-line"> <tt class="py-name">root</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">val_doc</tt> <tt class="py-keyword">for</tt> <tt class="py-name">val_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt class="py-name">root</tt> </tt>
<a name="L489"></a><tt class="py-lineno"> 489</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt id="link-75" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-75', 'ClassDoc', 'link-56');">ClassDoc</a></tt><tt class="py-op">,</tt> <tt id="link-76" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-76', 'ModuleDoc', 'link-55');">ModuleDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L490"></a><tt class="py-lineno"> 490</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">root</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L491"></a><tt class="py-lineno"> 491</tt> <tt class="py-line"> <tt class="py-comment"># No docs?? Try the trees page.</tt> </tt>
<a name="L492"></a><tt class="py-lineno"> 492</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_trees_url</tt> </tt>
<a name="L493"></a><tt class="py-lineno"> 493</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">root</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">1</tt><tt class="py-op">:</tt> </tt>
<a name="L494"></a><tt class="py-lineno"> 494</tt> <tt class="py-line"> <tt class="py-comment"># One item in the root; use that.</tt> </tt>
<a name="L495"></a><tt class="py-lineno"> 495</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-77" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-77', 'url', 'link-72');">url</a></tt><tt class="py-op">(</tt><tt class="py-name">root</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L496"></a><tt class="py-lineno"> 496</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L497"></a><tt class="py-lineno"> 497</tt> <tt class="py-line"> <tt class="py-comment"># Multiple root items; if they're all in one package,</tt> </tt>
<a name="L498"></a><tt class="py-lineno"> 498</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># then use that. Otherwise, use self._trees_url</tt> </tt>
<a name="L499"></a><tt class="py-lineno"> 499</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">root</tt> <tt class="py-op">=</tt> <tt id="link-78" class="py-name"><a title="epydoc.compat.sorted" class="py-name" href="#" onclick="return doclink('link-78', 'sorted', 'link-49');">sorted</a></tt><tt class="py-op">(</tt><tt class="py-name">root</tt><tt class="py-op">,</tt> <tt id="link-79" class="py-name" targets="Variable epydoc.cli.key=epydoc.cli-module.html#key"><a title="epydoc.cli.key" class="py-name" href="#" onclick="return doclink('link-79', 'key', 'link-79');">key</a></tt><tt class="py-op">=</tt><tt class="py-keyword">lambda</tt> <tt id="link-80" class="py-name" targets="Variable epydoc.markup.restructuredtext._EpydocReader.v=epydoc.markup.restructuredtext._EpydocReader-class.html#v"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-80', 'v', 'link-80');">v</a></tt><tt class="py-op">:</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-81" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-81', 'v', 'link-80');">v</a></tt><tt class="py-op">.</tt><tt id="link-82" class="py-name" targets="Variable epydoc.apidoc.GenericValueDoc.canonical_name=epydoc.apidoc.GenericValueDoc-class.html#canonical_name,Variable epydoc.apidoc.ValueDoc.canonical_name=epydoc.apidoc.ValueDoc-class.html#canonical_name,Variable epydoc.apidoc.VariableDoc.canonical_name=epydoc.apidoc.VariableDoc-class.html#canonical_name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-82', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L500"></a><tt class="py-lineno"> 500</tt> <tt class="py-line"> <tt class="py-name">top</tt> <tt class="py-op">=</tt> <tt class="py-name">root</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L501"></a><tt class="py-lineno"> 501</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">root</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L502"></a><tt class="py-lineno"> 502</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">top</tt><tt class="py-op">.</tt><tt id="link-83" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-83', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">.</tt><tt id="link-84" class="py-name" targets="Method epydoc.apidoc.DottedName.dominates()=epydoc.apidoc.DottedName-class.html#dominates"><a title="epydoc.apidoc.DottedName.dominates" class="py-name" href="#" onclick="return doclink('link-84', 'dominates', 'link-84');">dominates</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-85" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-85', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L503"></a><tt class="py-lineno"> 503</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_trees_url</tt> </tt>
<a name="L504"></a><tt class="py-lineno"> 504</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L505"></a><tt class="py-lineno"> 505</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-86" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-86', 'url', 'link-72');">url</a></tt><tt class="py-op">(</tt><tt class="py-name">top</tt><tt class="py-op">)</tt> </tt>
</div><a name="L506"></a><tt class="py-lineno"> 506</tt> <tt class="py-line"> </tt>
<a name="L507"></a><tt class="py-lineno"> 507</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L508"></a><tt class="py-lineno"> 508</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ 1. Interface Methods</tt> </tt>
<a name="L509"></a><tt class="py-lineno"> 509</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L510"></a><tt class="py-lineno"> 510</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="HTMLWriter.write"></a><div id="HTMLWriter.write-def"><a name="L511"></a><tt class="py-lineno"> 511</tt> <a class="py-toggle" href="#" id="HTMLWriter.write-toggle" onclick="return toggle('HTMLWriter.write');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write">write</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">directory</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write-expanded"><a name="L512"></a><tt class="py-lineno"> 512</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L513"></a><tt class="py-lineno"> 513</tt> <tt class="py-line"><tt class="py-docstring"> Write the documentation to the given directory.</tt> </tt>
<a name="L514"></a><tt class="py-lineno"> 514</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L515"></a><tt class="py-lineno"> 515</tt> <tt class="py-line"><tt class="py-docstring"> @type directory: C{string}</tt> </tt>
<a name="L516"></a><tt class="py-lineno"> 516</tt> <tt class="py-line"><tt class="py-docstring"> @param directory: The directory to which output should be</tt> </tt>
<a name="L517"></a><tt class="py-lineno"> 517</tt> <tt class="py-line"><tt class="py-docstring"> written. If no directory is specified, output will be</tt> </tt>
<a name="L518"></a><tt class="py-lineno"> 518</tt> <tt class="py-line"><tt class="py-docstring"> written to the current directory. If the directory does</tt> </tt>
<a name="L519"></a><tt class="py-lineno"> 519</tt> <tt class="py-line"><tt class="py-docstring"> not exist, it will be created.</tt> </tt>
<a name="L520"></a><tt class="py-lineno"> 520</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{None}</tt> </tt>
<a name="L521"></a><tt class="py-lineno"> 521</tt> <tt class="py-line"><tt class="py-docstring"> @raise OSError: If C{directory} cannot be created.</tt> </tt>
<a name="L522"></a><tt class="py-lineno"> 522</tt> <tt class="py-line"><tt class="py-docstring"> @raise OSError: If any file cannot be created or written to.</tt> </tt>
<a name="L523"></a><tt class="py-lineno"> 523</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L524"></a><tt class="py-lineno"> 524</tt> <tt class="py-line"> <tt class="py-comment"># For progress reporting:</tt> </tt>
<a name="L525"></a><tt class="py-lineno"> 525</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_files_written</tt> <tt class="py-op">=</tt> <tt class="py-number">0.</tt> </tt>
<a name="L526"></a><tt class="py-lineno"> 526</tt> <tt class="py-line"> </tt>
<a name="L527"></a><tt class="py-lineno"> 527</tt> <tt class="py-line"> <tt class="py-comment"># Set the default values for ValueDoc formatted representations.</tt> </tt>
<a name="L528"></a><tt class="py-lineno"> 528</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">orig_valdoc_defaults</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt id="link-87" class="py-name" targets="Class epydoc.apidoc.ValueDoc=epydoc.apidoc.ValueDoc-class.html"><a title="epydoc.apidoc.ValueDoc" class="py-name" href="#" onclick="return doclink('link-87', 'ValueDoc', 'link-87');">ValueDoc</a></tt><tt class="py-op">.</tt><tt id="link-88" class="py-name" targets="Variable epydoc.apidoc.ValueDoc.SUMMARY_REPR_LINELEN=epydoc.apidoc.ValueDoc-class.html#SUMMARY_REPR_LINELEN"><a title="epydoc.apidoc.ValueDoc.SUMMARY_REPR_LINELEN" class="py-name" href="#" onclick="return doclink('link-88', 'SUMMARY_REPR_LINELEN', 'link-88');">SUMMARY_REPR_LINELEN</a></tt><tt class="py-op">,</tt> </tt>
<a name="L529"></a><tt class="py-lineno"> 529</tt> <tt class="py-line"> <tt id="link-89" class="py-name"><a title="epydoc.apidoc.ValueDoc" class="py-name" href="#" onclick="return doclink('link-89', 'ValueDoc', 'link-87');">ValueDoc</a></tt><tt class="py-op">.</tt><tt id="link-90" class="py-name" targets="Variable epydoc.apidoc.ValueDoc.REPR_LINELEN=epydoc.apidoc.ValueDoc-class.html#REPR_LINELEN"><a title="epydoc.apidoc.ValueDoc.REPR_LINELEN" class="py-name" href="#" onclick="return doclink('link-90', 'REPR_LINELEN', 'link-90');">REPR_LINELEN</a></tt><tt class="py-op">,</tt> </tt>
<a name="L530"></a><tt class="py-lineno"> 530</tt> <tt class="py-line"> <tt id="link-91" class="py-name"><a title="epydoc.apidoc.ValueDoc" class="py-name" href="#" onclick="return doclink('link-91', 'ValueDoc', 'link-87');">ValueDoc</a></tt><tt class="py-op">.</tt><tt id="link-92" class="py-name" targets="Variable epydoc.apidoc.ValueDoc.REPR_MAXLINES=epydoc.apidoc.ValueDoc-class.html#REPR_MAXLINES"><a title="epydoc.apidoc.ValueDoc.REPR_MAXLINES" class="py-name" href="#" onclick="return doclink('link-92', 'REPR_MAXLINES', 'link-92');">REPR_MAXLINES</a></tt><tt class="py-op">)</tt> </tt>
<a name="L531"></a><tt class="py-lineno"> 531</tt> <tt class="py-line"> <tt id="link-93" class="py-name"><a title="epydoc.apidoc.ValueDoc" class="py-name" href="#" onclick="return doclink('link-93', 'ValueDoc', 'link-87');">ValueDoc</a></tt><tt class="py-op">.</tt><tt id="link-94" class="py-name"><a title="epydoc.apidoc.ValueDoc.SUMMARY_REPR_LINELEN" class="py-name" href="#" onclick="return doclink('link-94', 'SUMMARY_REPR_LINELEN', 'link-88');">SUMMARY_REPR_LINELEN</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_variable_summary_linelen</tt> </tt>
<a name="L532"></a><tt class="py-lineno"> 532</tt> <tt class="py-line"> <tt id="link-95" class="py-name"><a title="epydoc.apidoc.ValueDoc" class="py-name" href="#" onclick="return doclink('link-95', 'ValueDoc', 'link-87');">ValueDoc</a></tt><tt class="py-op">.</tt><tt id="link-96" class="py-name"><a title="epydoc.apidoc.ValueDoc.REPR_LINELEN" class="py-name" href="#" onclick="return doclink('link-96', 'REPR_LINELEN', 'link-90');">REPR_LINELEN</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_variable_linelen</tt> </tt>
<a name="L533"></a><tt class="py-lineno"> 533</tt> <tt class="py-line"> <tt id="link-97" class="py-name"><a title="epydoc.apidoc.ValueDoc" class="py-name" href="#" onclick="return doclink('link-97', 'ValueDoc', 'link-87');">ValueDoc</a></tt><tt class="py-op">.</tt><tt id="link-98" class="py-name"><a title="epydoc.apidoc.ValueDoc.REPR_MAXLINES" class="py-name" href="#" onclick="return doclink('link-98', 'REPR_MAXLINES', 'link-92');">REPR_MAXLINES</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_variable_maxlines</tt> </tt>
<a name="L534"></a><tt class="py-lineno"> 534</tt> <tt class="py-line"> </tt>
<a name="L535"></a><tt class="py-lineno"> 535</tt> <tt class="py-line"> <tt class="py-comment"># Use an image for the crarr symbol.</tt> </tt>
<a name="L536"></a><tt class="py-lineno"> 536</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">from</tt> <tt id="link-99" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-99', 'epydoc', 'link-0');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-100" class="py-name"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-100', 'markup', 'link-6');">markup</a></tt><tt class="py-op">.</tt><tt id="link-101" class="py-name"><a title="epydoc.markup.epytext" class="py-name" href="#" onclick="return doclink('link-101', 'epytext', 'link-9');">epytext</a></tt> <tt class="py-keyword">import</tt> <tt id="link-102" class="py-name" targets="Class epydoc.markup.epytext.ParsedEpytextDocstring=epydoc.markup.epytext.ParsedEpytextDocstring-class.html"><a title="epydoc.markup.epytext.ParsedEpytextDocstring" class="py-name" href="#" onclick="return doclink('link-102', 'ParsedEpytextDocstring', 'link-102');">ParsedEpytextDocstring</a></tt> </tt>
<a name="L537"></a><tt class="py-lineno"> 537</tt> <tt class="py-line"> <tt class="py-name">orig_crarr_html</tt> <tt class="py-op">=</tt> <tt id="link-103" class="py-name"><a title="epydoc.markup.epytext.ParsedEpytextDocstring" class="py-name" href="#" onclick="return doclink('link-103', 'ParsedEpytextDocstring', 'link-102');">ParsedEpytextDocstring</a></tt><tt class="py-op">.</tt><tt id="link-104" class="py-name" targets="Variable epydoc.markup.epytext.ParsedEpytextDocstring.SYMBOL_TO_HTML=epydoc.markup.epytext.ParsedEpytextDocstring-class.html#SYMBOL_TO_HTML"><a title="epydoc.markup.epytext.ParsedEpytextDocstring.SYMBOL_TO_HTML" class="py-name" href="#" onclick="return doclink('link-104', 'SYMBOL_TO_HTML', 'link-104');">SYMBOL_TO_HTML</a></tt><tt class="py-op">[</tt><tt class="py-string">'crarr'</tt><tt class="py-op">]</tt> </tt>
<a name="L538"></a><tt class="py-lineno"> 538</tt> <tt class="py-line"> <tt id="link-105" class="py-name"><a title="epydoc.markup.epytext.ParsedEpytextDocstring" class="py-name" href="#" onclick="return doclink('link-105', 'ParsedEpytextDocstring', 'link-102');">ParsedEpytextDocstring</a></tt><tt class="py-op">.</tt><tt id="link-106" class="py-name"><a title="epydoc.markup.epytext.ParsedEpytextDocstring.SYMBOL_TO_HTML" class="py-name" href="#" onclick="return doclink('link-106', 'SYMBOL_TO_HTML', 'link-104');">SYMBOL_TO_HTML</a></tt><tt class="py-op">[</tt><tt class="py-string">'crarr'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt> </tt>
<a name="L539"></a><tt class="py-lineno"> 539</tt> <tt class="py-line"> <tt class="py-string">r'<span class="variable-linewrap">'</tt> </tt>
<a name="L540"></a><tt class="py-lineno"> 540</tt> <tt class="py-line"> <tt class="py-string">r'<img src="crarr.png" alt="\" /></span>'</tt><tt class="py-op">)</tt> </tt>
<a name="L541"></a><tt class="py-lineno"> 541</tt> <tt class="py-line"> </tt>
<a name="L542"></a><tt class="py-lineno"> 542</tt> <tt class="py-line"> <tt class="py-comment"># Keep track of failed xrefs, and report them at the end.</tt> </tt>
<a name="L543"></a><tt class="py-lineno"> 543</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_failed_xrefs</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L544"></a><tt class="py-lineno"> 544</tt> <tt class="py-line"> </tt>
<a name="L545"></a><tt class="py-lineno"> 545</tt> <tt class="py-line"> <tt class="py-comment"># Create destination directories, if necessary</tt> </tt>
<a name="L546"></a><tt class="py-lineno"> 546</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">directory</tt><tt class="py-op">:</tt> <tt class="py-name">directory</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">curdir</tt> </tt>
<a name="L547"></a><tt class="py-lineno"> 547</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-107" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter._mkdir()=epydoc.docwriter.html.HTMLWriter-class.html#_mkdir,Method epydoc.docwriter.latex.LatexWriter._mkdir()=epydoc.docwriter.latex.LatexWriter-class.html#_mkdir"><a title="epydoc.docwriter.html.HTMLWriter._mkdir
epydoc.docwriter.latex.LatexWriter._mkdir" class="py-name" href="#" onclick="return doclink('link-107', '_mkdir', 'link-107');">_mkdir</a></tt><tt class="py-op">(</tt><tt class="py-name">directory</tt><tt class="py-op">)</tt> </tt>
<a name="L548"></a><tt class="py-lineno"> 548</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_directory</tt> <tt class="py-op">=</tt> <tt class="py-name">directory</tt> </tt>
<a name="L549"></a><tt class="py-lineno"> 549</tt> <tt class="py-line"> </tt>
<a name="L550"></a><tt class="py-lineno"> 550</tt> <tt class="py-line"> <tt class="py-comment"># Write the CSS file.</tt> </tt>
<a name="L551"></a><tt class="py-lineno"> 551</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_files_written</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L552"></a><tt class="py-lineno"> 552</tt> <tt class="py-line"> <tt id="link-108" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-108', 'log', 'link-29');">log</a></tt><tt class="py-op">.</tt><tt id="link-109" class="py-name" targets="Method epydoc.cli.ConsoleLogger.progress()=epydoc.cli.ConsoleLogger-class.html#progress,Method epydoc.cli.UnifiedProgressConsoleLogger.progress()=epydoc.cli.UnifiedProgressConsoleLogger-class.html#progress,Method epydoc.docbuilder._ProgressEstimator.progress()=epydoc.docbuilder._ProgressEstimator-class.html#progress,Method epydoc.gui.GUILogger.progress()=epydoc.gui.GUILogger-class.html#progress,Method epydoc.log.Logger.progress()=epydoc.log.Logger-class.html#progress,Function epydoc.log.progress()=epydoc.log-module.html#progress"><a title="epydoc.cli.ConsoleLogger.progress
epydoc.cli.UnifiedProgressConsoleLogger.progress
epydoc.docbuilder._ProgressEstimator.progress
epydoc.gui.GUILogger.progress
epydoc.log.Logger.progress
epydoc.log.progress" class="py-name" href="#" onclick="return doclink('link-109', 'progress', 'link-109');">progress</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_files_written</tt><tt class="py-op">/</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_num_files</tt><tt class="py-op">,</tt> <tt class="py-string">'epydoc.css'</tt><tt class="py-op">)</tt> </tt>
<a name="L553"></a><tt class="py-lineno"> 553</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-110" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_css()=epydoc.docwriter.html.HTMLWriter-class.html#write_css"><a title="epydoc.docwriter.html.HTMLWriter.write_css" class="py-name" href="#" onclick="return doclink('link-110', 'write_css', 'link-110');">write_css</a></tt><tt class="py-op">(</tt><tt class="py-name">directory</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_css</tt><tt class="py-op">)</tt> </tt>
<a name="L554"></a><tt class="py-lineno"> 554</tt> <tt class="py-line"> </tt>
<a name="L555"></a><tt class="py-lineno"> 555</tt> <tt class="py-line"> <tt class="py-comment"># Write the Javascript file.</tt> </tt>
<a name="L556"></a><tt class="py-lineno"> 556</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_files_written</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L557"></a><tt class="py-lineno"> 557</tt> <tt class="py-line"> <tt id="link-111" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-111', 'log', 'link-29');">log</a></tt><tt class="py-op">.</tt><tt id="link-112" class="py-name"><a title="epydoc.cli.ConsoleLogger.progress
epydoc.cli.UnifiedProgressConsoleLogger.progress
epydoc.docbuilder._ProgressEstimator.progress
epydoc.gui.GUILogger.progress
epydoc.log.Logger.progress
epydoc.log.progress" class="py-name" href="#" onclick="return doclink('link-112', 'progress', 'link-109');">progress</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_files_written</tt><tt class="py-op">/</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_num_files</tt><tt class="py-op">,</tt> <tt class="py-string">'epydoc.js'</tt><tt class="py-op">)</tt> </tt>
<a name="L558"></a><tt class="py-lineno"> 558</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-113" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_javascript()=epydoc.docwriter.html.HTMLWriter-class.html#write_javascript"><a title="epydoc.docwriter.html.HTMLWriter.write_javascript" class="py-name" href="#" onclick="return doclink('link-113', 'write_javascript', 'link-113');">write_javascript</a></tt><tt class="py-op">(</tt><tt class="py-name">directory</tt><tt class="py-op">)</tt> </tt>
<a name="L559"></a><tt class="py-lineno"> 559</tt> <tt class="py-line"> </tt>
<a name="L560"></a><tt class="py-lineno"> 560</tt> <tt class="py-line"> <tt class="py-comment"># Write images</tt> </tt>
<a name="L561"></a><tt class="py-lineno"> 561</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-114" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_images()=epydoc.docwriter.html.HTMLWriter-class.html#write_images"><a title="epydoc.docwriter.html.HTMLWriter.write_images" class="py-name" href="#" onclick="return doclink('link-114', 'write_images', 'link-114');">write_images</a></tt><tt class="py-op">(</tt><tt class="py-name">directory</tt><tt class="py-op">)</tt> </tt>
<a name="L562"></a><tt class="py-lineno"> 562</tt> <tt class="py-line"> </tt>
<a name="L563"></a><tt class="py-lineno"> 563</tt> <tt class="py-line"> <tt class="py-comment"># Build the indices.</tt> </tt>
<a name="L564"></a><tt class="py-lineno"> 564</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">indices</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-string">'ident'</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-115" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.build_identifier_index()=epydoc.docwriter.html.HTMLWriter-class.html#build_identifier_index"><a title="epydoc.docwriter.html.HTMLWriter.build_identifier_index" class="py-name" href="#" onclick="return doclink('link-115', 'build_identifier_index', 'link-115');">build_identifier_index</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L565"></a><tt class="py-lineno"> 565</tt> <tt class="py-line"> <tt class="py-string">'term'</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-116" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.build_term_index()=epydoc.docwriter.html.HTMLWriter-class.html#build_term_index"><a title="epydoc.docwriter.html.HTMLWriter.build_term_index" class="py-name" href="#" onclick="return doclink('link-116', 'build_term_index', 'link-116');">build_term_index</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">}</tt> </tt>
<a name="L566"></a><tt class="py-lineno"> 566</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt id="link-117" class="py-name" targets="Variable epydoc.apidoc.VariableDoc.name=epydoc.apidoc.VariableDoc-class.html#name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-117', 'name', 'link-117');">name</a></tt><tt class="py-op">,</tt> <tt id="link-118" class="py-name" targets="Method epydoc.docwriter.latex.LatexWriter.label()=epydoc.docwriter.latex.LatexWriter-class.html#label"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-118', 'label', 'link-118');">label</a></tt><tt class="py-op">,</tt> <tt class="py-name">label2</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-119" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.METADATA_INDICES" class="py-name" href="#" onclick="return doclink('link-119', 'METADATA_INDICES', 'link-69');">METADATA_INDICES</a></tt><tt class="py-op">:</tt> </tt>
<a name="L567"></a><tt class="py-lineno"> 567</tt> <tt class="py-line"> <tt class="py-name">indices</tt><tt class="py-op">[</tt><tt id="link-120" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-120', 'name', 'link-117');">name</a></tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-121" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.build_metadata_index()=epydoc.docwriter.html.HTMLWriter-class.html#build_metadata_index"><a title="epydoc.docwriter.html.HTMLWriter.build_metadata_index" class="py-name" href="#" onclick="return doclink('link-121', 'build_metadata_index', 'link-121');">build_metadata_index</a></tt><tt class="py-op">(</tt><tt id="link-122" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-122', 'name', 'link-117');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L568"></a><tt class="py-lineno"> 568</tt> <tt class="py-line"> </tt>
<a name="L569"></a><tt class="py-lineno"> 569</tt> <tt class="py-line"> <tt class="py-comment"># Write the identifier index. If requested, split it into</tt> </tt>
<a name="L570"></a><tt class="py-lineno"> 570</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># separate pages for each letter.</tt> </tt>
<a name="L571"></a><tt class="py-lineno"> 571</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">ident_by_letter</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-123" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter._group_by_letter()=epydoc.docwriter.html.HTMLWriter-class.html#_group_by_letter"><a title="epydoc.docwriter.html.HTMLWriter._group_by_letter" class="py-name" href="#" onclick="return doclink('link-123', '_group_by_letter', 'link-123');">_group_by_letter</a></tt><tt class="py-op">(</tt><tt class="py-name">indices</tt><tt class="py-op">[</tt><tt class="py-string">'ident'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L572"></a><tt class="py-lineno"> 572</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_split_ident_index</tt><tt class="py-op">:</tt> </tt>
<a name="L573"></a><tt class="py-lineno"> 573</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-124" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter._write()=epydoc.docwriter.html.HTMLWriter-class.html#_write,Method epydoc.docwriter.latex.LatexWriter._write()=epydoc.docwriter.latex.LatexWriter-class.html#_write"><a title="epydoc.docwriter.html.HTMLWriter._write
epydoc.docwriter.latex.LatexWriter._write" class="py-name" href="#" onclick="return doclink('link-124', '_write', 'link-124');">_write</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-125" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_link_index()=epydoc.docwriter.html.HTMLWriter-class.html#write_link_index"><a title="epydoc.docwriter.html.HTMLWriter.write_link_index" class="py-name" href="#" onclick="return doclink('link-125', 'write_link_index', 'link-125');">write_link_index</a></tt><tt class="py-op">,</tt> <tt class="py-name">directory</tt><tt class="py-op">,</tt> </tt>
<a name="L574"></a><tt class="py-lineno"> 574</tt> <tt class="py-line"> <tt class="py-string">'identifier-index.html'</tt><tt class="py-op">,</tt> <tt class="py-name">indices</tt><tt class="py-op">,</tt> </tt>
<a name="L575"></a><tt class="py-lineno"> 575</tt> <tt class="py-line"> <tt class="py-string">'Identifier Index'</tt><tt class="py-op">,</tt> <tt class="py-string">'identifier-index.html'</tt><tt class="py-op">,</tt> </tt>
<a name="L576"></a><tt class="py-lineno"> 576</tt> <tt class="py-line"> <tt class="py-name">ident_by_letter</tt><tt class="py-op">)</tt> </tt>
<a name="L577"></a><tt class="py-lineno"> 577</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L578"></a><tt class="py-lineno"> 578</tt> <tt class="py-line"> <tt class="py-comment"># Write a page for each section.</tt> </tt>
<a name="L579"></a><tt class="py-lineno"> 579</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">letter</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-126" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.LETTERS" class="py-name" href="#" onclick="return doclink('link-126', 'LETTERS', 'link-70');">LETTERS</a></tt><tt class="py-op">:</tt> </tt>
<a name="L580"></a><tt class="py-lineno"> 580</tt> <tt class="py-line"> <tt id="link-127" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-127', 'filename', 'link-68');">filename</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'identifier-index-%s.html'</tt> <tt class="py-op">%</tt> <tt class="py-name">letter</tt> </tt>
<a name="L581"></a><tt class="py-lineno"> 581</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-128" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._write
epydoc.docwriter.latex.LatexWriter._write" class="py-name" href="#" onclick="return doclink('link-128', '_write', 'link-124');">_write</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-129" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_link_index" class="py-name" href="#" onclick="return doclink('link-129', 'write_link_index', 'link-125');">write_link_index</a></tt><tt class="py-op">,</tt> <tt class="py-name">directory</tt><tt class="py-op">,</tt> <tt id="link-130" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-130', 'filename', 'link-68');">filename</a></tt><tt class="py-op">,</tt> </tt>
<a name="L582"></a><tt class="py-lineno"> 582</tt> <tt class="py-line"> <tt class="py-name">indices</tt><tt class="py-op">,</tt> <tt class="py-string">'Identifier Index'</tt><tt class="py-op">,</tt> <tt id="link-131" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-131', 'filename', 'link-68');">filename</a></tt><tt class="py-op">,</tt> </tt>
<a name="L583"></a><tt class="py-lineno"> 583</tt> <tt class="py-line"> <tt class="py-name">ident_by_letter</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-name">letter</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
<a name="L584"></a><tt class="py-lineno"> 584</tt> <tt class="py-line"> <tt class="py-string">'identifier-index-%s.html'</tt><tt class="py-op">)</tt> </tt>
<a name="L585"></a><tt class="py-lineno"> 585</tt> <tt class="py-line"> <tt class="py-comment"># Use the first non-empty section as the main index page.</tt> </tt>
<a name="L586"></a><tt class="py-lineno"> 586</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">letter</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-132" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.LETTERS" class="py-name" href="#" onclick="return doclink('link-132', 'LETTERS', 'link-70');">LETTERS</a></tt><tt class="py-op">:</tt> </tt>
<a name="L587"></a><tt class="py-lineno"> 587</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">letter</tt> <tt class="py-keyword">in</tt> <tt class="py-name">ident_by_letter</tt><tt class="py-op">:</tt> </tt>
<a name="L588"></a><tt class="py-lineno"> 588</tt> <tt class="py-line"> <tt id="link-133" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-133', 'filename', 'link-68');">filename</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'identifier-index.html'</tt> </tt>
<a name="L589"></a><tt class="py-lineno"> 589</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-134" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._write
epydoc.docwriter.latex.LatexWriter._write" class="py-name" href="#" onclick="return doclink('link-134', '_write', 'link-124');">_write</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-135" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_link_index" class="py-name" href="#" onclick="return doclink('link-135', 'write_link_index', 'link-125');">write_link_index</a></tt><tt class="py-op">,</tt> <tt class="py-name">directory</tt><tt class="py-op">,</tt> <tt id="link-136" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-136', 'filename', 'link-68');">filename</a></tt><tt class="py-op">,</tt> </tt>
<a name="L590"></a><tt class="py-lineno"> 590</tt> <tt class="py-line"> <tt class="py-name">indices</tt><tt class="py-op">,</tt> <tt class="py-string">'Identifier Index'</tt><tt class="py-op">,</tt> <tt id="link-137" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-137', 'filename', 'link-68');">filename</a></tt><tt class="py-op">,</tt> </tt>
<a name="L591"></a><tt class="py-lineno"> 591</tt> <tt class="py-line"> <tt class="py-name">ident_by_letter</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-name">letter</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
<a name="L592"></a><tt class="py-lineno"> 592</tt> <tt class="py-line"> <tt class="py-string">'identifier-index-%s.html'</tt><tt class="py-op">)</tt> </tt>
<a name="L593"></a><tt class="py-lineno"> 593</tt> <tt class="py-line"> <tt class="py-keyword">break</tt> </tt>
<a name="L594"></a><tt class="py-lineno"> 594</tt> <tt class="py-line"> </tt>
<a name="L595"></a><tt class="py-lineno"> 595</tt> <tt class="py-line"> <tt class="py-comment"># Write the term index.</tt> </tt>
<a name="L596"></a><tt class="py-lineno"> 596</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">indices</tt><tt class="py-op">[</tt><tt class="py-string">'term'</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L597"></a><tt class="py-lineno"> 597</tt> <tt class="py-line"> <tt class="py-name">term_by_letter</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-138" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._group_by_letter" class="py-name" href="#" onclick="return doclink('link-138', '_group_by_letter', 'link-123');">_group_by_letter</a></tt><tt class="py-op">(</tt><tt class="py-name">indices</tt><tt class="py-op">[</tt><tt class="py-string">'term'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L598"></a><tt class="py-lineno"> 598</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-139" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._write
epydoc.docwriter.latex.LatexWriter._write" class="py-name" href="#" onclick="return doclink('link-139', '_write', 'link-124');">_write</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-140" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_link_index" class="py-name" href="#" onclick="return doclink('link-140', 'write_link_index', 'link-125');">write_link_index</a></tt><tt class="py-op">,</tt> <tt class="py-name">directory</tt><tt class="py-op">,</tt> <tt class="py-string">'term-index.html'</tt><tt class="py-op">,</tt> </tt>
<a name="L599"></a><tt class="py-lineno"> 599</tt> <tt class="py-line"> <tt class="py-name">indices</tt><tt class="py-op">,</tt> <tt class="py-string">'Term Definition Index'</tt><tt class="py-op">,</tt> </tt>
<a name="L600"></a><tt class="py-lineno"> 600</tt> <tt class="py-line"> <tt class="py-string">'term-index.html'</tt><tt class="py-op">,</tt> <tt class="py-name">term_by_letter</tt><tt class="py-op">)</tt> </tt>
<a name="L601"></a><tt class="py-lineno"> 601</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L602"></a><tt class="py-lineno"> 602</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_files_written</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> <tt class="py-comment"># (skipped)</tt> </tt>
<a name="L603"></a><tt class="py-lineno"> 603</tt> <tt class="py-line"> </tt>
<a name="L604"></a><tt class="py-lineno"> 604</tt> <tt class="py-line"> <tt class="py-comment"># Write the metadata indices.</tt> </tt>
<a name="L605"></a><tt class="py-lineno"> 605</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt id="link-141" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-141', 'name', 'link-117');">name</a></tt><tt class="py-op">,</tt> <tt id="link-142" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-142', 'label', 'link-118');">label</a></tt><tt class="py-op">,</tt> <tt class="py-name">label2</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-143" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.METADATA_INDICES" class="py-name" href="#" onclick="return doclink('link-143', 'METADATA_INDICES', 'link-69');">METADATA_INDICES</a></tt><tt class="py-op">:</tt> </tt>
<a name="L606"></a><tt class="py-lineno"> 606</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">indices</tt><tt class="py-op">[</tt><tt id="link-144" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-144', 'name', 'link-117');">name</a></tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L607"></a><tt class="py-lineno"> 607</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-145" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._write
epydoc.docwriter.latex.LatexWriter._write" class="py-name" href="#" onclick="return doclink('link-145', '_write', 'link-124');">_write</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-146" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_metadata_index()=epydoc.docwriter.html.HTMLWriter-class.html#write_metadata_index"><a title="epydoc.docwriter.html.HTMLWriter.write_metadata_index" class="py-name" href="#" onclick="return doclink('link-146', 'write_metadata_index', 'link-146');">write_metadata_index</a></tt><tt class="py-op">,</tt> <tt class="py-name">directory</tt><tt class="py-op">,</tt> </tt>
<a name="L608"></a><tt class="py-lineno"> 608</tt> <tt class="py-line"> <tt class="py-string">'%s-index.html'</tt> <tt class="py-op">%</tt> <tt id="link-147" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-147', 'name', 'link-117');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">indices</tt><tt class="py-op">,</tt> <tt id="link-148" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-148', 'name', 'link-117');">name</a></tt><tt class="py-op">,</tt> </tt>
<a name="L609"></a><tt class="py-lineno"> 609</tt> <tt class="py-line"> <tt id="link-149" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-149', 'label', 'link-118');">label</a></tt><tt class="py-op">,</tt> <tt class="py-name">label2</tt><tt class="py-op">)</tt> </tt>
<a name="L610"></a><tt class="py-lineno"> 610</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L611"></a><tt class="py-lineno"> 611</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_files_written</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> <tt class="py-comment"># (skipped)</tt> </tt>
<a name="L612"></a><tt class="py-lineno"> 612</tt> <tt class="py-line"> </tt>
<a name="L613"></a><tt class="py-lineno"> 613</tt> <tt class="py-line"> <tt class="py-comment"># Write the trees file (package & class hierarchies)</tt> </tt>
<a name="L614"></a><tt class="py-lineno"> 614</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">module_list</tt><tt class="py-op">:</tt> </tt>
<a name="L615"></a><tt class="py-lineno"> 615</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-150" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._write
epydoc.docwriter.latex.LatexWriter._write" class="py-name" href="#" onclick="return doclink('link-150', '_write', 'link-124');">_write</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-151" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_module_tree()=epydoc.docwriter.html.HTMLWriter-class.html#write_module_tree,Method epydoc.docwriter.latex.LatexWriter.write_module_tree()=epydoc.docwriter.latex.LatexWriter-class.html#write_module_tree"><a title="epydoc.docwriter.html.HTMLWriter.write_module_tree
epydoc.docwriter.latex.LatexWriter.write_module_tree" class="py-name" href="#" onclick="return doclink('link-151', 'write_module_tree', 'link-151');">write_module_tree</a></tt><tt class="py-op">,</tt> <tt class="py-name">directory</tt><tt class="py-op">,</tt> <tt class="py-string">'module-tree.html'</tt><tt class="py-op">)</tt> </tt>
<a name="L616"></a><tt class="py-lineno"> 616</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L617"></a><tt class="py-lineno"> 617</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_files_written</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> <tt class="py-comment"># (skipped)</tt> </tt>
<a name="L618"></a><tt class="py-lineno"> 618</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">class_list</tt><tt class="py-op">:</tt> </tt>
<a name="L619"></a><tt class="py-lineno"> 619</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-152" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._write
epydoc.docwriter.latex.LatexWriter._write" class="py-name" href="#" onclick="return doclink('link-152', '_write', 'link-124');">_write</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-153" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_class_tree()=epydoc.docwriter.html.HTMLWriter-class.html#write_class_tree"><a title="epydoc.docwriter.html.HTMLWriter.write_class_tree" class="py-name" href="#" onclick="return doclink('link-153', 'write_class_tree', 'link-153');">write_class_tree</a></tt><tt class="py-op">,</tt> <tt class="py-name">directory</tt><tt class="py-op">,</tt> <tt class="py-string">'class-tree.html'</tt><tt class="py-op">)</tt> </tt>
<a name="L620"></a><tt class="py-lineno"> 620</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L621"></a><tt class="py-lineno"> 621</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_files_written</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> <tt class="py-comment"># (skipped)</tt> </tt>
<a name="L622"></a><tt class="py-lineno"> 622</tt> <tt class="py-line"> </tt>
<a name="L623"></a><tt class="py-lineno"> 623</tt> <tt class="py-line"> <tt class="py-comment"># Write the help file.</tt> </tt>
<a name="L624"></a><tt class="py-lineno"> 624</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-154" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._write
epydoc.docwriter.latex.LatexWriter._write" class="py-name" href="#" onclick="return doclink('link-154', '_write', 'link-124');">_write</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-155" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_help()=epydoc.docwriter.html.HTMLWriter-class.html#write_help"><a title="epydoc.docwriter.html.HTMLWriter.write_help" class="py-name" href="#" onclick="return doclink('link-155', 'write_help', 'link-155');">write_help</a></tt><tt class="py-op">,</tt> <tt class="py-name">directory</tt><tt class="py-op">,</tt><tt class="py-string">'help.html'</tt><tt class="py-op">)</tt> </tt>
<a name="L625"></a><tt class="py-lineno"> 625</tt> <tt class="py-line"> </tt>
<a name="L626"></a><tt class="py-lineno"> 626</tt> <tt class="py-line"> <tt class="py-comment"># Write the frames-based table of contents.</tt> </tt>
<a name="L627"></a><tt class="py-lineno"> 627</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_frames_index</tt><tt class="py-op">:</tt> </tt>
<a name="L628"></a><tt class="py-lineno"> 628</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-156" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._write
epydoc.docwriter.latex.LatexWriter._write" class="py-name" href="#" onclick="return doclink('link-156', '_write', 'link-124');">_write</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-157" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_frames_index()=epydoc.docwriter.html.HTMLWriter-class.html#write_frames_index"><a title="epydoc.docwriter.html.HTMLWriter.write_frames_index" class="py-name" href="#" onclick="return doclink('link-157', 'write_frames_index', 'link-157');">write_frames_index</a></tt><tt class="py-op">,</tt> <tt class="py-name">directory</tt><tt class="py-op">,</tt> <tt class="py-string">'frames.html'</tt><tt class="py-op">)</tt> </tt>
<a name="L629"></a><tt class="py-lineno"> 629</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-158" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._write
epydoc.docwriter.latex.LatexWriter._write" class="py-name" href="#" onclick="return doclink('link-158', '_write', 'link-124');">_write</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-159" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_toc()=epydoc.docwriter.html.HTMLWriter-class.html#write_toc"><a title="epydoc.docwriter.html.HTMLWriter.write_toc" class="py-name" href="#" onclick="return doclink('link-159', 'write_toc', 'link-159');">write_toc</a></tt><tt class="py-op">,</tt> <tt class="py-name">directory</tt><tt class="py-op">,</tt> <tt class="py-string">'toc.html'</tt><tt class="py-op">)</tt> </tt>
<a name="L630"></a><tt class="py-lineno"> 630</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-160" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._write
epydoc.docwriter.latex.LatexWriter._write" class="py-name" href="#" onclick="return doclink('link-160', '_write', 'link-124');">_write</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-161" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_project_toc()=epydoc.docwriter.html.HTMLWriter-class.html#write_project_toc"><a title="epydoc.docwriter.html.HTMLWriter.write_project_toc" class="py-name" href="#" onclick="return doclink('link-161', 'write_project_toc', 'link-161');">write_project_toc</a></tt><tt class="py-op">,</tt> <tt class="py-name">directory</tt><tt class="py-op">,</tt> <tt class="py-string">'toc-everything.html'</tt><tt class="py-op">)</tt> </tt>
<a name="L631"></a><tt class="py-lineno"> 631</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">module_list</tt><tt class="py-op">:</tt> </tt>
<a name="L632"></a><tt class="py-lineno"> 632</tt> <tt class="py-line"> <tt id="link-162" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-162', 'filename', 'link-68');">filename</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'toc-%s'</tt> <tt class="py-op">%</tt> <tt class="py-name">urllib</tt><tt class="py-op">.</tt><tt class="py-name">unquote</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-163" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-163', 'url', 'link-72');">url</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L633"></a><tt class="py-lineno"> 633</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-164" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._write
epydoc.docwriter.latex.LatexWriter._write" class="py-name" href="#" onclick="return doclink('link-164', '_write', 'link-124');">_write</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-165" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_module_toc()=epydoc.docwriter.html.HTMLWriter-class.html#write_module_toc"><a title="epydoc.docwriter.html.HTMLWriter.write_module_toc" class="py-name" href="#" onclick="return doclink('link-165', 'write_module_toc', 'link-165');">write_module_toc</a></tt><tt class="py-op">,</tt> <tt class="py-name">directory</tt><tt class="py-op">,</tt> <tt id="link-166" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-166', 'filename', 'link-68');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L634"></a><tt class="py-lineno"> 634</tt> <tt class="py-line"> </tt>
<a name="L635"></a><tt class="py-lineno"> 635</tt> <tt class="py-line"> <tt class="py-comment"># Write the object documentation.</tt> </tt>
<a name="L636"></a><tt class="py-lineno"> 636</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">module_list</tt><tt class="py-op">:</tt> </tt>
<a name="L637"></a><tt class="py-lineno"> 637</tt> <tt class="py-line"> <tt id="link-167" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-167', 'filename', 'link-68');">filename</a></tt> <tt class="py-op">=</tt> <tt class="py-name">urllib</tt><tt class="py-op">.</tt><tt class="py-name">unquote</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-168" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-168', 'url', 'link-72');">url</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L638"></a><tt class="py-lineno"> 638</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-169" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._write
epydoc.docwriter.latex.LatexWriter._write" class="py-name" href="#" onclick="return doclink('link-169', '_write', 'link-124');">_write</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-170" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_module()=epydoc.docwriter.html.HTMLWriter-class.html#write_module,Method epydoc.docwriter.latex.LatexWriter.write_module()=epydoc.docwriter.latex.LatexWriter-class.html#write_module,Method epydoc.docwriter.plaintext.PlaintextWriter.write_module()=epydoc.docwriter.plaintext.PlaintextWriter-class.html#write_module"><a title="epydoc.docwriter.html.HTMLWriter.write_module
epydoc.docwriter.latex.LatexWriter.write_module
epydoc.docwriter.plaintext.PlaintextWriter.write_module" class="py-name" href="#" onclick="return doclink('link-170', 'write_module', 'link-170');">write_module</a></tt><tt class="py-op">,</tt> <tt class="py-name">directory</tt><tt class="py-op">,</tt> <tt id="link-171" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-171', 'filename', 'link-68');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L639"></a><tt class="py-lineno"> 639</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">class_list</tt><tt class="py-op">:</tt> </tt>
<a name="L640"></a><tt class="py-lineno"> 640</tt> <tt class="py-line"> <tt id="link-172" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-172', 'filename', 'link-68');">filename</a></tt> <tt class="py-op">=</tt> <tt class="py-name">urllib</tt><tt class="py-op">.</tt><tt class="py-name">unquote</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-173" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-173', 'url', 'link-72');">url</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L641"></a><tt class="py-lineno"> 641</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-174" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._write
epydoc.docwriter.latex.LatexWriter._write" class="py-name" href="#" onclick="return doclink('link-174', '_write', 'link-124');">_write</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-175" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_class()=epydoc.docwriter.html.HTMLWriter-class.html#write_class,Method epydoc.docwriter.latex.LatexWriter.write_class()=epydoc.docwriter.latex.LatexWriter-class.html#write_class,Method epydoc.docwriter.plaintext.PlaintextWriter.write_class()=epydoc.docwriter.plaintext.PlaintextWriter-class.html#write_class"><a title="epydoc.docwriter.html.HTMLWriter.write_class
epydoc.docwriter.latex.LatexWriter.write_class
epydoc.docwriter.plaintext.PlaintextWriter.write_class" class="py-name" href="#" onclick="return doclink('link-175', 'write_class', 'link-175');">write_class</a></tt><tt class="py-op">,</tt> <tt class="py-name">directory</tt><tt class="py-op">,</tt> <tt id="link-176" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-176', 'filename', 'link-68');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L642"></a><tt class="py-lineno"> 642</tt> <tt class="py-line"> </tt>
<a name="L643"></a><tt class="py-lineno"> 643</tt> <tt class="py-line"> <tt class="py-comment"># Write source code files.</tt> </tt>
<a name="L644"></a><tt class="py-lineno"> 644</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_incl_sourcecode</tt><tt class="py-op">:</tt> </tt>
<a name="L645"></a><tt class="py-lineno"> 645</tt> <tt class="py-line"> <tt class="py-comment"># Build a map from short names to APIDocs, used when</tt> </tt>
<a name="L646"></a><tt class="py-lineno"> 646</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># linking names in the source code.</tt> </tt>
<a name="L647"></a><tt class="py-lineno"> 647</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">name_to_docs</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L648"></a><tt class="py-lineno"> 648</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">api_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">indexed_docs</tt><tt class="py-op">:</tt> </tt>
<a name="L649"></a><tt class="py-lineno"> 649</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-177" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-177', 'canonical_name', 'link-82');">canonical_name</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L650"></a><tt class="py-lineno"> 650</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-178" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-178', 'url', 'link-72');">url</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">)</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L651"></a><tt class="py-lineno"> 651</tt> <tt class="py-line"> <tt id="link-179" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-179', 'name', 'link-117');">name</a></tt> <tt class="py-op">=</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-180" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-180', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt>
<a name="L652"></a><tt class="py-lineno"> 652</tt> <tt class="py-line"> <tt class="py-name">name_to_docs</tt><tt class="py-op">.</tt><tt class="py-name">setdefault</tt><tt class="py-op">(</tt><tt id="link-181" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-181', 'name', 'link-117');">name</a></tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L653"></a><tt class="py-lineno"> 653</tt> <tt class="py-line"> <tt class="py-comment"># Sort each entry of the name_to_docs list.</tt> </tt>
<a name="L654"></a><tt class="py-lineno"> 654</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">doc_list</tt> <tt class="py-keyword">in</tt> <tt class="py-name">name_to_docs</tt><tt class="py-op">.</tt><tt class="py-name">values</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L655"></a><tt class="py-lineno"> 655</tt> <tt class="py-line"> <tt class="py-name">doc_list</tt><tt class="py-op">.</tt><tt class="py-name">sort</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L656"></a><tt class="py-lineno"> 656</tt> <tt class="py-line"> <tt class="py-comment"># Write the source code for each module.</tt> </tt>
<a name="L657"></a><tt class="py-lineno"> 657</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">modules_with_sourcecode</tt><tt class="py-op">:</tt> </tt>
<a name="L658"></a><tt class="py-lineno"> 658</tt> <tt class="py-line"> <tt id="link-182" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-182', 'filename', 'link-68');">filename</a></tt> <tt class="py-op">=</tt> <tt class="py-name">urllib</tt><tt class="py-op">.</tt><tt class="py-name">unquote</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-183" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.pysrc_url()=epydoc.docwriter.html.HTMLWriter-class.html#pysrc_url"><a title="epydoc.docwriter.html.HTMLWriter.pysrc_url" class="py-name" href="#" onclick="return doclink('link-183', 'pysrc_url', 'link-183');">pysrc_url</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L659"></a><tt class="py-lineno"> 659</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-184" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._write
epydoc.docwriter.latex.LatexWriter._write" class="py-name" href="#" onclick="return doclink('link-184', '_write', 'link-124');">_write</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-185" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_sourcecode()=epydoc.docwriter.html.HTMLWriter-class.html#write_sourcecode"><a title="epydoc.docwriter.html.HTMLWriter.write_sourcecode" class="py-name" href="#" onclick="return doclink('link-185', 'write_sourcecode', 'link-185');">write_sourcecode</a></tt><tt class="py-op">,</tt> <tt class="py-name">directory</tt><tt class="py-op">,</tt> <tt id="link-186" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-186', 'filename', 'link-68');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> </tt>
<a name="L660"></a><tt class="py-lineno"> 660</tt> <tt class="py-line"> <tt class="py-name">name_to_docs</tt><tt class="py-op">)</tt> </tt>
<a name="L661"></a><tt class="py-lineno"> 661</tt> <tt class="py-line"> </tt>
<a name="L662"></a><tt class="py-lineno"> 662</tt> <tt class="py-line"> <tt class="py-comment"># Write the auto-redirect page.</tt> </tt>
<a name="L663"></a><tt class="py-lineno"> 663</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-187" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._write
epydoc.docwriter.latex.LatexWriter._write" class="py-name" href="#" onclick="return doclink('link-187', '_write', 'link-124');">_write</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-188" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_redirect_page()=epydoc.docwriter.html.HTMLWriter-class.html#write_redirect_page"><a title="epydoc.docwriter.html.HTMLWriter.write_redirect_page" class="py-name" href="#" onclick="return doclink('link-188', 'write_redirect_page', 'link-188');">write_redirect_page</a></tt><tt class="py-op">,</tt> <tt class="py-name">directory</tt><tt class="py-op">,</tt> <tt class="py-string">'redirect.html'</tt><tt class="py-op">)</tt> </tt>
<a name="L664"></a><tt class="py-lineno"> 664</tt> <tt class="py-line"> </tt>
<a name="L665"></a><tt class="py-lineno"> 665</tt> <tt class="py-line"> <tt class="py-comment"># Write the mapping object name -> URL</tt> </tt>
<a name="L666"></a><tt class="py-lineno"> 666</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-189" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._write
epydoc.docwriter.latex.LatexWriter._write" class="py-name" href="#" onclick="return doclink('link-189', '_write', 'link-124');">_write</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-190" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_api_list()=epydoc.docwriter.html.HTMLWriter-class.html#write_api_list"><a title="epydoc.docwriter.html.HTMLWriter.write_api_list" class="py-name" href="#" onclick="return doclink('link-190', 'write_api_list', 'link-190');">write_api_list</a></tt><tt class="py-op">,</tt> <tt class="py-name">directory</tt><tt class="py-op">,</tt> <tt class="py-string">'api-objects.txt'</tt><tt class="py-op">)</tt> </tt>
<a name="L667"></a><tt class="py-lineno"> 667</tt> <tt class="py-line"> </tt>
<a name="L668"></a><tt class="py-lineno"> 668</tt> <tt class="py-line"> <tt class="py-comment"># Write the index.html files.</tt> </tt>
<a name="L669"></a><tt class="py-lineno"> 669</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># (this must be done last, since it might copy another file)</tt> </tt>
<a name="L670"></a><tt class="py-lineno"> 670</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_files_written</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L671"></a><tt class="py-lineno"> 671</tt> <tt class="py-line"> <tt id="link-191" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-191', 'log', 'link-29');">log</a></tt><tt class="py-op">.</tt><tt id="link-192" class="py-name"><a title="epydoc.cli.ConsoleLogger.progress
epydoc.cli.UnifiedProgressConsoleLogger.progress
epydoc.docbuilder._ProgressEstimator.progress
epydoc.gui.GUILogger.progress
epydoc.log.Logger.progress
epydoc.log.progress" class="py-name" href="#" onclick="return doclink('link-192', 'progress', 'link-109');">progress</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_files_written</tt><tt class="py-op">/</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_num_files</tt><tt class="py-op">,</tt> <tt class="py-string">'index.html'</tt><tt class="py-op">)</tt> </tt>
<a name="L672"></a><tt class="py-lineno"> 672</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-193" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_homepage()=epydoc.docwriter.html.HTMLWriter-class.html#write_homepage"><a title="epydoc.docwriter.html.HTMLWriter.write_homepage" class="py-name" href="#" onclick="return doclink('link-193', 'write_homepage', 'link-193');">write_homepage</a></tt><tt class="py-op">(</tt><tt class="py-name">directory</tt><tt class="py-op">)</tt> </tt>
<a name="L673"></a><tt class="py-lineno"> 673</tt> <tt class="py-line"> </tt>
<a name="L674"></a><tt class="py-lineno"> 674</tt> <tt class="py-line"> <tt class="py-comment"># Don't report references to builtins as missing</tt> </tt>
<a name="L675"></a><tt class="py-lineno"> 675</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">k</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_failed_xrefs</tt><tt class="py-op">.</tt><tt class="py-name">keys</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-comment"># have a copy of keys</tt> </tt>
<a name="L676"></a><tt class="py-lineno"> 676</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt class="py-name">__builtin__</tt><tt class="py-op">,</tt> <tt class="py-name">k</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L677"></a><tt class="py-lineno"> 677</tt> <tt class="py-line"> <tt class="py-keyword">del</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_failed_xrefs</tt><tt class="py-op">[</tt><tt class="py-name">k</tt><tt class="py-op">]</tt> </tt>
<a name="L678"></a><tt class="py-lineno"> 678</tt> <tt class="py-line"> </tt>
<a name="L679"></a><tt class="py-lineno"> 679</tt> <tt class="py-line"> <tt class="py-comment"># Report any failed crossreferences</tt> </tt>
<a name="L680"></a><tt class="py-lineno"> 680</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_failed_xrefs</tt><tt class="py-op">:</tt> </tt>
<a name="L681"></a><tt class="py-lineno"> 681</tt> <tt class="py-line"> <tt class="py-name">estr</tt> <tt class="py-op">=</tt> <tt class="py-string">'Failed identifier crossreference targets:\n'</tt> </tt>
<a name="L682"></a><tt class="py-lineno"> 682</tt> <tt class="py-line"> <tt class="py-name">failed_identifiers</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_failed_xrefs</tt><tt class="py-op">.</tt><tt class="py-name">keys</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L683"></a><tt class="py-lineno"> 683</tt> <tt class="py-line"> <tt class="py-name">failed_identifiers</tt><tt class="py-op">.</tt><tt class="py-name">sort</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L684"></a><tt class="py-lineno"> 684</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">identifier</tt> <tt class="py-keyword">in</tt> <tt class="py-name">failed_identifiers</tt><tt class="py-op">:</tt> </tt>
<a name="L685"></a><tt class="py-lineno"> 685</tt> <tt class="py-line"> <tt class="py-name">names</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_failed_xrefs</tt><tt class="py-op">[</tt><tt class="py-name">identifier</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">keys</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L686"></a><tt class="py-lineno"> 686</tt> <tt class="py-line"> <tt class="py-name">names</tt><tt class="py-op">.</tt><tt class="py-name">sort</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L687"></a><tt class="py-lineno"> 687</tt> <tt class="py-line"> <tt class="py-name">estr</tt> <tt class="py-op">+=</tt> <tt class="py-string">'- %s'</tt> <tt class="py-op">%</tt> <tt class="py-name">identifier</tt> </tt>
<a name="L688"></a><tt class="py-lineno"> 688</tt> <tt class="py-line"> <tt class="py-name">estr</tt> <tt class="py-op">+=</tt> <tt class="py-string">'\n'</tt> </tt>
<a name="L689"></a><tt class="py-lineno"> 689</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-194" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-194', 'name', 'link-117');">name</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">names</tt><tt class="py-op">:</tt> </tt>
<a name="L690"></a><tt class="py-lineno"> 690</tt> <tt class="py-line"> <tt class="py-name">estr</tt> <tt class="py-op">+=</tt> <tt class="py-string">' (from %s)\n'</tt> <tt class="py-op">%</tt> <tt id="link-195" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-195', 'name', 'link-117');">name</a></tt> </tt>
<a name="L691"></a><tt class="py-lineno"> 691</tt> <tt class="py-line"> <tt id="link-196" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-196', 'log', 'link-29');">log</a></tt><tt class="py-op">.</tt><tt id="link-197" class="py-name" targets="Function epydoc.log.docstring_warning()=epydoc.log-module.html#docstring_warning"><a title="epydoc.log.docstring_warning" class="py-name" href="#" onclick="return doclink('link-197', 'docstring_warning', 'link-197');">docstring_warning</a></tt><tt class="py-op">(</tt><tt class="py-name">estr</tt><tt class="py-op">)</tt> </tt>
<a name="L692"></a><tt class="py-lineno"> 692</tt> <tt class="py-line"> </tt>
<a name="L693"></a><tt class="py-lineno"> 693</tt> <tt class="py-line"> <tt class="py-comment"># [xx] testing:</tt> </tt>
<a name="L694"></a><tt class="py-lineno"> 694</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_num_files</tt> <tt class="py-op">!=</tt> <tt class="py-name">int</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_files_written</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L695"></a><tt class="py-lineno"> 695</tt> <tt class="py-line"> <tt id="link-198" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-198', 'log', 'link-29');">log</a></tt><tt class="py-op">.</tt><tt id="link-199" class="py-name"><a title="epydoc.log.debug
epydoc.markup.restructuredtext.OptimizedReporter.debug" class="py-name" href="#" onclick="return doclink('link-199', 'debug', 'link-40');">debug</a></tt><tt class="py-op">(</tt><tt class="py-string">"Expected to write %d files, but actually "</tt> </tt>
<a name="L696"></a><tt class="py-lineno"> 696</tt> <tt class="py-line"> <tt class="py-string">"wrote %d files"</tt> <tt class="py-op">%</tt> </tt>
<a name="L697"></a><tt class="py-lineno"> 697</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_num_files</tt><tt class="py-op">,</tt> <tt class="py-name">int</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_files_written</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L698"></a><tt class="py-lineno"> 698</tt> <tt class="py-line"> </tt>
<a name="L699"></a><tt class="py-lineno"> 699</tt> <tt class="py-line"> <tt class="py-comment"># Restore defaults that we changed.</tt> </tt>
<a name="L700"></a><tt class="py-lineno"> 700</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-op">(</tt><tt id="link-200" class="py-name"><a title="epydoc.apidoc.ValueDoc" class="py-name" href="#" onclick="return doclink('link-200', 'ValueDoc', 'link-87');">ValueDoc</a></tt><tt class="py-op">.</tt><tt id="link-201" class="py-name"><a title="epydoc.apidoc.ValueDoc.SUMMARY_REPR_LINELEN" class="py-name" href="#" onclick="return doclink('link-201', 'SUMMARY_REPR_LINELEN', 'link-88');">SUMMARY_REPR_LINELEN</a></tt><tt class="py-op">,</tt> <tt id="link-202" class="py-name"><a title="epydoc.apidoc.ValueDoc" class="py-name" href="#" onclick="return doclink('link-202', 'ValueDoc', 'link-87');">ValueDoc</a></tt><tt class="py-op">.</tt><tt id="link-203" class="py-name"><a title="epydoc.apidoc.ValueDoc.REPR_LINELEN" class="py-name" href="#" onclick="return doclink('link-203', 'REPR_LINELEN', 'link-90');">REPR_LINELEN</a></tt><tt class="py-op">,</tt> </tt>
<a name="L701"></a><tt class="py-lineno"> 701</tt> <tt class="py-line"> <tt id="link-204" class="py-name"><a title="epydoc.apidoc.ValueDoc" class="py-name" href="#" onclick="return doclink('link-204', 'ValueDoc', 'link-87');">ValueDoc</a></tt><tt class="py-op">.</tt><tt id="link-205" class="py-name"><a title="epydoc.apidoc.ValueDoc.REPR_MAXLINES" class="py-name" href="#" onclick="return doclink('link-205', 'REPR_MAXLINES', 'link-92');">REPR_MAXLINES</a></tt><tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt class="py-name">orig_valdoc_defaults</tt> </tt>
<a name="L702"></a><tt class="py-lineno"> 702</tt> <tt class="py-line"> <tt id="link-206" class="py-name"><a title="epydoc.markup.epytext.ParsedEpytextDocstring" class="py-name" href="#" onclick="return doclink('link-206', 'ParsedEpytextDocstring', 'link-102');">ParsedEpytextDocstring</a></tt><tt class="py-op">.</tt><tt id="link-207" class="py-name"><a title="epydoc.markup.epytext.ParsedEpytextDocstring.SYMBOL_TO_HTML" class="py-name" href="#" onclick="return doclink('link-207', 'SYMBOL_TO_HTML', 'link-104');">SYMBOL_TO_HTML</a></tt><tt class="py-op">[</tt><tt class="py-string">'crarr'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">orig_crarr_html</tt> </tt>
</div><a name="L703"></a><tt class="py-lineno"> 703</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter._write"></a><div id="HTMLWriter._write-def"><a name="L704"></a><tt class="py-lineno"> 704</tt> <a class="py-toggle" href="#" id="HTMLWriter._write-toggle" onclick="return toggle('HTMLWriter._write');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#_write">_write</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">write_func</tt><tt class="py-op">,</tt> <tt class="py-param">directory</tt><tt class="py-op">,</tt> <tt class="py-param">filename</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-param">args</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter._write-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter._write-expanded"><a name="L705"></a><tt class="py-lineno"> 705</tt> <tt class="py-line"> <tt class="py-comment"># Display our progress.</tt> </tt>
<a name="L706"></a><tt class="py-lineno"> 706</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_files_written</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L707"></a><tt class="py-lineno"> 707</tt> <tt class="py-line"> <tt id="link-208" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-208', 'log', 'link-29');">log</a></tt><tt class="py-op">.</tt><tt id="link-209" class="py-name"><a title="epydoc.cli.ConsoleLogger.progress
epydoc.cli.UnifiedProgressConsoleLogger.progress
epydoc.docbuilder._ProgressEstimator.progress
epydoc.gui.GUILogger.progress
epydoc.log.Logger.progress
epydoc.log.progress" class="py-name" href="#" onclick="return doclink('link-209', 'progress', 'link-109');">progress</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_files_written</tt><tt class="py-op">/</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_num_files</tt><tt class="py-op">,</tt> <tt id="link-210" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-210', 'filename', 'link-68');">filename</a></tt><tt class="py-op">)</tt> </tt>
<a name="L708"></a><tt class="py-lineno"> 708</tt> <tt class="py-line"> </tt>
<a name="L709"></a><tt class="py-lineno"> 709</tt> <tt class="py-line"> <tt id="link-211" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.path=epydoc.apidoc.ModuleDoc-class.html#path"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-211', 'path', 'link-211');">path</a></tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-212" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-212', 'path', 'link-211');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">directory</tt><tt class="py-op">,</tt> <tt id="link-213" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-213', 'filename', 'link-68');">filename</a></tt><tt class="py-op">)</tt> </tt>
<a name="L710"></a><tt class="py-lineno"> 710</tt> <tt class="py-line"> <tt class="py-name">f</tt> <tt class="py-op">=</tt> <tt class="py-name">codecs</tt><tt class="py-op">.</tt><tt id="link-214" class="py-name" targets="Method epydoc.gui.EpydocGUI.open()=epydoc.gui.EpydocGUI-class.html#open"><a title="epydoc.gui.EpydocGUI.open" class="py-name" href="#" onclick="return doclink('link-214', 'open', 'link-214');">open</a></tt><tt class="py-op">(</tt><tt id="link-215" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-215', 'path', 'link-211');">path</a></tt><tt class="py-op">,</tt> <tt class="py-string">'w'</tt><tt class="py-op">,</tt> <tt class="py-string">'ascii'</tt><tt class="py-op">,</tt> <tt class="py-name">errors</tt><tt class="py-op">=</tt><tt class="py-string">'xmlcharrefreplace'</tt><tt class="py-op">)</tt> </tt>
<a name="L711"></a><tt class="py-lineno"> 711</tt> <tt class="py-line"> <tt class="py-name">write_func</tt><tt class="py-op">(</tt><tt class="py-name">f</tt><tt class="py-op">.</tt><tt id="link-216" class="py-name" targets="Method epydoc.docintrospecter._DevNull.write()=epydoc.docintrospecter._DevNull-class.html#write,Method epydoc.docwriter.dotgraph.DotGraph.write()=epydoc.docwriter.dotgraph.DotGraph-class.html#write,Method epydoc.docwriter.html.HTMLWriter.write()=epydoc.docwriter.html.HTMLWriter-class.html#write,Method epydoc.docwriter.latex.LatexWriter.write()=epydoc.docwriter.latex.LatexWriter-class.html#write,Method epydoc.docwriter.plaintext.PlaintextWriter.write()=epydoc.docwriter.plaintext.PlaintextWriter-class.html#write"><a title="epydoc.docintrospecter._DevNull.write
epydoc.docwriter.dotgraph.DotGraph.write
epydoc.docwriter.html.HTMLWriter.write
epydoc.docwriter.latex.LatexWriter.write
epydoc.docwriter.plaintext.PlaintextWriter.write" class="py-name" href="#" onclick="return doclink('link-216', 'write', 'link-216');">write</a></tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">)</tt> </tt>
<a name="L712"></a><tt class="py-lineno"> 712</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt id="link-217" class="py-name" targets="Method epydoc.cli.HTMLLogger.close()=epydoc.cli.HTMLLogger-class.html#close,Method epydoc.docintrospecter._DevNull.close()=epydoc.docintrospecter._DevNull-class.html#close,Method epydoc.log.Logger.close()=epydoc.log.Logger-class.html#close,Function epydoc.log.close()=epydoc.log-module.html#close"><a title="epydoc.cli.HTMLLogger.close
epydoc.docintrospecter._DevNull.close
epydoc.log.Logger.close
epydoc.log.close" class="py-name" href="#" onclick="return doclink('link-217', 'close', 'link-217');">close</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L713"></a><tt class="py-lineno"> 713</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter._mkdir"></a><div id="HTMLWriter._mkdir-def"><a name="L714"></a><tt class="py-lineno"> 714</tt> <a class="py-toggle" href="#" id="HTMLWriter._mkdir-toggle" onclick="return toggle('HTMLWriter._mkdir');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#_mkdir">_mkdir</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">directory</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter._mkdir-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter._mkdir-expanded"><a name="L715"></a><tt class="py-lineno"> 715</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L716"></a><tt class="py-lineno"> 716</tt> <tt class="py-line"><tt class="py-docstring"> If the given directory does not exist, then attempt to create it.</tt> </tt>
<a name="L717"></a><tt class="py-lineno"> 717</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{None}</tt> </tt>
<a name="L718"></a><tt class="py-lineno"> 718</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L719"></a><tt class="py-lineno"> 719</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-218" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-218', 'path', 'link-211');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">isdir</tt><tt class="py-op">(</tt><tt class="py-name">directory</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L720"></a><tt class="py-lineno"> 720</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-219" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-219', 'path', 'link-211');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">exists</tt><tt class="py-op">(</tt><tt class="py-name">directory</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L721"></a><tt class="py-lineno"> 721</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">OSError</tt><tt class="py-op">(</tt><tt class="py-string">'%r is not a directory'</tt> <tt class="py-op">%</tt> <tt class="py-name">directory</tt><tt class="py-op">)</tt> </tt>
<a name="L722"></a><tt class="py-lineno"> 722</tt> <tt class="py-line"> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">mkdir</tt><tt class="py-op">(</tt><tt class="py-name">directory</tt><tt class="py-op">)</tt> </tt>
</div><a name="L723"></a><tt class="py-lineno"> 723</tt> <tt class="py-line"> </tt>
<a name="L724"></a><tt class="py-lineno"> 724</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L725"></a><tt class="py-lineno"> 725</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ 2.1. Module Pages</tt> </tt>
<a name="L726"></a><tt class="py-lineno"> 726</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L727"></a><tt class="py-lineno"> 727</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="HTMLWriter.write_module"></a><div id="HTMLWriter.write_module-def"><a name="L728"></a><tt class="py-lineno"> 728</tt> <a class="py-toggle" href="#" id="HTMLWriter.write_module-toggle" onclick="return toggle('HTMLWriter.write_module');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module">write_module</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write_module-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write_module-expanded"><a name="L729"></a><tt class="py-lineno"> 729</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L730"></a><tt class="py-lineno"> 730</tt> <tt class="py-line"><tt class="py-docstring"> Write an HTML page containing the API documentation for the</tt> </tt>
<a name="L731"></a><tt class="py-lineno"> 731</tt> <tt class="py-line"><tt class="py-docstring"> given module to C{out}.</tt> </tt>
<a name="L732"></a><tt class="py-lineno"> 732</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L733"></a><tt class="py-lineno"> 733</tt> <tt class="py-line"><tt class="py-docstring"> @param doc: A L{ModuleDoc} containing the API documentation</tt> </tt>
<a name="L734"></a><tt class="py-lineno"> 734</tt> <tt class="py-line"><tt class="py-docstring"> for the module that should be described.</tt> </tt>
<a name="L735"></a><tt class="py-lineno"> 735</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L736"></a><tt class="py-lineno"> 736</tt> <tt class="py-line"> <tt class="py-name">longname</tt> <tt class="py-op">=</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-220" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-220', 'canonical_name', 'link-82');">canonical_name</a></tt> </tt>
<a name="L737"></a><tt class="py-lineno"> 737</tt> <tt class="py-line"> <tt class="py-name">shortname</tt> <tt class="py-op">=</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-221" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-221', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt>
<a name="L738"></a><tt class="py-lineno"> 738</tt> <tt class="py-line"> </tt>
<a name="L739"></a><tt class="py-lineno"> 739</tt> <tt class="py-line"> <tt class="py-comment"># Write the page header (incl. navigation bar & breadcrumbs)</tt> </tt>
<a name="L740"></a><tt class="py-lineno"> 740</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-222" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_header()=epydoc.docwriter.html.HTMLWriter-class.html#write_header,Method epydoc.docwriter.latex.LatexWriter.write_header()=epydoc.docwriter.latex.LatexWriter-class.html#write_header"><a title="epydoc.docwriter.html.HTMLWriter.write_header
epydoc.docwriter.latex.LatexWriter.write_header" class="py-name" href="#" onclick="return doclink('link-222', 'write_header', 'link-222');">write_header</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">longname</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L741"></a><tt class="py-lineno"> 741</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-223" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_navbar()=epydoc.docwriter.html.HTMLWriter-class.html#write_navbar"><a title="epydoc.docwriter.html.HTMLWriter.write_navbar" class="py-name" href="#" onclick="return doclink('link-223', 'write_navbar', 'link-223');">write_navbar</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L742"></a><tt class="py-lineno"> 742</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-224" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_breadcrumbs()=epydoc.docwriter.html.HTMLWriter-class.html#write_breadcrumbs"><a title="epydoc.docwriter.html.HTMLWriter.write_breadcrumbs" class="py-name" href="#" onclick="return doclink('link-224', 'write_breadcrumbs', 'link-224');">write_breadcrumbs</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-225" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-225', 'url', 'link-72');">url</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L743"></a><tt class="py-lineno"> 743</tt> <tt class="py-line"> </tt>
<a name="L744"></a><tt class="py-lineno"> 744</tt> <tt class="py-line"> <tt class="py-comment"># Write the name of the module we're describing.</tt> </tt>
<a name="L745"></a><tt class="py-lineno"> 745</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-226" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.is_package=epydoc.apidoc.ModuleDoc-class.html#is_package"><a title="epydoc.apidoc.ModuleDoc.is_package" class="py-name" href="#" onclick="return doclink('link-226', 'is_package', 'link-226');">is_package</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">True</tt><tt class="py-op">:</tt> <tt class="py-name">typ</tt> <tt class="py-op">=</tt> <tt class="py-string">'Package'</tt> </tt>
<a name="L746"></a><tt class="py-lineno"> 746</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-name">typ</tt> <tt class="py-op">=</tt> <tt class="py-string">'Module'</tt> </tt>
<a name="L747"></a><tt class="py-lineno"> 747</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">longname</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">'script-'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L748"></a><tt class="py-lineno"> 748</tt> <tt class="py-line"> <tt class="py-name">shortname</tt> <tt class="py-op">=</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">longname</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">7</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L749"></a><tt class="py-lineno"> 749</tt> <tt class="py-line"> <tt class="py-name">typ</tt> <tt class="py-op">=</tt> <tt class="py-string">'Script'</tt> </tt>
<a name="L750"></a><tt class="py-lineno"> 750</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<!-- ==================== %s '</tt> <tt class="py-op">%</tt> <tt class="py-name">typ</tt><tt class="py-op">.</tt><tt class="py-name">upper</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> </tt>
<a name="L751"></a><tt class="py-lineno"> 751</tt> <tt class="py-line"> <tt class="py-string">'DESCRIPTION ==================== -->\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L752"></a><tt class="py-lineno"> 752</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<h1 class="epydoc">%s %s</h1>'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">typ</tt><tt class="py-op">,</tt> <tt class="py-name">shortname</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L753"></a><tt class="py-lineno"> 753</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<p class="nomargin-top">%s</p>\n'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-227" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.pysrc_link()=epydoc.docwriter.html.HTMLWriter-class.html#pysrc_link"><a title="epydoc.docwriter.html.HTMLWriter.pysrc_link" class="py-name" href="#" onclick="return doclink('link-227', 'pysrc_link', 'link-227');">pysrc_link</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L754"></a><tt class="py-lineno"> 754</tt> <tt class="py-line"> </tt>
<a name="L755"></a><tt class="py-lineno"> 755</tt> <tt class="py-line"> <tt class="py-comment"># If the module has a description, then list it.</tt> </tt>
<a name="L756"></a><tt class="py-lineno"> 756</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-228" class="py-name" targets="Variable epydoc.apidoc.APIDoc.descr=epydoc.apidoc.APIDoc-class.html#descr,Variable epydoc.cli.descr=epydoc.cli-module.html#descr,Method epydoc.docwriter.html.HTMLWriter.descr()=epydoc.docwriter.html.HTMLWriter-class.html#descr,Method epydoc.markup.ParseError.descr()=epydoc.markup.ParseError-class.html#descr,Method epydoc.markup.epytext.ColorizingError.descr()=epydoc.markup.epytext.ColorizingError-class.html#descr"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-228', 'descr', 'link-228');">descr</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-229" class="py-name" targets="Variable epydoc.apidoc.UNKNOWN=epydoc.apidoc-module.html#UNKNOWN"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-229', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L757"></a><tt class="py-lineno"> 757</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-230" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-230', 'descr', 'link-228');">descr</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-number">2</tt><tt class="py-op">)</tt><tt class="py-op">+</tt><tt class="py-string">'\n\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L758"></a><tt class="py-lineno"> 758</tt> <tt class="py-line"> </tt>
<a name="L759"></a><tt class="py-lineno"> 759</tt> <tt class="py-line"> <tt class="py-comment"># Write any standarad metadata (todo, author, etc.)</tt> </tt>
<a name="L760"></a><tt class="py-lineno"> 760</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-231" class="py-name" targets="Variable epydoc.apidoc.APIDoc.metadata=epydoc.apidoc.APIDoc-class.html#metadata"><a title="epydoc.apidoc.APIDoc.metadata" class="py-name" href="#" onclick="return doclink('link-231', 'metadata', 'link-231');">metadata</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-232" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-232', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt> <tt class="py-keyword">and</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-233" class="py-name"><a title="epydoc.apidoc.APIDoc.metadata" class="py-name" href="#" onclick="return doclink('link-233', 'metadata', 'link-231');">metadata</a></tt><tt class="py-op">:</tt> </tt>
<a name="L761"></a><tt class="py-lineno"> 761</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<hr />\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L762"></a><tt class="py-lineno"> 762</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-234" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_standard_fields()=epydoc.docwriter.html.HTMLWriter-class.html#write_standard_fields,Method epydoc.docwriter.latex.LatexWriter.write_standard_fields()=epydoc.docwriter.latex.LatexWriter-class.html#write_standard_fields"><a title="epydoc.docwriter.html.HTMLWriter.write_standard_fields
epydoc.docwriter.latex.LatexWriter.write_standard_fields" class="py-name" href="#" onclick="return doclink('link-234', 'write_standard_fields', 'link-234');">write_standard_fields</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L763"></a><tt class="py-lineno"> 763</tt> <tt class="py-line"> </tt>
<a name="L764"></a><tt class="py-lineno"> 764</tt> <tt class="py-line"> <tt class="py-comment"># If it's a package, then list the modules it contains.</tt> </tt>
<a name="L765"></a><tt class="py-lineno"> 765</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-235" class="py-name"><a title="epydoc.apidoc.ModuleDoc.is_package" class="py-name" href="#" onclick="return doclink('link-235', 'is_package', 'link-226');">is_package</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">True</tt><tt class="py-op">:</tt> </tt>
<a name="L766"></a><tt class="py-lineno"> 766</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-236" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_module_list()=epydoc.docwriter.html.HTMLWriter-class.html#write_module_list,Method epydoc.docwriter.latex.LatexWriter.write_module_list()=epydoc.docwriter.latex.LatexWriter-class.html#write_module_list"><a title="epydoc.docwriter.html.HTMLWriter.write_module_list
epydoc.docwriter.latex.LatexWriter.write_module_list" class="py-name" href="#" onclick="return doclink('link-236', 'write_module_list', 'link-236');">write_module_list</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L767"></a><tt class="py-lineno"> 767</tt> <tt class="py-line"> </tt>
<a name="L768"></a><tt class="py-lineno"> 768</tt> <tt class="py-line"> <tt class="py-comment"># Write summary tables describing the variables that the</tt> </tt>
<a name="L769"></a><tt class="py-lineno"> 769</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># module defines.</tt> </tt>
<a name="L770"></a><tt class="py-lineno"> 770</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-237" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_summary_table()=epydoc.docwriter.html.HTMLWriter-class.html#write_summary_table"><a title="epydoc.docwriter.html.HTMLWriter.write_summary_table" class="py-name" href="#" onclick="return doclink('link-237', 'write_summary_table', 'link-237');">write_summary_table</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">"Classes"</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-string">"class"</tt><tt class="py-op">)</tt> </tt>
<a name="L771"></a><tt class="py-lineno"> 771</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-238" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_summary_table" class="py-name" href="#" onclick="return doclink('link-238', 'write_summary_table', 'link-237');">write_summary_table</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">"Functions"</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-string">"function"</tt><tt class="py-op">)</tt> </tt>
<a name="L772"></a><tt class="py-lineno"> 772</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-239" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_summary_table" class="py-name" href="#" onclick="return doclink('link-239', 'write_summary_table', 'link-237');">write_summary_table</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">"Variables"</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-string">"other"</tt><tt class="py-op">)</tt> </tt>
<a name="L773"></a><tt class="py-lineno"> 773</tt> <tt class="py-line"> </tt>
<a name="L774"></a><tt class="py-lineno"> 774</tt> <tt class="py-line"> <tt class="py-comment"># Write a list of all imported objects.</tt> </tt>
<a name="L775"></a><tt class="py-lineno"> 775</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_show_imports</tt><tt class="py-op">:</tt> </tt>
<a name="L776"></a><tt class="py-lineno"> 776</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-240" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_imports()=epydoc.docwriter.html.HTMLWriter-class.html#write_imports"><a title="epydoc.docwriter.html.HTMLWriter.write_imports" class="py-name" href="#" onclick="return doclink('link-240', 'write_imports', 'link-240');">write_imports</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L777"></a><tt class="py-lineno"> 777</tt> <tt class="py-line"> </tt>
<a name="L778"></a><tt class="py-lineno"> 778</tt> <tt class="py-line"> <tt class="py-comment"># Write detailed descriptions of functions & variables defined</tt> </tt>
<a name="L779"></a><tt class="py-lineno"> 779</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># in this module.</tt> </tt>
<a name="L780"></a><tt class="py-lineno"> 780</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-241" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_details_list()=epydoc.docwriter.html.HTMLWriter-class.html#write_details_list"><a title="epydoc.docwriter.html.HTMLWriter.write_details_list" class="py-name" href="#" onclick="return doclink('link-241', 'write_details_list', 'link-241');">write_details_list</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">"Function Details"</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-string">"function"</tt><tt class="py-op">)</tt> </tt>
<a name="L781"></a><tt class="py-lineno"> 781</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-242" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_details_list" class="py-name" href="#" onclick="return doclink('link-242', 'write_details_list', 'link-241');">write_details_list</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">"Variables Details"</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-string">"other"</tt><tt class="py-op">)</tt> </tt>
<a name="L782"></a><tt class="py-lineno"> 782</tt> <tt class="py-line"> </tt>
<a name="L783"></a><tt class="py-lineno"> 783</tt> <tt class="py-line"> <tt class="py-comment"># Write the page footer (including navigation bar)</tt> </tt>
<a name="L784"></a><tt class="py-lineno"> 784</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-243" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_navbar" class="py-name" href="#" onclick="return doclink('link-243', 'write_navbar', 'link-223');">write_navbar</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L785"></a><tt class="py-lineno"> 785</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-244" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_footer()=epydoc.docwriter.html.HTMLWriter-class.html#write_footer"><a title="epydoc.docwriter.html.HTMLWriter.write_footer" class="py-name" href="#" onclick="return doclink('link-244', 'write_footer', 'link-244');">write_footer</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">)</tt> </tt>
</div><a name="L786"></a><tt class="py-lineno"> 786</tt> <tt class="py-line"> </tt>
<a name="L787"></a><tt class="py-lineno"> 787</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L788"></a><tt class="py-lineno"> 788</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ 2.??. Source Code Pages</tt> </tt>
<a name="L789"></a><tt class="py-lineno"> 789</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L790"></a><tt class="py-lineno"> 790</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="HTMLWriter.write_sourcecode"></a><div id="HTMLWriter.write_sourcecode-def"><a name="L791"></a><tt class="py-lineno"> 791</tt> <a class="py-toggle" href="#" id="HTMLWriter.write_sourcecode-toggle" onclick="return toggle('HTMLWriter.write_sourcecode');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write_sourcecode">write_sourcecode</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">,</tt> <tt class="py-param">name_to_docs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write_sourcecode-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write_sourcecode-expanded"><a name="L792"></a><tt class="py-lineno"> 792</tt> <tt class="py-line"> <tt class="py-comment">#t0 = time.time()</tt> </tt>
<a name="L793"></a><tt class="py-lineno"> 793</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L794"></a><tt class="py-lineno"> 794</tt> <tt class="py-line"> <tt id="link-245" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-245', 'filename', 'link-68');">filename</a></tt> <tt class="py-op">=</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-246" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-246', 'filename', 'link-68');">filename</a></tt> </tt>
<a name="L795"></a><tt class="py-lineno"> 795</tt> <tt class="py-line"> <tt id="link-247" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-247', 'name', 'link-117');">name</a></tt> <tt class="py-op">=</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-248" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-248', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L796"></a><tt class="py-lineno"> 796</tt> <tt class="py-line"> </tt>
<a name="L797"></a><tt class="py-lineno"> 797</tt> <tt class="py-line"> <tt class="py-comment"># Header</tt> </tt>
<a name="L798"></a><tt class="py-lineno"> 798</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-249" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_header
epydoc.docwriter.latex.LatexWriter.write_header" class="py-name" href="#" onclick="return doclink('link-249', 'write_header', 'link-222');">write_header</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt id="link-250" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-250', 'name', 'link-117');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L799"></a><tt class="py-lineno"> 799</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-251" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_navbar" class="py-name" href="#" onclick="return doclink('link-251', 'write_navbar', 'link-223');">write_navbar</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L800"></a><tt class="py-lineno"> 800</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-252" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_breadcrumbs" class="py-name" href="#" onclick="return doclink('link-252', 'write_breadcrumbs', 'link-224');">write_breadcrumbs</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-253" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.pysrc_url" class="py-name" href="#" onclick="return doclink('link-253', 'pysrc_url', 'link-183');">pysrc_url</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L801"></a><tt class="py-lineno"> 801</tt> <tt class="py-line"> </tt>
<a name="L802"></a><tt class="py-lineno"> 802</tt> <tt class="py-line"> <tt class="py-comment"># Source code listing</tt> </tt>
<a name="L803"></a><tt class="py-lineno"> 803</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<h1 class="epydoc">Source Code for %s</h1>\n'</tt> <tt class="py-op">%</tt> </tt>
<a name="L804"></a><tt class="py-lineno"> 804</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-254" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.href()=epydoc.docwriter.html.HTMLWriter-class.html#href"><a title="epydoc.docwriter.html.HTMLWriter.href" class="py-name" href="#" onclick="return doclink('link-254', 'href', 'link-254');">href</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-255" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-255', 'label', 'link-118');">label</a></tt><tt class="py-op">=</tt><tt class="py-string">'%s %s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-256" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.doc_kind()=epydoc.docwriter.html.HTMLWriter-class.html#doc_kind,Method epydoc.docwriter.html_colorize.PythonSourceColorizer.doc_kind()=epydoc.docwriter.html_colorize.PythonSourceColorizer-class.html#doc_kind,Method epydoc.docwriter.latex.LatexWriter.doc_kind()=epydoc.docwriter.latex.LatexWriter-class.html#doc_kind"><a title="epydoc.docwriter.html.HTMLWriter.doc_kind
epydoc.docwriter.html_colorize.PythonSourceColorizer.doc_kind
epydoc.docwriter.latex.LatexWriter.doc_kind" class="py-name" href="#" onclick="return doclink('link-256', 'doc_kind', 'link-256');">doc_kind</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt id="link-257" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-257', 'name', 'link-117');">name</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L805"></a><tt class="py-lineno"> 805</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<pre class="py-src">\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L806"></a><tt class="py-lineno"> 806</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt id="link-258" class="py-name"><a title="epydoc.docwriter.html_colorize.PythonSourceColorizer" class="py-name" href="#" onclick="return doclink('link-258', 'PythonSourceColorizer', 'link-13');">PythonSourceColorizer</a></tt><tt class="py-op">(</tt><tt id="link-259" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-259', 'filename', 'link-68');">filename</a></tt><tt class="py-op">,</tt> <tt id="link-260" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-260', 'name', 'link-117');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">docindex</tt><tt class="py-op">,</tt> </tt>
<a name="L807"></a><tt class="py-lineno"> 807</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-261" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-261', 'url', 'link-72');">url</a></tt><tt class="py-op">,</tt> <tt class="py-name">name_to_docs</tt><tt class="py-op">,</tt> </tt>
<a name="L808"></a><tt class="py-lineno"> 808</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_src_code_tab_width</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-262" class="py-name" targets="Method epydoc.docwriter.html_colorize.PythonSourceColorizer.colorize()=epydoc.docwriter.html_colorize.PythonSourceColorizer-class.html#colorize,Method epydoc.markup.pyval_repr.PyvalColorizer.colorize()=epydoc.markup.pyval_repr.PyvalColorizer-class.html#colorize"><a title="epydoc.docwriter.html_colorize.PythonSourceColorizer.colorize
epydoc.markup.pyval_repr.PyvalColorizer.colorize" class="py-name" href="#" onclick="return doclink('link-262', 'colorize', 'link-262');">colorize</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L809"></a><tt class="py-lineno"> 809</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'</pre>\n<br />\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L810"></a><tt class="py-lineno"> 810</tt> <tt class="py-line"> </tt>
<a name="L811"></a><tt class="py-lineno"> 811</tt> <tt class="py-line"> <tt class="py-comment"># Footer</tt> </tt>
<a name="L812"></a><tt class="py-lineno"> 812</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-263" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_navbar" class="py-name" href="#" onclick="return doclink('link-263', 'write_navbar', 'link-223');">write_navbar</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L813"></a><tt class="py-lineno"> 813</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-264" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_footer" class="py-name" href="#" onclick="return doclink('link-264', 'write_footer', 'link-244');">write_footer</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">)</tt> </tt>
</div><a name="L814"></a><tt class="py-lineno"> 814</tt> <tt class="py-line"> </tt>
<a name="L815"></a><tt class="py-lineno"> 815</tt> <tt class="py-line"> <tt class="py-comment">#log.debug('[%6.2f sec] Wrote pysrc for %s' %</tt> </tt>
<a name="L816"></a><tt class="py-lineno"> 816</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># (time.time()-t0, name))</tt> </tt>
<a name="L817"></a><tt class="py-lineno"> 817</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L818"></a><tt class="py-lineno"> 818</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L819"></a><tt class="py-lineno"> 819</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ 2.2. Class Pages</tt> </tt>
<a name="L820"></a><tt class="py-lineno"> 820</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L821"></a><tt class="py-lineno"> 821</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="HTMLWriter.write_class"></a><div id="HTMLWriter.write_class-def"><a name="L822"></a><tt class="py-lineno"> 822</tt> <a class="py-toggle" href="#" id="HTMLWriter.write_class-toggle" onclick="return toggle('HTMLWriter.write_class');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write_class">write_class</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write_class-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write_class-expanded"><a name="L823"></a><tt class="py-lineno"> 823</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L824"></a><tt class="py-lineno"> 824</tt> <tt class="py-line"><tt class="py-docstring"> Write an HTML page containing the API documentation for the</tt> </tt>
<a name="L825"></a><tt class="py-lineno"> 825</tt> <tt class="py-line"><tt class="py-docstring"> given class to C{out}.</tt> </tt>
<a name="L826"></a><tt class="py-lineno"> 826</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L827"></a><tt class="py-lineno"> 827</tt> <tt class="py-line"><tt class="py-docstring"> @param doc: A L{ClassDoc} containing the API documentation</tt> </tt>
<a name="L828"></a><tt class="py-lineno"> 828</tt> <tt class="py-line"><tt class="py-docstring"> for the class that should be described.</tt> </tt>
<a name="L829"></a><tt class="py-lineno"> 829</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L830"></a><tt class="py-lineno"> 830</tt> <tt class="py-line"> <tt class="py-name">longname</tt> <tt class="py-op">=</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-265" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-265', 'canonical_name', 'link-82');">canonical_name</a></tt> </tt>
<a name="L831"></a><tt class="py-lineno"> 831</tt> <tt class="py-line"> <tt class="py-name">shortname</tt> <tt class="py-op">=</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-266" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-266', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt>
<a name="L832"></a><tt class="py-lineno"> 832</tt> <tt class="py-line"> </tt>
<a name="L833"></a><tt class="py-lineno"> 833</tt> <tt class="py-line"> <tt class="py-comment"># Write the page header (incl. navigation bar & breadcrumbs)</tt> </tt>
<a name="L834"></a><tt class="py-lineno"> 834</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-267" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_header
epydoc.docwriter.latex.LatexWriter.write_header" class="py-name" href="#" onclick="return doclink('link-267', 'write_header', 'link-222');">write_header</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">longname</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L835"></a><tt class="py-lineno"> 835</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-268" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_navbar" class="py-name" href="#" onclick="return doclink('link-268', 'write_navbar', 'link-223');">write_navbar</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L836"></a><tt class="py-lineno"> 836</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-269" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_breadcrumbs" class="py-name" href="#" onclick="return doclink('link-269', 'write_breadcrumbs', 'link-224');">write_breadcrumbs</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-270" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-270', 'url', 'link-72');">url</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L837"></a><tt class="py-lineno"> 837</tt> <tt class="py-line"> </tt>
<a name="L838"></a><tt class="py-lineno"> 838</tt> <tt class="py-line"> <tt class="py-comment"># Write the name of the class we're describing.</tt> </tt>
<a name="L839"></a><tt class="py-lineno"> 839</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-271" class="py-name" targets="Method epydoc.apidoc.ClassDoc.is_type()=epydoc.apidoc.ClassDoc-class.html#is_type"><a title="epydoc.apidoc.ClassDoc.is_type" class="py-name" href="#" onclick="return doclink('link-271', 'is_type', 'link-271');">is_type</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-name">typ</tt> <tt class="py-op">=</tt> <tt class="py-string">'Type'</tt> </tt>
<a name="L840"></a><tt class="py-lineno"> 840</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-272" class="py-name" targets="Method epydoc.apidoc.ClassDoc.is_exception()=epydoc.apidoc.ClassDoc-class.html#is_exception"><a title="epydoc.apidoc.ClassDoc.is_exception" class="py-name" href="#" onclick="return doclink('link-272', 'is_exception', 'link-272');">is_exception</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-name">typ</tt> <tt class="py-op">=</tt> <tt class="py-string">'Exception'</tt> </tt>
<a name="L841"></a><tt class="py-lineno"> 841</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-name">typ</tt> <tt class="py-op">=</tt> <tt class="py-string">'Class'</tt> </tt>
<a name="L842"></a><tt class="py-lineno"> 842</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<!-- ==================== %s '</tt> <tt class="py-op">%</tt> <tt class="py-name">typ</tt><tt class="py-op">.</tt><tt class="py-name">upper</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> </tt>
<a name="L843"></a><tt class="py-lineno"> 843</tt> <tt class="py-line"> <tt class="py-string">'DESCRIPTION ==================== -->\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L844"></a><tt class="py-lineno"> 844</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<h1 class="epydoc">%s %s</h1>'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">typ</tt><tt class="py-op">,</tt> <tt class="py-name">shortname</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L845"></a><tt class="py-lineno"> 845</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<p class="nomargin-top">%s</p>\n'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-273" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.pysrc_link" class="py-name" href="#" onclick="return doclink('link-273', 'pysrc_link', 'link-227');">pysrc_link</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L846"></a><tt class="py-lineno"> 846</tt> <tt class="py-line"> </tt>
<a name="L847"></a><tt class="py-lineno"> 847</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-274" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-274', 'bases', 'link-52');">bases</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt id="link-275" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-275', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-276" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-276', 'bases', 'link-52');">bases</a></tt><tt class="py-op">)</tt> <tt class="py-op">></tt> <tt class="py-number">0</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L848"></a><tt class="py-lineno"> 848</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-277" class="py-name"><a title="epydoc.apidoc.ClassDoc.subclasses" class="py-name" href="#" onclick="return doclink('link-277', 'subclasses', 'link-54');">subclasses</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt id="link-278" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-278', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">,</tt><tt class="py-name">None</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-279" class="py-name"><a title="epydoc.apidoc.ClassDoc.subclasses" class="py-name" href="#" onclick="return doclink('link-279', 'subclasses', 'link-54');">subclasses</a></tt><tt class="py-op">)</tt><tt class="py-op">></tt><tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L849"></a><tt class="py-lineno"> 849</tt> <tt class="py-line"> <tt class="py-comment"># Display bases graphically, if requested.</tt> </tt>
<a name="L850"></a><tt class="py-lineno"> 850</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-string">'umlclasstree'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_graph_types</tt><tt class="py-op">:</tt> </tt>
<a name="L851"></a><tt class="py-lineno"> 851</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-280" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_class_tree_graph()=epydoc.docwriter.html.HTMLWriter-class.html#write_class_tree_graph"><a title="epydoc.docwriter.html.HTMLWriter.write_class_tree_graph" class="py-name" href="#" onclick="return doclink('link-280', 'write_class_tree_graph', 'link-280');">write_class_tree_graph</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-281" class="py-name" targets="Function epydoc.docwriter.dotgraph.uml_class_tree_graph()=epydoc.docwriter.dotgraph-module.html#uml_class_tree_graph"><a title="epydoc.docwriter.dotgraph.uml_class_tree_graph" class="py-name" href="#" onclick="return doclink('link-281', 'uml_class_tree_graph', 'link-281');">uml_class_tree_graph</a></tt><tt class="py-op">)</tt> </tt>
<a name="L852"></a><tt class="py-lineno"> 852</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-string">'classtree'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_graph_types</tt><tt class="py-op">:</tt> </tt>
<a name="L853"></a><tt class="py-lineno"> 853</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-282" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_class_tree_graph" class="py-name" href="#" onclick="return doclink('link-282', 'write_class_tree_graph', 'link-280');">write_class_tree_graph</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-283" class="py-name" targets="Function epydoc.docwriter.dotgraph.class_tree_graph()=epydoc.docwriter.dotgraph-module.html#class_tree_graph"><a title="epydoc.docwriter.dotgraph.class_tree_graph" class="py-name" href="#" onclick="return doclink('link-283', 'class_tree_graph', 'link-283');">class_tree_graph</a></tt><tt class="py-op">)</tt> </tt>
<a name="L854"></a><tt class="py-lineno"> 854</tt> <tt class="py-line"> </tt>
<a name="L855"></a><tt class="py-lineno"> 855</tt> <tt class="py-line"> <tt class="py-comment"># Otherwise, use ascii-art.</tt> </tt>
<a name="L856"></a><tt class="py-lineno"> 856</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L857"></a><tt class="py-lineno"> 857</tt> <tt class="py-line"> <tt class="py-comment"># Write the base class tree.</tt> </tt>
<a name="L858"></a><tt class="py-lineno"> 858</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-284" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-284', 'bases', 'link-52');">bases</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt id="link-285" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-285', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-286" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-286', 'bases', 'link-52');">bases</a></tt><tt class="py-op">)</tt> <tt class="py-op">></tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L859"></a><tt class="py-lineno"> 859</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<pre class="base-tree">\n%s</pre>\n\n'</tt> <tt class="py-op">%</tt> </tt>
<a name="L860"></a><tt class="py-lineno"> 860</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-287" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.base_tree()=epydoc.docwriter.html.HTMLWriter-class.html#base_tree,Method epydoc.docwriter.latex.LatexWriter.base_tree()=epydoc.docwriter.latex.LatexWriter-class.html#base_tree"><a title="epydoc.docwriter.html.HTMLWriter.base_tree
epydoc.docwriter.latex.LatexWriter.base_tree" class="py-name" href="#" onclick="return doclink('link-287', 'base_tree', 'link-287');">base_tree</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L861"></a><tt class="py-lineno"> 861</tt> <tt class="py-line"> </tt>
<a name="L862"></a><tt class="py-lineno"> 862</tt> <tt class="py-line"> <tt class="py-comment"># Write the known subclasses</tt> </tt>
<a name="L863"></a><tt class="py-lineno"> 863</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-288" class="py-name"><a title="epydoc.apidoc.ClassDoc.subclasses" class="py-name" href="#" onclick="return doclink('link-288', 'subclasses', 'link-54');">subclasses</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt id="link-289" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-289', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L864"></a><tt class="py-lineno"> 864</tt> <tt class="py-line"> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-290" class="py-name"><a title="epydoc.apidoc.ClassDoc.subclasses" class="py-name" href="#" onclick="return doclink('link-290', 'subclasses', 'link-54');">subclasses</a></tt><tt class="py-op">)</tt> <tt class="py-op">></tt> <tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L865"></a><tt class="py-lineno"> 865</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<dl><dt>Known Subclasses:</dt>\n<dd>\n '</tt><tt class="py-op">)</tt> </tt>
<a name="L866"></a><tt class="py-lineno"> 866</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' <ul class="subclass-list">\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L867"></a><tt class="py-lineno"> 867</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">i</tt><tt class="py-op">,</tt> <tt class="py-name">subclass</tt> <tt class="py-keyword">in</tt> <tt class="py-name">enumerate</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-291" class="py-name"><a title="epydoc.apidoc.ClassDoc.subclasses" class="py-name" href="#" onclick="return doclink('link-291', 'subclasses', 'link-54');">subclasses</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L868"></a><tt class="py-lineno"> 868</tt> <tt class="py-line"> <tt id="link-292" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.href" class="py-name" href="#" onclick="return doclink('link-292', 'href', 'link-254');">href</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-293" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.href" class="py-name" href="#" onclick="return doclink('link-293', 'href', 'link-254');">href</a></tt><tt class="py-op">(</tt><tt class="py-name">subclass</tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">=</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L869"></a><tt class="py-lineno"> 869</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-294" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter._val_is_public()=epydoc.docwriter.html.HTMLWriter-class.html#_val_is_public"><a title="epydoc.docwriter.html.HTMLWriter._val_is_public" class="py-name" href="#" onclick="return doclink('link-294', '_val_is_public', 'link-294');">_val_is_public</a></tt><tt class="py-op">(</tt><tt class="py-name">subclass</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-name">css</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
<a name="L870"></a><tt class="py-lineno"> 870</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-name">css</tt> <tt class="py-op">=</tt> <tt class="py-string">' class="private"'</tt> </tt>
<a name="L871"></a><tt class="py-lineno"> 871</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">i</tt> <tt class="py-op">></tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> <tt id="link-295" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.href" class="py-name" href="#" onclick="return doclink('link-295', 'href', 'link-254');">href</a></tt> <tt class="py-op">=</tt> <tt class="py-string">', '</tt><tt class="py-op">+</tt><tt id="link-296" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.href" class="py-name" href="#" onclick="return doclink('link-296', 'href', 'link-254');">href</a></tt> </tt>
<a name="L872"></a><tt class="py-lineno"> 872</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<li%s>%s</li>'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">css</tt><tt class="py-op">,</tt> <tt id="link-297" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.href" class="py-name" href="#" onclick="return doclink('link-297', 'href', 'link-254');">href</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L873"></a><tt class="py-lineno"> 873</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' </ul>\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L874"></a><tt class="py-lineno"> 874</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'</dd></dl>\n\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L875"></a><tt class="py-lineno"> 875</tt> <tt class="py-line"> </tt>
<a name="L876"></a><tt class="py-lineno"> 876</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<hr />\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L877"></a><tt class="py-lineno"> 877</tt> <tt class="py-line"> </tt>
<a name="L878"></a><tt class="py-lineno"> 878</tt> <tt class="py-line"> <tt class="py-comment"># If the class has a description, then list it.</tt> </tt>
<a name="L879"></a><tt class="py-lineno"> 879</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-298" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-298', 'descr', 'link-228');">descr</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-299" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-299', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L880"></a><tt class="py-lineno"> 880</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-300" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-300', 'descr', 'link-228');">descr</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-number">2</tt><tt class="py-op">)</tt><tt class="py-op">+</tt><tt class="py-string">'\n\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L881"></a><tt class="py-lineno"> 881</tt> <tt class="py-line"> </tt>
<a name="L882"></a><tt class="py-lineno"> 882</tt> <tt class="py-line"> <tt class="py-comment"># Write any standarad metadata (todo, author, etc.)</tt> </tt>
<a name="L883"></a><tt class="py-lineno"> 883</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-301" class="py-name"><a title="epydoc.apidoc.APIDoc.metadata" class="py-name" href="#" onclick="return doclink('link-301', 'metadata', 'link-231');">metadata</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-302" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-302', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt> <tt class="py-keyword">and</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-303" class="py-name"><a title="epydoc.apidoc.APIDoc.metadata" class="py-name" href="#" onclick="return doclink('link-303', 'metadata', 'link-231');">metadata</a></tt><tt class="py-op">:</tt> </tt>
<a name="L884"></a><tt class="py-lineno"> 884</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<hr />\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L885"></a><tt class="py-lineno"> 885</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-304" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_standard_fields
epydoc.docwriter.latex.LatexWriter.write_standard_fields" class="py-name" href="#" onclick="return doclink('link-304', 'write_standard_fields', 'link-234');">write_standard_fields</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L886"></a><tt class="py-lineno"> 886</tt> <tt class="py-line"> </tt>
<a name="L887"></a><tt class="py-lineno"> 887</tt> <tt class="py-line"> <tt class="py-comment"># Write summary tables describing the variables that the</tt> </tt>
<a name="L888"></a><tt class="py-lineno"> 888</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># class defines.</tt> </tt>
<a name="L889"></a><tt class="py-lineno"> 889</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-305" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_summary_table" class="py-name" href="#" onclick="return doclink('link-305', 'write_summary_table', 'link-237');">write_summary_table</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">"Nested Classes"</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-string">"class"</tt><tt class="py-op">)</tt> </tt>
<a name="L890"></a><tt class="py-lineno"> 890</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-306" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_summary_table" class="py-name" href="#" onclick="return doclink('link-306', 'write_summary_table', 'link-237');">write_summary_table</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">"Instance Methods"</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> </tt>
<a name="L891"></a><tt class="py-lineno"> 891</tt> <tt class="py-line"> <tt class="py-string">"instancemethod"</tt><tt class="py-op">)</tt> </tt>
<a name="L892"></a><tt class="py-lineno"> 892</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-307" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_summary_table" class="py-name" href="#" onclick="return doclink('link-307', 'write_summary_table', 'link-237');">write_summary_table</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">"Class Methods"</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-string">"classmethod"</tt><tt class="py-op">)</tt> </tt>
<a name="L893"></a><tt class="py-lineno"> 893</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-308" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_summary_table" class="py-name" href="#" onclick="return doclink('link-308', 'write_summary_table', 'link-237');">write_summary_table</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">"Static Methods"</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-string">"staticmethod"</tt><tt class="py-op">)</tt> </tt>
<a name="L894"></a><tt class="py-lineno"> 894</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-309" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_summary_table" class="py-name" href="#" onclick="return doclink('link-309', 'write_summary_table', 'link-237');">write_summary_table</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">"Class Variables"</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> </tt>
<a name="L895"></a><tt class="py-lineno"> 895</tt> <tt class="py-line"> <tt class="py-string">"classvariable"</tt><tt class="py-op">)</tt> </tt>
<a name="L896"></a><tt class="py-lineno"> 896</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-310" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_summary_table" class="py-name" href="#" onclick="return doclink('link-310', 'write_summary_table', 'link-237');">write_summary_table</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">"Instance Variables"</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> </tt>
<a name="L897"></a><tt class="py-lineno"> 897</tt> <tt class="py-line"> <tt class="py-string">"instancevariable"</tt><tt class="py-op">)</tt> </tt>
<a name="L898"></a><tt class="py-lineno"> 898</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-311" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_summary_table" class="py-name" href="#" onclick="return doclink('link-311', 'write_summary_table', 'link-237');">write_summary_table</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">"Properties"</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-string">"property"</tt><tt class="py-op">)</tt> </tt>
<a name="L899"></a><tt class="py-lineno"> 899</tt> <tt class="py-line"> </tt>
<a name="L900"></a><tt class="py-lineno"> 900</tt> <tt class="py-line"> <tt class="py-comment"># Write a list of all imported objects.</tt> </tt>
<a name="L901"></a><tt class="py-lineno"> 901</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_show_imports</tt><tt class="py-op">:</tt> </tt>
<a name="L902"></a><tt class="py-lineno"> 902</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-312" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_imports" class="py-name" href="#" onclick="return doclink('link-312', 'write_imports', 'link-240');">write_imports</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L903"></a><tt class="py-lineno"> 903</tt> <tt class="py-line"> </tt>
<a name="L904"></a><tt class="py-lineno"> 904</tt> <tt class="py-line"> <tt class="py-comment"># Write detailed descriptions of functions & variables defined</tt> </tt>
<a name="L905"></a><tt class="py-lineno"> 905</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># in this class.</tt> </tt>
<a name="L906"></a><tt class="py-lineno"> 906</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># [xx] why group methods into one section but split vars into two?</tt> </tt>
<a name="L907"></a><tt class="py-lineno"> 907</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># seems like we should either group in both cases or split in both</tt> </tt>
<a name="L908"></a><tt class="py-lineno"> 908</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># cases.</tt> </tt>
<a name="L909"></a><tt class="py-lineno"> 909</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-313" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_details_list" class="py-name" href="#" onclick="return doclink('link-313', 'write_details_list', 'link-241');">write_details_list</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">"Method Details"</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-string">"method"</tt><tt class="py-op">)</tt> </tt>
<a name="L910"></a><tt class="py-lineno"> 910</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-314" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_details_list" class="py-name" href="#" onclick="return doclink('link-314', 'write_details_list', 'link-241');">write_details_list</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">"Class Variable Details"</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> </tt>
<a name="L911"></a><tt class="py-lineno"> 911</tt> <tt class="py-line"> <tt class="py-string">"classvariable"</tt><tt class="py-op">)</tt> </tt>
<a name="L912"></a><tt class="py-lineno"> 912</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-315" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_details_list" class="py-name" href="#" onclick="return doclink('link-315', 'write_details_list', 'link-241');">write_details_list</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">"Instance Variable Details"</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> </tt>
<a name="L913"></a><tt class="py-lineno"> 913</tt> <tt class="py-line"> <tt class="py-string">"instancevariable"</tt><tt class="py-op">)</tt> </tt>
<a name="L914"></a><tt class="py-lineno"> 914</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-316" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_details_list" class="py-name" href="#" onclick="return doclink('link-316', 'write_details_list', 'link-241');">write_details_list</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">"Property Details"</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-string">"property"</tt><tt class="py-op">)</tt> </tt>
<a name="L915"></a><tt class="py-lineno"> 915</tt> <tt class="py-line"> </tt>
<a name="L916"></a><tt class="py-lineno"> 916</tt> <tt class="py-line"> <tt class="py-comment"># Write the page footer (including navigation bar)</tt> </tt>
<a name="L917"></a><tt class="py-lineno"> 917</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-317" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_navbar" class="py-name" href="#" onclick="return doclink('link-317', 'write_navbar', 'link-223');">write_navbar</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L918"></a><tt class="py-lineno"> 918</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-318" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_footer" class="py-name" href="#" onclick="return doclink('link-318', 'write_footer', 'link-244');">write_footer</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">)</tt> </tt>
</div><a name="L919"></a><tt class="py-lineno"> 919</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.write_class_tree_graph"></a><div id="HTMLWriter.write_class_tree_graph-def"><a name="L920"></a><tt class="py-lineno"> 920</tt> <a class="py-toggle" href="#" id="HTMLWriter.write_class_tree_graph-toggle" onclick="return toggle('HTMLWriter.write_class_tree_graph');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write_class_tree_graph">write_class_tree_graph</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">,</tt> <tt class="py-param">graphmaker</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write_class_tree_graph-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write_class_tree_graph-expanded"><a name="L921"></a><tt class="py-lineno"> 921</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L922"></a><tt class="py-lineno"> 922</tt> <tt class="py-line"><tt class="py-docstring"> Write HTML code for a class tree graph of C{doc} (a classdoc),</tt> </tt>
<a name="L923"></a><tt class="py-lineno"> 923</tt> <tt class="py-line"><tt class="py-docstring"> using C{graphmaker} to draw the actual graph. C{graphmaker}</tt> </tt>
<a name="L924"></a><tt class="py-lineno"> 924</tt> <tt class="py-line"><tt class="py-docstring"> should be L{class_tree_graph()}, or L{uml_class_tree_graph()},</tt> </tt>
<a name="L925"></a><tt class="py-lineno"> 925</tt> <tt class="py-line"><tt class="py-docstring"> or any other function with a compatible signature.</tt> </tt>
<a name="L926"></a><tt class="py-lineno"> 926</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L927"></a><tt class="py-lineno"> 927</tt> <tt class="py-line"><tt class="py-docstring"> If the given class has any private sublcasses (including</tt> </tt>
<a name="L928"></a><tt class="py-lineno"> 928</tt> <tt class="py-line"><tt class="py-docstring"> recursive subclasses), then two graph images will be generated</tt> </tt>
<a name="L929"></a><tt class="py-lineno"> 929</tt> <tt class="py-line"><tt class="py-docstring"> -- one to display when private values are shown, and the other</tt> </tt>
<a name="L930"></a><tt class="py-lineno"> 930</tt> <tt class="py-line"><tt class="py-docstring"> to display when private values are hidden.</tt> </tt>
<a name="L931"></a><tt class="py-lineno"> 931</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L932"></a><tt class="py-lineno"> 932</tt> <tt class="py-line"> <tt class="py-name">linker</tt> <tt class="py-op">=</tt> <tt id="link-319" class="py-name" targets="Class epydoc.docwriter.html._HTMLDocstringLinker=epydoc.docwriter.html._HTMLDocstringLinker-class.html"><a title="epydoc.docwriter.html._HTMLDocstringLinker" class="py-name" href="#" onclick="return doclink('link-319', '_HTMLDocstringLinker', 'link-319');">_HTMLDocstringLinker</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L933"></a><tt class="py-lineno"> 933</tt> <tt class="py-line"> <tt class="py-name">private_subcls</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-320" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter._private_subclasses()=epydoc.docwriter.html.HTMLWriter-class.html#_private_subclasses"><a title="epydoc.docwriter.html.HTMLWriter._private_subclasses" class="py-name" href="#" onclick="return doclink('link-320', '_private_subclasses', 'link-320');">_private_subclasses</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L934"></a><tt class="py-lineno"> 934</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">private_subcls</tt><tt class="py-op">:</tt> </tt>
<a name="L935"></a><tt class="py-lineno"> 935</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<center>\n'</tt> </tt>
<a name="L936"></a><tt class="py-lineno"> 936</tt> <tt class="py-line"> <tt class="py-string">' <div class="private">%s</div>\n'</tt> </tt>
<a name="L937"></a><tt class="py-lineno"> 937</tt> <tt class="py-line"> <tt class="py-string">' <div class="public" style="display:none">%s</div>\n'</tt> </tt>
<a name="L938"></a><tt class="py-lineno"> 938</tt> <tt class="py-line"> <tt class="py-string">'</center>\n'</tt> <tt class="py-op">%</tt> </tt>
<a name="L939"></a><tt class="py-lineno"> 939</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-321" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.render_graph()=epydoc.docwriter.html.HTMLWriter-class.html#render_graph"><a title="epydoc.docwriter.html.HTMLWriter.render_graph" class="py-name" href="#" onclick="return doclink('link-321', 'render_graph', 'link-321');">render_graph</a></tt><tt class="py-op">(</tt><tt class="py-name">graphmaker</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-name">linker</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L940"></a><tt class="py-lineno"> 940</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-322" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.render_graph" class="py-name" href="#" onclick="return doclink('link-322', 'render_graph', 'link-321');">render_graph</a></tt><tt class="py-op">(</tt><tt class="py-name">graphmaker</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-name">linker</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> </tt>
<a name="L941"></a><tt class="py-lineno"> 941</tt> <tt class="py-line"> <tt class="py-name">exclude</tt><tt class="py-op">=</tt><tt class="py-name">private_subcls</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L942"></a><tt class="py-lineno"> 942</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L943"></a><tt class="py-lineno"> 943</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<center>\n%s\n</center>\n'</tt> <tt class="py-op">%</tt> </tt>
<a name="L944"></a><tt class="py-lineno"> 944</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-323" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.render_graph" class="py-name" href="#" onclick="return doclink('link-323', 'render_graph', 'link-321');">render_graph</a></tt><tt class="py-op">(</tt><tt class="py-name">graphmaker</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-name">linker</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L945"></a><tt class="py-lineno"> 945</tt> <tt class="py-line"> </tt>
<a name="L946"></a><tt class="py-lineno"> 946</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L947"></a><tt class="py-lineno"> 947</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ 2.3. Trees pages</tt> </tt>
<a name="L948"></a><tt class="py-lineno"> 948</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L949"></a><tt class="py-lineno"> 949</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="HTMLWriter.write_module_tree"></a><div id="HTMLWriter.write_module_tree-def"><a name="L950"></a><tt class="py-lineno"> 950</tt> <a class="py-toggle" href="#" id="HTMLWriter.write_module_tree-toggle" onclick="return toggle('HTMLWriter.write_module_tree');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module_tree">write_module_tree</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write_module_tree-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write_module_tree-expanded"><a name="L951"></a><tt class="py-lineno"> 951</tt> <tt class="py-line"> <tt class="py-comment"># Header material</tt> </tt>
<a name="L952"></a><tt class="py-lineno"> 952</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-324" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_treepage_header()=epydoc.docwriter.html.HTMLWriter-class.html#write_treepage_header"><a title="epydoc.docwriter.html.HTMLWriter.write_treepage_header" class="py-name" href="#" onclick="return doclink('link-324', 'write_treepage_header', 'link-324');">write_treepage_header</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">'Module Hierarchy'</tt><tt class="py-op">,</tt> <tt class="py-string">'module-tree.html'</tt><tt class="py-op">)</tt> </tt>
<a name="L953"></a><tt class="py-lineno"> 953</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<h1 class="epydoc">Module Hierarchy</h1>\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L954"></a><tt class="py-lineno"> 954</tt> <tt class="py-line"> </tt>
<a name="L955"></a><tt class="py-lineno"> 955</tt> <tt class="py-line"> <tt class="py-comment"># Write entries for all top-level modules/packages.</tt> </tt>
<a name="L956"></a><tt class="py-lineno"> 956</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<ul class="nomargin-top">\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L957"></a><tt class="py-lineno"> 957</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">module_list</tt><tt class="py-op">:</tt> </tt>
<a name="L958"></a><tt class="py-lineno"> 958</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-325" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.package=epydoc.apidoc.ModuleDoc-class.html#package"><a title="epydoc.apidoc.ModuleDoc.package" class="py-name" href="#" onclick="return doclink('link-325', 'package', 'link-325');">package</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-326" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-326', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L959"></a><tt class="py-lineno"> 959</tt> <tt class="py-line"> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-327" class="py-name"><a title="epydoc.apidoc.ModuleDoc.package" class="py-name" href="#" onclick="return doclink('link-327', 'package', 'link-325');">package</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">module_set</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L960"></a><tt class="py-lineno"> 960</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-328" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_module_tree_item()=epydoc.docwriter.html.HTMLWriter-class.html#write_module_tree_item,Method epydoc.docwriter.latex.LatexWriter.write_module_tree_item()=epydoc.docwriter.latex.LatexWriter-class.html#write_module_tree_item"><a title="epydoc.docwriter.html.HTMLWriter.write_module_tree_item
epydoc.docwriter.latex.LatexWriter.write_module_tree_item" class="py-name" href="#" onclick="return doclink('link-328', 'write_module_tree_item', 'link-328');">write_module_tree_item</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L961"></a><tt class="py-lineno"> 961</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'</ul>\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L962"></a><tt class="py-lineno"> 962</tt> <tt class="py-line"> </tt>
<a name="L963"></a><tt class="py-lineno"> 963</tt> <tt class="py-line"> <tt class="py-comment"># Footer material</tt> </tt>
<a name="L964"></a><tt class="py-lineno"> 964</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-329" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_navbar" class="py-name" href="#" onclick="return doclink('link-329', 'write_navbar', 'link-223');">write_navbar</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">'trees'</tt><tt class="py-op">)</tt> </tt>
<a name="L965"></a><tt class="py-lineno"> 965</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-330" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_footer" class="py-name" href="#" onclick="return doclink('link-330', 'write_footer', 'link-244');">write_footer</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">)</tt> </tt>
</div><a name="L966"></a><tt class="py-lineno"> 966</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.write_class_tree"></a><div id="HTMLWriter.write_class_tree-def"><a name="L967"></a><tt class="py-lineno"> 967</tt> <a class="py-toggle" href="#" id="HTMLWriter.write_class_tree-toggle" onclick="return toggle('HTMLWriter.write_class_tree');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write_class_tree">write_class_tree</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write_class_tree-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write_class_tree-expanded"><a name="L968"></a><tt class="py-lineno"> 968</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L969"></a><tt class="py-lineno"> 969</tt> <tt class="py-line"><tt class="py-docstring"> Write HTML code for a nested list showing the base/subclass</tt> </tt>
<a name="L970"></a><tt class="py-lineno"> 970</tt> <tt class="py-line"><tt class="py-docstring"> relationships between all documented classes. Each element of</tt> </tt>
<a name="L971"></a><tt class="py-lineno"> 971</tt> <tt class="py-line"><tt class="py-docstring"> the top-level list is a class with no (documented) bases; and</tt> </tt>
<a name="L972"></a><tt class="py-lineno"> 972</tt> <tt class="py-line"><tt class="py-docstring"> under each class is listed all of its subclasses. Note that</tt> </tt>
<a name="L973"></a><tt class="py-lineno"> 973</tt> <tt class="py-line"><tt class="py-docstring"> in the case of multiple inheritance, a class may appear</tt> </tt>
<a name="L974"></a><tt class="py-lineno"> 974</tt> <tt class="py-line"><tt class="py-docstring"> multiple times. </tt> </tt>
<a name="L975"></a><tt class="py-lineno"> 975</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L976"></a><tt class="py-lineno"> 976</tt> <tt class="py-line"><tt class="py-docstring"> @todo: For multiple inheritance, don't repeat subclasses the</tt> </tt>
<a name="L977"></a><tt class="py-lineno"> 977</tt> <tt class="py-line"><tt class="py-docstring"> second time a class is mentioned; instead, link to the</tt> </tt>
<a name="L978"></a><tt class="py-lineno"> 978</tt> <tt class="py-line"><tt class="py-docstring"> first mention.</tt> </tt>
<a name="L979"></a><tt class="py-lineno"> 979</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L980"></a><tt class="py-lineno"> 980</tt> <tt class="py-line"> <tt class="py-comment"># [XX] backref for multiple inheritance?</tt> </tt>
<a name="L981"></a><tt class="py-lineno"> 981</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># Header material</tt> </tt>
<a name="L982"></a><tt class="py-lineno"> 982</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-331" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_treepage_header" class="py-name" href="#" onclick="return doclink('link-331', 'write_treepage_header', 'link-324');">write_treepage_header</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">'Class Hierarchy'</tt><tt class="py-op">,</tt> <tt class="py-string">'class-tree.html'</tt><tt class="py-op">)</tt> </tt>
<a name="L983"></a><tt class="py-lineno"> 983</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<h1 class="epydoc">Class Hierarchy</h1>\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L984"></a><tt class="py-lineno"> 984</tt> <tt class="py-line"> </tt>
<a name="L985"></a><tt class="py-lineno"> 985</tt> <tt class="py-line"> <tt class="py-comment"># Build a set containing all classes that we should list.</tt> </tt>
<a name="L986"></a><tt class="py-lineno"> 986</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># This includes everything in class_list, plus any of those</tt> </tt>
<a name="L987"></a><tt class="py-lineno"> 987</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># class' bases, but not undocumented subclasses.</tt> </tt>
<a name="L988"></a><tt class="py-lineno"> 988</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">class_set</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">class_set</tt><tt class="py-op">.</tt><tt class="py-name">copy</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L989"></a><tt class="py-lineno"> 989</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">class_list</tt><tt class="py-op">:</tt> </tt>
<a name="L990"></a><tt class="py-lineno"> 990</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-332" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-332', 'bases', 'link-52');">bases</a></tt> <tt class="py-op">!=</tt> <tt id="link-333" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-333', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L991"></a><tt class="py-lineno"> 991</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">base</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-334" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-334', 'bases', 'link-52');">bases</a></tt><tt class="py-op">:</tt> </tt>
<a name="L992"></a><tt class="py-lineno"> 992</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">base</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">class_set</tt><tt class="py-op">:</tt> </tt>
<a name="L993"></a><tt class="py-lineno"> 993</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">base</tt><tt class="py-op">,</tt> <tt id="link-335" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-335', 'ClassDoc', 'link-56');">ClassDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L994"></a><tt class="py-lineno"> 994</tt> <tt class="py-line"> <tt class="py-name">class_set</tt><tt class="py-op">.</tt><tt class="py-name">update</tt><tt class="py-op">(</tt><tt class="py-name">base</tt><tt class="py-op">.</tt><tt id="link-336" class="py-name" targets="Method epydoc.apidoc.ClassDoc.mro()=epydoc.apidoc.ClassDoc-class.html#mro"><a title="epydoc.apidoc.ClassDoc.mro" class="py-name" href="#" onclick="return doclink('link-336', 'mro', 'link-336');">mro</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L995"></a><tt class="py-lineno"> 995</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L996"></a><tt class="py-lineno"> 996</tt> <tt class="py-line"> <tt class="py-comment"># [XX] need to deal with this -- how?</tt> </tt>
<a name="L997"></a><tt class="py-lineno"> 997</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">pass</tt> </tt>
<a name="L998"></a><tt class="py-lineno"> 998</tt> <tt class="py-line"> <tt class="py-comment">#class_set.add(base)</tt> </tt>
<a name="L999"></a><tt class="py-lineno"> 999</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L1000"></a><tt class="py-lineno">1000</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<ul class="nomargin-top">\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1001"></a><tt class="py-lineno">1001</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">doc</tt> <tt class="py-keyword">in</tt> <tt id="link-337" class="py-name"><a title="epydoc.compat.sorted" class="py-name" href="#" onclick="return doclink('link-337', 'sorted', 'link-49');">sorted</a></tt><tt class="py-op">(</tt><tt class="py-name">class_set</tt><tt class="py-op">,</tt> <tt id="link-338" class="py-name"><a title="epydoc.cli.key" class="py-name" href="#" onclick="return doclink('link-338', 'key', 'link-79');">key</a></tt><tt class="py-op">=</tt><tt class="py-keyword">lambda</tt> <tt class="py-name">c</tt><tt class="py-op">:</tt><tt class="py-name">c</tt><tt class="py-op">.</tt><tt id="link-339" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-339', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1002"></a><tt class="py-lineno">1002</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-340" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-340', 'bases', 'link-52');">bases</a></tt> <tt class="py-op">!=</tt> <tt id="link-341" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-341', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt> <tt class="py-keyword">and</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-342" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-342', 'bases', 'link-52');">bases</a></tt><tt class="py-op">)</tt><tt class="py-op">==</tt><tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L1003"></a><tt class="py-lineno">1003</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-343" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_class_tree_item()=epydoc.docwriter.html.HTMLWriter-class.html#write_class_tree_item"><a title="epydoc.docwriter.html.HTMLWriter.write_class_tree_item" class="py-name" href="#" onclick="return doclink('link-343', 'write_class_tree_item', 'link-343');">write_class_tree_item</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-name">class_set</tt><tt class="py-op">)</tt> </tt>
<a name="L1004"></a><tt class="py-lineno">1004</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'</ul>\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1005"></a><tt class="py-lineno">1005</tt> <tt class="py-line"> </tt>
<a name="L1006"></a><tt class="py-lineno">1006</tt> <tt class="py-line"> <tt class="py-comment"># Footer material</tt> </tt>
<a name="L1007"></a><tt class="py-lineno">1007</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-344" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_navbar" class="py-name" href="#" onclick="return doclink('link-344', 'write_navbar', 'link-223');">write_navbar</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">'trees'</tt><tt class="py-op">)</tt> </tt>
<a name="L1008"></a><tt class="py-lineno">1008</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-345" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_footer" class="py-name" href="#" onclick="return doclink('link-345', 'write_footer', 'link-244');">write_footer</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1009"></a><tt class="py-lineno">1009</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.write_treepage_header"></a><div id="HTMLWriter.write_treepage_header-def"><a name="L1010"></a><tt class="py-lineno">1010</tt> <a class="py-toggle" href="#" id="HTMLWriter.write_treepage_header-toggle" onclick="return toggle('HTMLWriter.write_treepage_header');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write_treepage_header">write_treepage_header</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">,</tt> <tt class="py-param">url</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write_treepage_header-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write_treepage_header-expanded"><a name="L1011"></a><tt class="py-lineno">1011</tt> <tt class="py-line"> <tt class="py-comment"># Header material.</tt> </tt>
<a name="L1012"></a><tt class="py-lineno">1012</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-346" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_header
epydoc.docwriter.latex.LatexWriter.write_header" class="py-name" href="#" onclick="return doclink('link-346', 'write_header', 'link-222');">write_header</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt id="link-347" class="py-name" targets="Method epydoc.docwriter.plaintext.PlaintextWriter.title()=epydoc.docwriter.plaintext.PlaintextWriter-class.html#title"><a title="epydoc.docwriter.plaintext.PlaintextWriter.title" class="py-name" href="#" onclick="return doclink('link-347', 'title', 'link-347');">title</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1013"></a><tt class="py-lineno">1013</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-348" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_navbar" class="py-name" href="#" onclick="return doclink('link-348', 'write_navbar', 'link-223');">write_navbar</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">'trees'</tt><tt class="py-op">)</tt> </tt>
<a name="L1014"></a><tt class="py-lineno">1014</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-349" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_breadcrumbs" class="py-name" href="#" onclick="return doclink('link-349', 'write_breadcrumbs', 'link-224');">write_breadcrumbs</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">'trees'</tt><tt class="py-op">,</tt> <tt id="link-350" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-350', 'url', 'link-72');">url</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1015"></a><tt class="py-lineno">1015</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">class_list</tt> <tt class="py-keyword">and</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">module_list</tt><tt class="py-op">:</tt> </tt>
<a name="L1016"></a><tt class="py-lineno">1016</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<center><b>\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1017"></a><tt class="py-lineno">1017</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' [ <a href="module-tree.html">Module Hierarchy</a>\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1018"></a><tt class="py-lineno">1018</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' | <a href="class-tree.html">Class Hierarchy</a> ]\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1019"></a><tt class="py-lineno">1019</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'</b></center><br />\n'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1020"></a><tt class="py-lineno">1020</tt> <tt class="py-line"> </tt>
<a name="L1021"></a><tt class="py-lineno">1021</tt> <tt class="py-line"> </tt>
<a name="L1022"></a><tt class="py-lineno">1022</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1023"></a><tt class="py-lineno">1023</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ 2.4. Index pages</tt> </tt>
<a name="L1024"></a><tt class="py-lineno">1024</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1025"></a><tt class="py-lineno">1025</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L1026"></a><tt class="py-lineno">1026</tt> <tt class="py-line"> <tt id="link-351" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.SPLIT_IDENT_INDEX_SIZE" class="py-name" href="#" onclick="return doclink('link-351', 'SPLIT_IDENT_INDEX_SIZE', 'link-65');">SPLIT_IDENT_INDEX_SIZE</a></tt> <tt class="py-op">=</tt> <tt class="py-number">3000</tt> </tt>
<a name="L1027"></a><tt class="py-lineno">1027</tt> <tt class="py-line"> <tt class="py-string">"""If the identifier index has more than this number of entries,</tt> </tt>
<a name="L1028"></a><tt class="py-lineno">1028</tt> <tt class="py-line"><tt class="py-string"> then it will be split into separate pages, one for each</tt> </tt>
<a name="L1029"></a><tt class="py-lineno">1029</tt> <tt class="py-line"><tt class="py-string"> alphabetical section."""</tt> </tt>
<a name="L1030"></a><tt class="py-lineno">1030</tt> <tt class="py-line"> </tt>
<a name="L1031"></a><tt class="py-lineno">1031</tt> <tt class="py-line"> <tt id="link-352" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.LETTERS" class="py-name" href="#" onclick="return doclink('link-352', 'LETTERS', 'link-70');">LETTERS</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'ABCDEFGHIJKLMNOPQRSTUVWXYZ_'</tt> </tt>
<a name="L1032"></a><tt class="py-lineno">1032</tt> <tt class="py-line"> <tt class="py-string">"""The alphabetical sections that are used for link index pages."""</tt> </tt>
<a name="L1033"></a><tt class="py-lineno">1033</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.write_link_index"></a><div id="HTMLWriter.write_link_index-def"><a name="L1034"></a><tt class="py-lineno">1034</tt> <a class="py-toggle" href="#" id="HTMLWriter.write_link_index-toggle" onclick="return toggle('HTMLWriter.write_link_index');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write_link_index">write_link_index</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">indices</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">,</tt> <tt class="py-param">url</tt><tt class="py-op">,</tt> <tt class="py-param">index_by_section</tt><tt class="py-op">,</tt> </tt>
<a name="L1035"></a><tt class="py-lineno">1035</tt> <tt class="py-line"> <tt class="py-param">sections</tt><tt class="py-op">=</tt><tt id="link-353" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.LETTERS" class="py-name" href="#" onclick="return doclink('link-353', 'LETTERS', 'link-70');">LETTERS</a></tt><tt class="py-op">,</tt> <tt class="py-param">section_url</tt><tt class="py-op">=</tt><tt class="py-string">'#%s'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write_link_index-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write_link_index-expanded"><a name="L1036"></a><tt class="py-lineno">1036</tt> <tt class="py-line"> </tt>
<a name="L1037"></a><tt class="py-lineno">1037</tt> <tt class="py-line"> <tt class="py-comment"># Header</tt> </tt>
<a name="L1038"></a><tt class="py-lineno">1038</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-354" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_indexpage_header()=epydoc.docwriter.html.HTMLWriter-class.html#write_indexpage_header"><a title="epydoc.docwriter.html.HTMLWriter.write_indexpage_header" class="py-name" href="#" onclick="return doclink('link-354', 'write_indexpage_header', 'link-354');">write_indexpage_header</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">indices</tt><tt class="py-op">,</tt> <tt id="link-355" class="py-name"><a title="epydoc.docwriter.plaintext.PlaintextWriter.title" class="py-name" href="#" onclick="return doclink('link-355', 'title', 'link-347');">title</a></tt><tt class="py-op">,</tt> <tt id="link-356" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-356', 'url', 'link-72');">url</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1039"></a><tt class="py-lineno">1039</tt> <tt class="py-line"> </tt>
<a name="L1040"></a><tt class="py-lineno">1040</tt> <tt class="py-line"> <tt class="py-comment"># Index title & links to alphabetical sections.</tt> </tt>
<a name="L1041"></a><tt class="py-lineno">1041</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<table border="0" width="100%">\n'</tt> </tt>
<a name="L1042"></a><tt class="py-lineno">1042</tt> <tt class="py-line"> <tt class="py-string">'<tr valign="bottom"><td>\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1043"></a><tt class="py-lineno">1043</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<h1 class="epydoc">%s</h1>\n</td><td>\n[\n'</tt> <tt class="py-op">%</tt> <tt id="link-357" class="py-name"><a title="epydoc.docwriter.plaintext.PlaintextWriter.title" class="py-name" href="#" onclick="return doclink('link-357', 'title', 'link-347');">title</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1044"></a><tt class="py-lineno">1044</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">sec</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-358" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.LETTERS" class="py-name" href="#" onclick="return doclink('link-358', 'LETTERS', 'link-70');">LETTERS</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1045"></a><tt class="py-lineno">1045</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">sec</tt> <tt class="py-keyword">in</tt> <tt class="py-name">index_by_section</tt><tt class="py-op">:</tt> </tt>
<a name="L1046"></a><tt class="py-lineno">1046</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' <a href="%s">%s</a>\n'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">section_url</tt> <tt class="py-op">%</tt> <tt class="py-name">sec</tt><tt class="py-op">,</tt> <tt class="py-name">sec</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1047"></a><tt class="py-lineno">1047</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1048"></a><tt class="py-lineno">1048</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' %s\n'</tt> <tt class="py-op">%</tt> <tt class="py-name">sec</tt><tt class="py-op">)</tt> </tt>
<a name="L1049"></a><tt class="py-lineno">1049</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">']\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1050"></a><tt class="py-lineno">1050</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'</td></table>\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1051"></a><tt class="py-lineno">1051</tt> <tt class="py-line"> </tt>
<a name="L1052"></a><tt class="py-lineno">1052</tt> <tt class="py-line"> <tt class="py-comment"># Alphabetical sections.</tt> </tt>
<a name="L1053"></a><tt class="py-lineno">1053</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">sections</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">s</tt> <tt class="py-keyword">for</tt> <tt class="py-name">s</tt> <tt class="py-keyword">in</tt> <tt class="py-name">sections</tt> <tt class="py-keyword">if</tt> <tt class="py-name">s</tt> <tt class="py-keyword">in</tt> <tt class="py-name">index_by_section</tt><tt class="py-op">]</tt> </tt>
<a name="L1054"></a><tt class="py-lineno">1054</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">sections</tt><tt class="py-op">:</tt> </tt>
<a name="L1055"></a><tt class="py-lineno">1055</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<table border="0" width="100%">\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1056"></a><tt class="py-lineno">1056</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-359" class="py-name" targets="Method epydoc.docwriter.latex.LatexWriter.section()=epydoc.docwriter.latex.LatexWriter-class.html#section,Method epydoc.docwriter.plaintext.PlaintextWriter.section()=epydoc.docwriter.plaintext.PlaintextWriter-class.html#section"><a title="epydoc.docwriter.latex.LatexWriter.section
epydoc.docwriter.plaintext.PlaintextWriter.section" class="py-name" href="#" onclick="return doclink('link-359', 'section', 'link-359');">section</a></tt> <tt class="py-keyword">in</tt> <tt id="link-360" class="py-name"><a title="epydoc.compat.sorted" class="py-name" href="#" onclick="return doclink('link-360', 'sorted', 'link-49');">sorted</a></tt><tt class="py-op">(</tt><tt class="py-name">sections</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1057"></a><tt class="py-lineno">1057</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<tr valign="top"><td valign="top" width="1%">'</tt><tt class="py-op">)</tt> </tt>
<a name="L1058"></a><tt class="py-lineno">1058</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<h2 class="epydoc"><a name="%s">%s</a></h2></td>\n'</tt> <tt class="py-op">%</tt> </tt>
<a name="L1059"></a><tt class="py-lineno">1059</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt id="link-361" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.section
epydoc.docwriter.plaintext.PlaintextWriter.section" class="py-name" href="#" onclick="return doclink('link-361', 'section', 'link-359');">section</a></tt><tt class="py-op">,</tt> <tt id="link-362" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.section
epydoc.docwriter.plaintext.PlaintextWriter.section" class="py-name" href="#" onclick="return doclink('link-362', 'section', 'link-359');">section</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1060"></a><tt class="py-lineno">1060</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<td valign="top">\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1061"></a><tt class="py-lineno">1061</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-363" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_index_section()=epydoc.docwriter.html.HTMLWriter-class.html#write_index_section"><a title="epydoc.docwriter.html.HTMLWriter.write_index_section" class="py-name" href="#" onclick="return doclink('link-363', 'write_index_section', 'link-363');">write_index_section</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">index_by_section</tt><tt class="py-op">[</tt><tt id="link-364" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.section
epydoc.docwriter.plaintext.PlaintextWriter.section" class="py-name" href="#" onclick="return doclink('link-364', 'section', 'link-359');">section</a></tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L1062"></a><tt class="py-lineno">1062</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'</td></tr>\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1063"></a><tt class="py-lineno">1063</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'</table>\n<br />'</tt><tt class="py-op">)</tt> </tt>
<a name="L1064"></a><tt class="py-lineno">1064</tt> <tt class="py-line"> </tt>
<a name="L1065"></a><tt class="py-lineno">1065</tt> <tt class="py-line"> <tt class="py-comment"># Footer material.</tt> </tt>
<a name="L1066"></a><tt class="py-lineno">1066</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<br />'</tt><tt class="py-op">)</tt> </tt>
<a name="L1067"></a><tt class="py-lineno">1067</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-365" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_navbar" class="py-name" href="#" onclick="return doclink('link-365', 'write_navbar', 'link-223');">write_navbar</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">'indices'</tt><tt class="py-op">)</tt> </tt>
<a name="L1068"></a><tt class="py-lineno">1068</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-366" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_footer" class="py-name" href="#" onclick="return doclink('link-366', 'write_footer', 'link-244');">write_footer</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1069"></a><tt class="py-lineno">1069</tt> <tt class="py-line"> </tt>
<a name="L1070"></a><tt class="py-lineno">1070</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.write_metadata_index"></a><div id="HTMLWriter.write_metadata_index-def"><a name="L1071"></a><tt class="py-lineno">1071</tt> <a class="py-toggle" href="#" id="HTMLWriter.write_metadata_index-toggle" onclick="return toggle('HTMLWriter.write_metadata_index');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write_metadata_index">write_metadata_index</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">indices</tt><tt class="py-op">,</tt> <tt class="py-param">field</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">,</tt> <tt class="py-param">typ</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write_metadata_index-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write_metadata_index-expanded"><a name="L1072"></a><tt class="py-lineno">1072</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1073"></a><tt class="py-lineno">1073</tt> <tt class="py-line"><tt class="py-docstring"> Write an HTML page containing a metadata index.</tt> </tt>
<a name="L1074"></a><tt class="py-lineno">1074</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1075"></a><tt class="py-lineno">1075</tt> <tt class="py-line"> <tt class="py-name">index</tt> <tt class="py-op">=</tt> <tt class="py-name">indices</tt><tt class="py-op">[</tt><tt class="py-name">field</tt><tt class="py-op">]</tt> </tt>
<a name="L1076"></a><tt class="py-lineno">1076</tt> <tt class="py-line"> </tt>
<a name="L1077"></a><tt class="py-lineno">1077</tt> <tt class="py-line"> <tt class="py-comment"># Header material.</tt> </tt>
<a name="L1078"></a><tt class="py-lineno">1078</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-367" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_indexpage_header" class="py-name" href="#" onclick="return doclink('link-367', 'write_indexpage_header', 'link-354');">write_indexpage_header</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">indices</tt><tt class="py-op">,</tt> <tt id="link-368" class="py-name"><a title="epydoc.docwriter.plaintext.PlaintextWriter.title" class="py-name" href="#" onclick="return doclink('link-368', 'title', 'link-347');">title</a></tt><tt class="py-op">,</tt> </tt>
<a name="L1079"></a><tt class="py-lineno">1079</tt> <tt class="py-line"> <tt class="py-string">'%s-index.html'</tt> <tt class="py-op">%</tt> <tt class="py-name">field</tt><tt class="py-op">)</tt> </tt>
<a name="L1080"></a><tt class="py-lineno">1080</tt> <tt class="py-line"> </tt>
<a name="L1081"></a><tt class="py-lineno">1081</tt> <tt class="py-line"> <tt class="py-comment"># Page title.</tt> </tt>
<a name="L1082"></a><tt class="py-lineno">1082</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<h1 class="epydoc"><a name="%s">%s</a></h1>\n<br />\n'</tt> <tt class="py-op">%</tt> </tt>
<a name="L1083"></a><tt class="py-lineno">1083</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">field</tt><tt class="py-op">,</tt> <tt id="link-369" class="py-name"><a title="epydoc.docwriter.plaintext.PlaintextWriter.title" class="py-name" href="#" onclick="return doclink('link-369', 'title', 'link-347');">title</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1084"></a><tt class="py-lineno">1084</tt> <tt class="py-line"> </tt>
<a name="L1085"></a><tt class="py-lineno">1085</tt> <tt class="py-line"> <tt class="py-comment"># Index (one section per arg)</tt> </tt>
<a name="L1086"></a><tt class="py-lineno">1086</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt id="link-370" class="py-name" targets="Method epydoc.markup.Field.arg()=epydoc.markup.Field-class.html#arg"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-370', 'arg', 'link-370');">arg</a></tt> <tt class="py-keyword">in</tt> <tt id="link-371" class="py-name"><a title="epydoc.compat.sorted" class="py-name" href="#" onclick="return doclink('link-371', 'sorted', 'link-49');">sorted</a></tt><tt class="py-op">(</tt><tt class="py-name">index</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1087"></a><tt class="py-lineno">1087</tt> <tt class="py-line"> <tt class="py-comment"># Write a section title.</tt> </tt>
<a name="L1088"></a><tt class="py-lineno">1088</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt id="link-372" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-372', 'arg', 'link-370');">arg</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L1089"></a><tt class="py-lineno">1089</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-number">1</tt> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-name">descrs</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">index</tt><tt class="py-op">[</tt><tt id="link-373" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-373', 'arg', 'link-370');">arg</a></tt><tt class="py-op">]</tt> <tt class="py-keyword">if</tt> </tt>
<a name="L1090"></a><tt class="py-lineno">1090</tt> <tt class="py-line"> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-374" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter._doc_or_ancestor_is_private()=epydoc.docwriter.html.HTMLWriter-class.html#_doc_or_ancestor_is_private"><a title="epydoc.docwriter.html.HTMLWriter._doc_or_ancestor_is_private" class="py-name" href="#" onclick="return doclink('link-374', '_doc_or_ancestor_is_private', 'link-374');">_doc_or_ancestor_is_private</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L1091"></a><tt class="py-lineno">1091</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<div class="private">'</tt><tt class="py-op">)</tt> </tt>
<a name="L1092"></a><tt class="py-lineno">1092</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1093"></a><tt class="py-lineno">1093</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<div>'</tt><tt class="py-op">)</tt> </tt>
<a name="L1094"></a><tt class="py-lineno">1094</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-375" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_table_header()=epydoc.docwriter.html.HTMLWriter-class.html#write_table_header"><a title="epydoc.docwriter.html.HTMLWriter.write_table_header" class="py-name" href="#" onclick="return doclink('link-375', 'write_table_header', 'link-375');">write_table_header</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">'metadata-index'</tt><tt class="py-op">,</tt> <tt id="link-376" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-376', 'arg', 'link-370');">arg</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1095"></a><tt class="py-lineno">1095</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'</table>'</tt><tt class="py-op">)</tt> </tt>
<a name="L1096"></a><tt class="py-lineno">1096</tt> <tt class="py-line"> <tt class="py-comment"># List every descr for this arg.</tt> </tt>
<a name="L1097"></a><tt class="py-lineno">1097</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-name">descrs</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">index</tt><tt class="py-op">[</tt><tt id="link-377" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-377', 'arg', 'link-370');">arg</a></tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L1098"></a><tt class="py-lineno">1098</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-378" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._doc_or_ancestor_is_private" class="py-name" href="#" onclick="return doclink('link-378', '_doc_or_ancestor_is_private', 'link-374');">_doc_or_ancestor_is_private</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1099"></a><tt class="py-lineno">1099</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<div class="private">\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1100"></a><tt class="py-lineno">1100</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1101"></a><tt class="py-lineno">1101</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<div>\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1102"></a><tt class="py-lineno">1102</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<table width="100%" class="metadata-index" '</tt> </tt>
<a name="L1103"></a><tt class="py-lineno">1103</tt> <tt class="py-line"> <tt class="py-string">'bgcolor="#e0e0e0"><tr><td class="metadata-index">'</tt><tt class="py-op">)</tt> </tt>
<a name="L1104"></a><tt class="py-lineno">1104</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<b>%s in %s</b>'</tt> <tt class="py-op">%</tt> </tt>
<a name="L1105"></a><tt class="py-lineno">1105</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">typ</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-379" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.href" class="py-name" href="#" onclick="return doclink('link-379', 'href', 'link-254');">href</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-380" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-380', 'label', 'link-118');">label</a></tt><tt class="py-op">=</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-381" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-381', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1106"></a><tt class="py-lineno">1106</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' <ul class="nomargin">\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1107"></a><tt class="py-lineno">1107</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-382" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-382', 'descr', 'link-228');">descr</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">descrs</tt><tt class="py-op">:</tt> </tt>
<a name="L1108"></a><tt class="py-lineno">1108</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' <li>%s</li>\n'</tt> <tt class="py-op">%</tt> </tt>
<a name="L1109"></a><tt class="py-lineno">1109</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-383" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.docstring_to_html()=epydoc.docwriter.html.HTMLWriter-class.html#docstring_to_html"><a title="epydoc.docwriter.html.HTMLWriter.docstring_to_html" class="py-name" href="#" onclick="return doclink('link-383', 'docstring_to_html', 'link-383');">docstring_to_html</a></tt><tt class="py-op">(</tt><tt id="link-384" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-384', 'descr', 'link-228');">descr</a></tt><tt class="py-op">,</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt><tt class="py-number">4</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1110"></a><tt class="py-lineno">1110</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' </ul>\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1111"></a><tt class="py-lineno">1111</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'</table></div>\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1112"></a><tt class="py-lineno">1112</tt> <tt class="py-line"> </tt>
<a name="L1113"></a><tt class="py-lineno">1113</tt> <tt class="py-line"> <tt class="py-comment"># Footer material.</tt> </tt>
<a name="L1114"></a><tt class="py-lineno">1114</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<br />'</tt><tt class="py-op">)</tt> </tt>
<a name="L1115"></a><tt class="py-lineno">1115</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-385" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_navbar" class="py-name" href="#" onclick="return doclink('link-385', 'write_navbar', 'link-223');">write_navbar</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">'indices'</tt><tt class="py-op">)</tt> </tt>
<a name="L1116"></a><tt class="py-lineno">1116</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-386" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_footer" class="py-name" href="#" onclick="return doclink('link-386', 'write_footer', 'link-244');">write_footer</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1117"></a><tt class="py-lineno">1117</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.write_indexpage_header"></a><div id="HTMLWriter.write_indexpage_header-def"><a name="L1118"></a><tt class="py-lineno">1118</tt> <a class="py-toggle" href="#" id="HTMLWriter.write_indexpage_header-toggle" onclick="return toggle('HTMLWriter.write_indexpage_header');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write_indexpage_header">write_indexpage_header</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">indices</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">,</tt> <tt class="py-param">url</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write_indexpage_header-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write_indexpage_header-expanded"><a name="L1119"></a><tt class="py-lineno">1119</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1120"></a><tt class="py-lineno">1120</tt> <tt class="py-line"><tt class="py-docstring"> A helper for the index page generation functions, which</tt> </tt>
<a name="L1121"></a><tt class="py-lineno">1121</tt> <tt class="py-line"><tt class="py-docstring"> generates a header that can be used to navigate between the</tt> </tt>
<a name="L1122"></a><tt class="py-lineno">1122</tt> <tt class="py-line"><tt class="py-docstring"> different indices.</tt> </tt>
<a name="L1123"></a><tt class="py-lineno">1123</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1124"></a><tt class="py-lineno">1124</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-387" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_header
epydoc.docwriter.latex.LatexWriter.write_header" class="py-name" href="#" onclick="return doclink('link-387', 'write_header', 'link-222');">write_header</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt id="link-388" class="py-name"><a title="epydoc.docwriter.plaintext.PlaintextWriter.title" class="py-name" href="#" onclick="return doclink('link-388', 'title', 'link-347');">title</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1125"></a><tt class="py-lineno">1125</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-389" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_navbar" class="py-name" href="#" onclick="return doclink('link-389', 'write_navbar', 'link-223');">write_navbar</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">'indices'</tt><tt class="py-op">)</tt> </tt>
<a name="L1126"></a><tt class="py-lineno">1126</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-390" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_breadcrumbs" class="py-name" href="#" onclick="return doclink('link-390', 'write_breadcrumbs', 'link-224');">write_breadcrumbs</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">'indices'</tt><tt class="py-op">,</tt> <tt id="link-391" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-391', 'url', 'link-72');">url</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1127"></a><tt class="py-lineno">1127</tt> <tt class="py-line"> </tt>
<a name="L1128"></a><tt class="py-lineno">1128</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">indices</tt><tt class="py-op">[</tt><tt class="py-string">'term'</tt><tt class="py-op">]</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L1129"></a><tt class="py-lineno">1129</tt> <tt class="py-line"> <tt class="py-op">[</tt><tt class="py-number">1</tt> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt id="link-392" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-392', 'name', 'link-117');">name</a></tt><tt class="py-op">,</tt><tt class="py-name">l</tt><tt class="py-op">,</tt><tt class="py-name">l2</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-393" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.METADATA_INDICES" class="py-name" href="#" onclick="return doclink('link-393', 'METADATA_INDICES', 'link-69');">METADATA_INDICES</a></tt> <tt class="py-keyword">if</tt> <tt class="py-name">indices</tt><tt class="py-op">[</tt><tt id="link-394" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-394', 'name', 'link-117');">name</a></tt><tt class="py-op">]</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1130"></a><tt class="py-lineno">1130</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<center><b>[\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1131"></a><tt class="py-lineno">1131</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' <a href="identifier-index.html">Identifiers</a>\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1132"></a><tt class="py-lineno">1132</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">indices</tt><tt class="py-op">[</tt><tt class="py-string">'term'</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L1133"></a><tt class="py-lineno">1133</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'| <a href="term-index.html">Term Definitions</a>\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1134"></a><tt class="py-lineno">1134</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt id="link-395" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-395', 'name', 'link-117');">name</a></tt><tt class="py-op">,</tt> <tt id="link-396" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-396', 'label', 'link-118');">label</a></tt><tt class="py-op">,</tt> <tt class="py-name">label2</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-397" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.METADATA_INDICES" class="py-name" href="#" onclick="return doclink('link-397', 'METADATA_INDICES', 'link-69');">METADATA_INDICES</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1135"></a><tt class="py-lineno">1135</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">indices</tt><tt class="py-op">[</tt><tt id="link-398" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-398', 'name', 'link-117');">name</a></tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L1136"></a><tt class="py-lineno">1136</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'| <a href="%s-index.html">%s</a>\n'</tt> <tt class="py-op">%</tt> </tt>
<a name="L1137"></a><tt class="py-lineno">1137</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt id="link-399" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-399', 'name', 'link-117');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">label2</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1138"></a><tt class="py-lineno">1138</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">']</b></center><br />\n'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1139"></a><tt class="py-lineno">1139</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.write_index_section"></a><div id="HTMLWriter.write_index_section-def"><a name="L1140"></a><tt class="py-lineno">1140</tt> <a class="py-toggle" href="#" id="HTMLWriter.write_index_section-toggle" onclick="return toggle('HTMLWriter.write_index_section');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write_index_section">write_index_section</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">items</tt><tt class="py-op">,</tt> <tt class="py-param">add_blankline</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write_index_section-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write_index_section-expanded"><a name="L1141"></a><tt class="py-lineno">1141</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<table class="link-index" width="100%" border="1">\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1142"></a><tt class="py-lineno">1142</tt> <tt class="py-line"> <tt class="py-name">num_rows</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">items</tt><tt class="py-op">)</tt><tt class="py-op">+</tt><tt class="py-number">2</tt><tt class="py-op">)</tt><tt class="py-op">/</tt><tt class="py-number">3</tt> </tt>
<a name="L1143"></a><tt class="py-lineno">1143</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">row</tt> <tt class="py-keyword">in</tt> <tt class="py-name">range</tt><tt class="py-op">(</tt><tt class="py-name">num_rows</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1144"></a><tt class="py-lineno">1144</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<tr>\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1145"></a><tt class="py-lineno">1145</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">col</tt> <tt class="py-keyword">in</tt> <tt class="py-name">range</tt><tt class="py-op">(</tt><tt class="py-number">3</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1146"></a><tt class="py-lineno">1146</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<td width="33%" class="link-index">'</tt><tt class="py-op">)</tt> </tt>
<a name="L1147"></a><tt class="py-lineno">1147</tt> <tt class="py-line"> <tt class="py-name">i</tt> <tt class="py-op">=</tt> <tt class="py-name">col</tt><tt class="py-op">*</tt><tt class="py-name">num_rows</tt><tt class="py-op">+</tt><tt class="py-name">row</tt> </tt>
<a name="L1148"></a><tt class="py-lineno">1148</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">i</tt> <tt class="py-op"><</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">items</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1149"></a><tt class="py-lineno">1149</tt> <tt class="py-line"> <tt id="link-400" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-400', 'name', 'link-117');">name</a></tt><tt class="py-op">,</tt> <tt id="link-401" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-401', 'url', 'link-72');">url</a></tt><tt class="py-op">,</tt> <tt id="link-402" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-402', 'container', 'link-63');">container</a></tt> <tt class="py-op">=</tt> <tt class="py-name">items</tt><tt class="py-op">[</tt><tt class="py-name">col</tt><tt class="py-op">*</tt><tt class="py-name">num_rows</tt><tt class="py-op">+</tt><tt class="py-name">row</tt><tt class="py-op">]</tt> </tt>
<a name="L1150"></a><tt class="py-lineno">1150</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<a href="%s">%s</a>'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt id="link-403" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-403', 'url', 'link-72');">url</a></tt><tt class="py-op">,</tt> <tt id="link-404" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-404', 'name', 'link-117');">name</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1151"></a><tt class="py-lineno">1151</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-405" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-405', 'container', 'link-63');">container</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L1152"></a><tt class="py-lineno">1152</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<br />\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1153"></a><tt class="py-lineno">1153</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt id="link-406" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-406', 'container', 'link-63');">container</a></tt><tt class="py-op">,</tt> <tt id="link-407" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-407', 'ModuleDoc', 'link-55');">ModuleDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1154"></a><tt class="py-lineno">1154</tt> <tt class="py-line"> <tt id="link-408" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-408', 'label', 'link-118');">label</a></tt> <tt class="py-op">=</tt> <tt id="link-409" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-409', 'container', 'link-63');">container</a></tt><tt class="py-op">.</tt><tt id="link-410" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-410', 'canonical_name', 'link-82');">canonical_name</a></tt> </tt>
<a name="L1155"></a><tt class="py-lineno">1155</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1156"></a><tt class="py-lineno">1156</tt> <tt class="py-line"> <tt id="link-411" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-411', 'label', 'link-118');">label</a></tt> <tt class="py-op">=</tt> <tt id="link-412" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-412', 'container', 'link-63');">container</a></tt><tt class="py-op">.</tt><tt id="link-413" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-413', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt>
<a name="L1157"></a><tt class="py-lineno">1157</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<span class="index-where">(in&nbsp;%s)'</tt> </tt>
<a name="L1158"></a><tt class="py-lineno">1158</tt> <tt class="py-line"> <tt class="py-string">'</span>'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-414" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.href" class="py-name" href="#" onclick="return doclink('link-414', 'href', 'link-254');">href</a></tt><tt class="py-op">(</tt><tt id="link-415" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-415', 'container', 'link-63');">container</a></tt><tt class="py-op">,</tt> <tt id="link-416" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-416', 'label', 'link-118');">label</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1159"></a><tt class="py-lineno">1159</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1160"></a><tt class="py-lineno">1160</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'&nbsp;'</tt><tt class="py-op">)</tt> </tt>
<a name="L1161"></a><tt class="py-lineno">1161</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'</td>\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1162"></a><tt class="py-lineno">1162</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'</tr>\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1163"></a><tt class="py-lineno">1163</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">add_blankline</tt> <tt class="py-keyword">and</tt> <tt class="py-name">num_rows</tt> <tt class="py-op">==</tt> <tt class="py-number">1</tt><tt class="py-op">:</tt> </tt>
<a name="L1164"></a><tt class="py-lineno">1164</tt> <tt class="py-line"> <tt class="py-name">blank_cell</tt> <tt class="py-op">=</tt> <tt class="py-string">'<td class="link-index">&nbsp;</td>'</tt> </tt>
<a name="L1165"></a><tt class="py-lineno">1165</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<tr>'</tt><tt class="py-op">+</tt><tt class="py-number">3</tt><tt class="py-op">*</tt><tt class="py-name">blank_cell</tt><tt class="py-op">+</tt><tt class="py-string">'</tr>\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1166"></a><tt class="py-lineno">1166</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'</table>\n'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1167"></a><tt class="py-lineno">1167</tt> <tt class="py-line"> </tt>
<a name="L1168"></a><tt class="py-lineno">1168</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1169"></a><tt class="py-lineno">1169</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ 2.5. Help Page</tt> </tt>
<a name="L1170"></a><tt class="py-lineno">1170</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1171"></a><tt class="py-lineno">1171</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="HTMLWriter.write_help"></a><div id="HTMLWriter.write_help-def"><a name="L1172"></a><tt class="py-lineno">1172</tt> <a class="py-toggle" href="#" id="HTMLWriter.write_help-toggle" onclick="return toggle('HTMLWriter.write_help');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write_help">write_help</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write_help-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write_help-expanded"><a name="L1173"></a><tt class="py-lineno">1173</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1174"></a><tt class="py-lineno">1174</tt> <tt class="py-line"><tt class="py-docstring"> Write an HTML help file to the given stream. If</tt> </tt>
<a name="L1175"></a><tt class="py-lineno">1175</tt> <tt class="py-line"><tt class="py-docstring"> C{self._helpfile} contains a help file, then use it;</tt> </tt>
<a name="L1176"></a><tt class="py-lineno">1176</tt> <tt class="py-line"><tt class="py-docstring"> otherwise, use the default helpfile from</tt> </tt>
<a name="L1177"></a><tt class="py-lineno">1177</tt> <tt class="py-line"><tt class="py-docstring"> L{epydoc.docwriter.html_help}.</tt> </tt>
<a name="L1178"></a><tt class="py-lineno">1178</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1179"></a><tt class="py-lineno">1179</tt> <tt class="py-line"> <tt class="py-comment"># todo: optionally parse .rst etc help files?</tt> </tt>
<a name="L1180"></a><tt class="py-lineno">1180</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L1181"></a><tt class="py-lineno">1181</tt> <tt class="py-line"> <tt class="py-comment"># Get the contents of the help file.</tt> </tt>
<a name="L1182"></a><tt class="py-lineno">1182</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_helpfile</tt><tt class="py-op">:</tt> </tt>
<a name="L1183"></a><tt class="py-lineno">1183</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-417" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-417', 'path', 'link-211');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">exists</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_helpfile</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1184"></a><tt class="py-lineno">1184</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> <tt class="py-name">help</tt> <tt class="py-op">=</tt> <tt id="link-418" class="py-name"><a title="epydoc.gui.EpydocGUI.open" class="py-name" href="#" onclick="return doclink('link-418', 'open', 'link-214');">open</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_helpfile</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-419" class="py-name" targets="Method epydoc.docintrospecter._DevNull.read()=epydoc.docintrospecter._DevNull-class.html#read,Method epydoc.docwriter.xlink.ApiLinkReader.read()=epydoc.docwriter.xlink.ApiLinkReader-class.html#read,Method epydoc.gui.GUILogger.read()=epydoc.gui.GUILogger-class.html#read"><a title="epydoc.docintrospecter._DevNull.read
epydoc.docwriter.xlink.ApiLinkReader.read
epydoc.gui.GUILogger.read" class="py-name" href="#" onclick="return doclink('link-419', 'read', 'link-419');">read</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1185"></a><tt class="py-lineno">1185</tt> <tt class="py-line"> <tt class="py-keyword">except</tt><tt class="py-op">:</tt> <tt class="py-keyword">raise</tt> <tt class="py-name">IOError</tt><tt class="py-op">(</tt><tt class="py-string">"Can't open help file: %r"</tt> <tt class="py-op">%</tt> </tt>
<a name="L1186"></a><tt class="py-lineno">1186</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_helpfile</tt><tt class="py-op">)</tt> </tt>
<a name="L1187"></a><tt class="py-lineno">1187</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1188"></a><tt class="py-lineno">1188</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">IOError</tt><tt class="py-op">(</tt><tt class="py-string">"Can't find help file: %r"</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_helpfile</tt><tt class="py-op">)</tt> </tt>
<a name="L1189"></a><tt class="py-lineno">1189</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1190"></a><tt class="py-lineno">1190</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_prj_name</tt><tt class="py-op">:</tt> <tt class="py-name">thisprj</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_prj_name</tt> </tt>
<a name="L1191"></a><tt class="py-lineno">1191</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-name">thisprj</tt> <tt class="py-op">=</tt> <tt class="py-string">'this project'</tt> </tt>
<a name="L1192"></a><tt class="py-lineno">1192</tt> <tt class="py-line"> <tt class="py-name">help</tt> <tt class="py-op">=</tt> <tt id="link-420" class="py-name"><a title="epydoc.docwriter.html_help.HTML_HELP" class="py-name" href="#" onclick="return doclink('link-420', 'HTML_HELP', 'link-24');">HTML_HELP</a></tt> <tt class="py-op">%</tt> <tt class="py-op">{</tt><tt class="py-string">'this_project'</tt><tt class="py-op">:</tt><tt class="py-name">thisprj</tt><tt class="py-op">}</tt> </tt>
<a name="L1193"></a><tt class="py-lineno">1193</tt> <tt class="py-line"> </tt>
<a name="L1194"></a><tt class="py-lineno">1194</tt> <tt class="py-line"> <tt class="py-comment"># Insert the help contents into a webpage.</tt> </tt>
<a name="L1195"></a><tt class="py-lineno">1195</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-421" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_header
epydoc.docwriter.latex.LatexWriter.write_header" class="py-name" href="#" onclick="return doclink('link-421', 'write_header', 'link-222');">write_header</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">'Help'</tt><tt class="py-op">)</tt> </tt>
<a name="L1196"></a><tt class="py-lineno">1196</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-422" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_navbar" class="py-name" href="#" onclick="return doclink('link-422', 'write_navbar', 'link-223');">write_navbar</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">'help'</tt><tt class="py-op">)</tt> </tt>
<a name="L1197"></a><tt class="py-lineno">1197</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-423" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_breadcrumbs" class="py-name" href="#" onclick="return doclink('link-423', 'write_breadcrumbs', 'link-224');">write_breadcrumbs</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">'help'</tt><tt class="py-op">,</tt> <tt class="py-string">'help.html'</tt><tt class="py-op">)</tt> </tt>
<a name="L1198"></a><tt class="py-lineno">1198</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-name">help</tt><tt class="py-op">)</tt> </tt>
<a name="L1199"></a><tt class="py-lineno">1199</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-424" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_navbar" class="py-name" href="#" onclick="return doclink('link-424', 'write_navbar', 'link-223');">write_navbar</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">'help'</tt><tt class="py-op">)</tt> </tt>
<a name="L1200"></a><tt class="py-lineno">1200</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-425" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_footer" class="py-name" href="#" onclick="return doclink('link-425', 'write_footer', 'link-244');">write_footer</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1201"></a><tt class="py-lineno">1201</tt> <tt class="py-line"> </tt>
<a name="L1202"></a><tt class="py-lineno">1202</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1203"></a><tt class="py-lineno">1203</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ 2.6. Frames-based Table of Contents</tt> </tt>
<a name="L1204"></a><tt class="py-lineno">1204</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1205"></a><tt class="py-lineno">1205</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L1206"></a><tt class="py-lineno">1206</tt> <tt class="py-line"> <tt id="link-426" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_frames_index" class="py-name" href="#" onclick="return doclink('link-426', 'write_frames_index', 'link-157');">write_frames_index</a></tt> <tt class="py-op">=</tt> <tt id="link-427" class="py-name" targets="Function epydoc.docwriter.html.compile_template()=epydoc.docwriter.html-module.html#compile_template"><a title="epydoc.docwriter.html.compile_template" class="py-name" href="#" onclick="return doclink('link-427', 'compile_template', 'link-427');">compile_template</a></tt><tt class="py-op">(</tt> </tt>
<a name="L1207"></a><tt class="py-lineno">1207</tt> <tt class="py-line"> <tt class="py-string">"""</tt> </tt>
<a name="L1208"></a><tt class="py-lineno">1208</tt> <tt class="py-line"><tt class="py-string"> write_frames_index(self, out)</tt> </tt>
<a name="L1209"></a><tt class="py-lineno">1209</tt> <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L1210"></a><tt class="py-lineno">1210</tt> <tt class="py-line"><tt class="py-string"> Write the frames index file for the frames-based table of</tt> </tt>
<a name="L1211"></a><tt class="py-lineno">1211</tt> <tt class="py-line"><tt class="py-string"> contents to the given streams.</tt> </tt>
<a name="L1212"></a><tt class="py-lineno">1212</tt> <tt class="py-line"><tt class="py-string"> """</tt><tt class="py-op">,</tt> </tt>
<a name="L1213"></a><tt class="py-lineno">1213</tt> <tt class="py-line"> <tt class="py-comment"># /------------------------- Template -------------------------\</tt> </tt>
<a name="L1214"></a><tt class="py-lineno">1214</tt> <tt class="py-line"> <tt class="py-string">'''</tt> </tt>
<a name="L1215"></a><tt class="py-lineno">1215</tt> <tt class="py-line"><tt class="py-string"> <?xml version="1.0" encoding="iso-8859-1"?></tt> </tt>
<a name="L1216"></a><tt class="py-lineno">1216</tt> <tt class="py-line"><tt class="py-string"> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"</tt> </tt>
<a name="L1217"></a><tt class="py-lineno">1217</tt> <tt class="py-line"><tt class="py-string"> "DTD/xhtml1-frameset.dtd"></tt> </tt>
<a name="L1218"></a><tt class="py-lineno">1218</tt> <tt class="py-line"><tt class="py-string"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"></tt> </tt>
<a name="L1219"></a><tt class="py-lineno">1219</tt> <tt class="py-line"><tt class="py-string"> <head></tt> </tt>
<a name="L1220"></a><tt class="py-lineno">1220</tt> <tt class="py-line"><tt class="py-string"> <title> $self._prj_name or "API Documentation"$ </title></tt> </tt>
<a name="L1221"></a><tt class="py-lineno">1221</tt> <tt class="py-line"><tt class="py-string"> </head></tt> </tt>
<a name="L1222"></a><tt class="py-lineno">1222</tt> <tt class="py-line"><tt class="py-string"> <frameset cols="20%,80%"></tt> </tt>
<a name="L1223"></a><tt class="py-lineno">1223</tt> <tt class="py-line"><tt class="py-string"> <frameset rows="30%,70%"></tt> </tt>
<a name="L1224"></a><tt class="py-lineno">1224</tt> <tt class="py-line"><tt class="py-string"> <frame src="toc.html" name="moduleListFrame"</tt> </tt>
<a name="L1225"></a><tt class="py-lineno">1225</tt> <tt class="py-line"><tt class="py-string"> id="moduleListFrame" /></tt> </tt>
<a name="L1226"></a><tt class="py-lineno">1226</tt> <tt class="py-line"><tt class="py-string"> <frame src="toc-everything.html" name="moduleFrame"</tt> </tt>
<a name="L1227"></a><tt class="py-lineno">1227</tt> <tt class="py-line"><tt class="py-string"> id="moduleFrame" /></tt> </tt>
<a name="L1228"></a><tt class="py-lineno">1228</tt> <tt class="py-line"><tt class="py-string"> </frameset></tt> </tt>
<a name="L1229"></a><tt class="py-lineno">1229</tt> <tt class="py-line"><tt class="py-string"> <frame src="$self._top_page_url$" name="mainFrame" id="mainFrame" /></tt> </tt>
<a name="L1230"></a><tt class="py-lineno">1230</tt> <tt class="py-line"><tt class="py-string"> </frameset></tt> </tt>
<a name="L1231"></a><tt class="py-lineno">1231</tt> <tt class="py-line"><tt class="py-string"> </html></tt> </tt>
<a name="L1232"></a><tt class="py-lineno">1232</tt> <tt class="py-line"><tt class="py-string"> '''</tt><tt class="py-op">)</tt> </tt>
<a name="L1233"></a><tt class="py-lineno">1233</tt> <tt class="py-line"> <tt class="py-comment"># \------------------------------------------------------------/</tt> </tt>
<a name="L1234"></a><tt class="py-lineno">1234</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L1235"></a><tt class="py-lineno">1235</tt> <tt class="py-line"> <tt id="link-428" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_toc" class="py-name" href="#" onclick="return doclink('link-428', 'write_toc', 'link-159');">write_toc</a></tt> <tt class="py-op">=</tt> <tt id="link-429" class="py-name"><a title="epydoc.docwriter.html.compile_template" class="py-name" href="#" onclick="return doclink('link-429', 'compile_template', 'link-427');">compile_template</a></tt><tt class="py-op">(</tt> </tt>
<a name="L1236"></a><tt class="py-lineno">1236</tt> <tt class="py-line"> <tt class="py-string">"""</tt> </tt>
<a name="L1237"></a><tt class="py-lineno">1237</tt> <tt class="py-line"><tt class="py-string"> write_toc(self, out)</tt> </tt>
<a name="L1238"></a><tt class="py-lineno">1238</tt> <tt class="py-line"><tt class="py-string"> """</tt><tt class="py-op">,</tt> </tt>
<a name="L1239"></a><tt class="py-lineno">1239</tt> <tt class="py-line"> <tt class="py-comment"># /------------------------- Template -------------------------\</tt> </tt>
<a name="L1240"></a><tt class="py-lineno">1240</tt> <tt class="py-line"> <tt class="py-string">'''</tt> </tt>
<a name="L1241"></a><tt class="py-lineno">1241</tt> <tt class="py-line"><tt class="py-string"> >>> self.write_header(out, "Table of Contents")</tt> </tt>
<a name="L1242"></a><tt class="py-lineno">1242</tt> <tt class="py-line"><tt class="py-string"> <h1 class="toc">Table&nbsp;of&nbsp;Contents</h1></tt> </tt>
<a name="L1243"></a><tt class="py-lineno">1243</tt> <tt class="py-line"><tt class="py-string"> <hr /></tt> </tt>
<a name="L1244"></a><tt class="py-lineno">1244</tt> <tt class="py-line"><tt class="py-string"> <a target="moduleFrame" href="toc-everything.html">Everything</a></tt> </tt>
<a name="L1245"></a><tt class="py-lineno">1245</tt> <tt class="py-line"><tt class="py-string"> <br /></tt> </tt>
<a name="L1246"></a><tt class="py-lineno">1246</tt> <tt class="py-line"><tt class="py-string"> >>> self.write_toc_section(out, "Modules", self.module_list)</tt> </tt>
<a name="L1247"></a><tt class="py-lineno">1247</tt> <tt class="py-line"><tt class="py-string"> <hr /></tt> </tt>
<a name="L1248"></a><tt class="py-lineno">1248</tt> <tt class="py-line"><tt class="py-string"> >>> if self._show_private:</tt> </tt>
<a name="L1249"></a><tt class="py-lineno">1249</tt> <tt class="py-line"><tt class="py-string"> $self.PRIVATE_LINK$</tt> </tt>
<a name="L1250"></a><tt class="py-lineno">1250</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L1251"></a><tt class="py-lineno">1251</tt> <tt class="py-line"><tt class="py-string"> >>> self.write_footer(out, short=True)</tt> </tt>
<a name="L1252"></a><tt class="py-lineno">1252</tt> <tt class="py-line"><tt class="py-string"> '''</tt><tt class="py-op">)</tt> </tt>
<a name="L1253"></a><tt class="py-lineno">1253</tt> <tt class="py-line"> <tt class="py-comment"># \------------------------------------------------------------/</tt> </tt>
<a name="L1254"></a><tt class="py-lineno">1254</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="HTMLWriter.write_toc_section"></a><div id="HTMLWriter.write_toc_section-def"><a name="L1255"></a><tt class="py-lineno">1255</tt> <a class="py-toggle" href="#" id="HTMLWriter.write_toc_section-toggle" onclick="return toggle('HTMLWriter.write_toc_section');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write_toc_section">write_toc_section</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">docs</tt><tt class="py-op">,</tt> <tt class="py-param">fullname</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write_toc_section-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write_toc_section-expanded"><a name="L1256"></a><tt class="py-lineno">1256</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">docs</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> </tt>
<a name="L1257"></a><tt class="py-lineno">1257</tt> <tt class="py-line"> </tt>
<a name="L1258"></a><tt class="py-lineno">1258</tt> <tt class="py-line"> <tt class="py-comment"># Assign names to each item, and sort by name.</tt> </tt>
<a name="L1259"></a><tt class="py-lineno">1259</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">fullname</tt><tt class="py-op">:</tt> </tt>
<a name="L1260"></a><tt class="py-lineno">1260</tt> <tt class="py-line"> <tt class="py-name">docs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">d</tt><tt class="py-op">.</tt><tt id="link-430" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-430', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">d</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">d</tt> <tt class="py-keyword">in</tt> <tt class="py-name">docs</tt><tt class="py-op">]</tt> </tt>
<a name="L1261"></a><tt class="py-lineno">1261</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1262"></a><tt class="py-lineno">1262</tt> <tt class="py-line"> <tt class="py-name">docs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">d</tt><tt class="py-op">.</tt><tt id="link-431" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-431', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">d</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">d</tt> <tt class="py-keyword">in</tt> <tt class="py-name">docs</tt><tt class="py-op">]</tt> </tt>
<a name="L1263"></a><tt class="py-lineno">1263</tt> <tt class="py-line"> <tt class="py-name">docs</tt><tt class="py-op">.</tt><tt class="py-name">sort</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1264"></a><tt class="py-lineno">1264</tt> <tt class="py-line"> </tt>
<a name="L1265"></a><tt class="py-lineno">1265</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' <h2 class="toc">%s</h2>\n'</tt> <tt class="py-op">%</tt> <tt id="link-432" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-432', 'name', 'link-117');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1266"></a><tt class="py-lineno">1266</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-433" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-433', 'label', 'link-118');">label</a></tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">docs</tt><tt class="py-op">:</tt> </tt>
<a name="L1267"></a><tt class="py-lineno">1267</tt> <tt class="py-line"> <tt class="py-name">doc_url</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-434" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-434', 'url', 'link-72');">url</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L1268"></a><tt class="py-lineno">1268</tt> <tt class="py-line"> <tt class="py-name">toc_url</tt> <tt class="py-op">=</tt> <tt class="py-string">'toc-%s'</tt> <tt class="py-op">%</tt> <tt class="py-name">doc_url</tt> </tt>
<a name="L1269"></a><tt class="py-lineno">1269</tt> <tt class="py-line"> <tt class="py-name">is_private</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-435" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._doc_or_ancestor_is_private" class="py-name" href="#" onclick="return doclink('link-435', '_doc_or_ancestor_is_private', 'link-374');">_doc_or_ancestor_is_private</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L1270"></a><tt class="py-lineno">1270</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">is_private</tt><tt class="py-op">:</tt> </tt>
<a name="L1271"></a><tt class="py-lineno">1271</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_show_private</tt><tt class="py-op">:</tt> <tt class="py-keyword">continue</tt> </tt>
<a name="L1272"></a><tt class="py-lineno">1272</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' <div class="private">\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1273"></a><tt class="py-lineno">1273</tt> <tt class="py-line"> </tt>
<a name="L1274"></a><tt class="py-lineno">1274</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-436" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-436', 'ModuleDoc', 'link-55');">ModuleDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1275"></a><tt class="py-lineno">1275</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' <a target="moduleFrame" href="%s"\n'</tt> </tt>
<a name="L1276"></a><tt class="py-lineno">1276</tt> <tt class="py-line"> <tt class="py-string">' onclick="setFrame(\'%s\',\'%s\');"'</tt> </tt>
<a name="L1277"></a><tt class="py-lineno">1277</tt> <tt class="py-line"> <tt class="py-string">' >%s</a><br />'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">toc_url</tt><tt class="py-op">,</tt> <tt class="py-name">toc_url</tt><tt class="py-op">,</tt> <tt class="py-name">doc_url</tt><tt class="py-op">,</tt> <tt id="link-437" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-437', 'label', 'link-118');">label</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1278"></a><tt class="py-lineno">1278</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1279"></a><tt class="py-lineno">1279</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' <a target="mainFrame" href="%s"\n'</tt> </tt>
<a name="L1280"></a><tt class="py-lineno">1280</tt> <tt class="py-line"> <tt class="py-string">' >%s</a><br />'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">doc_url</tt><tt class="py-op">,</tt> <tt id="link-438" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-438', 'label', 'link-118');">label</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1281"></a><tt class="py-lineno">1281</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">is_private</tt><tt class="py-op">:</tt> </tt>
<a name="L1282"></a><tt class="py-lineno">1282</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' </div>\n'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1283"></a><tt class="py-lineno">1283</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.write_project_toc"></a><div id="HTMLWriter.write_project_toc-def"><a name="L1284"></a><tt class="py-lineno">1284</tt> <a class="py-toggle" href="#" id="HTMLWriter.write_project_toc-toggle" onclick="return toggle('HTMLWriter.write_project_toc');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write_project_toc">write_project_toc</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write_project_toc-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write_project_toc-expanded"><a name="L1285"></a><tt class="py-lineno">1285</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-439" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_header
epydoc.docwriter.latex.LatexWriter.write_header" class="py-name" href="#" onclick="return doclink('link-439', 'write_header', 'link-222');">write_header</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">"Everything"</tt><tt class="py-op">)</tt> </tt>
<a name="L1286"></a><tt class="py-lineno">1286</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<h1 class="toc">Everything</h1>\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1287"></a><tt class="py-lineno">1287</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<hr />\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1288"></a><tt class="py-lineno">1288</tt> <tt class="py-line"> </tt>
<a name="L1289"></a><tt class="py-lineno">1289</tt> <tt class="py-line"> <tt class="py-comment"># List the classes.</tt> </tt>
<a name="L1290"></a><tt class="py-lineno">1290</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-440" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_toc_section()=epydoc.docwriter.html.HTMLWriter-class.html#write_toc_section"><a title="epydoc.docwriter.html.HTMLWriter.write_toc_section" class="py-name" href="#" onclick="return doclink('link-440', 'write_toc_section', 'link-440');">write_toc_section</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">"All Classes"</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">class_list</tt><tt class="py-op">)</tt> </tt>
<a name="L1291"></a><tt class="py-lineno">1291</tt> <tt class="py-line"> </tt>
<a name="L1292"></a><tt class="py-lineno">1292</tt> <tt class="py-line"> <tt class="py-comment"># List the functions.</tt> </tt>
<a name="L1293"></a><tt class="py-lineno">1293</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">funcs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">d</tt> <tt class="py-keyword">for</tt> <tt class="py-name">d</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">routine_list</tt> </tt>
<a name="L1294"></a><tt class="py-lineno">1294</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt id="link-441" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-441', 'container', 'link-63');">container</a></tt><tt class="py-op">(</tt><tt class="py-name">d</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L1295"></a><tt class="py-lineno">1295</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt id="link-442" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-442', 'ClassDoc', 'link-56');">ClassDoc</a></tt><tt class="py-op">,</tt> <tt class="py-name">types</tt><tt class="py-op">.</tt><tt class="py-name">NoneType</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L1296"></a><tt class="py-lineno">1296</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-443" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_toc_section" class="py-name" href="#" onclick="return doclink('link-443', 'write_toc_section', 'link-440');">write_toc_section</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">"All Functions"</tt><tt class="py-op">,</tt> <tt class="py-name">funcs</tt><tt class="py-op">)</tt> </tt>
<a name="L1297"></a><tt class="py-lineno">1297</tt> <tt class="py-line"> </tt>
<a name="L1298"></a><tt class="py-lineno">1298</tt> <tt class="py-line"> <tt class="py-comment"># List the variables.</tt> </tt>
<a name="L1299"></a><tt class="py-lineno">1299</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">vars</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L1300"></a><tt class="py-lineno">1300</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">module_list</tt><tt class="py-op">:</tt> </tt>
<a name="L1301"></a><tt class="py-lineno">1301</tt> <tt class="py-line"> <tt class="py-name">vars</tt> <tt class="py-op">+=</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-444" class="py-name" targets="Method epydoc.apidoc.ClassDoc.select_variables()=epydoc.apidoc.ClassDoc-class.html#select_variables,Method epydoc.apidoc.ModuleDoc.select_variables()=epydoc.apidoc.ModuleDoc-class.html#select_variables"><a title="epydoc.apidoc.ClassDoc.select_variables
epydoc.apidoc.ModuleDoc.select_variables" class="py-name" href="#" onclick="return doclink('link-444', 'select_variables', 'link-444');">select_variables</a></tt><tt class="py-op">(</tt><tt class="py-name">value_type</tt><tt class="py-op">=</tt><tt class="py-string">'other'</tt><tt class="py-op">,</tt> </tt>
<a name="L1302"></a><tt class="py-lineno">1302</tt> <tt class="py-line"> <tt class="py-name">imported</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L1303"></a><tt class="py-lineno">1303</tt> <tt class="py-line"> <tt class="py-name">public</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_public_filter</tt><tt class="py-op">)</tt> </tt>
<a name="L1304"></a><tt class="py-lineno">1304</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-445" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_toc_section" class="py-name" href="#" onclick="return doclink('link-445', 'write_toc_section', 'link-440');">write_toc_section</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">"All Variables"</tt><tt class="py-op">,</tt> <tt class="py-name">vars</tt><tt class="py-op">)</tt> </tt>
<a name="L1305"></a><tt class="py-lineno">1305</tt> <tt class="py-line"> </tt>
<a name="L1306"></a><tt class="py-lineno">1306</tt> <tt class="py-line"> <tt class="py-comment"># Footer material.</tt> </tt>
<a name="L1307"></a><tt class="py-lineno">1307</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<hr />\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1308"></a><tt class="py-lineno">1308</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_show_private</tt><tt class="py-op">:</tt> </tt>
<a name="L1309"></a><tt class="py-lineno">1309</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-446" class="py-name" targets="Variable epydoc.docwriter.html.HTMLWriter.PRIVATE_LINK=epydoc.docwriter.html.HTMLWriter-class.html#PRIVATE_LINK"><a title="epydoc.docwriter.html.HTMLWriter.PRIVATE_LINK" class="py-name" href="#" onclick="return doclink('link-446', 'PRIVATE_LINK', 'link-446');">PRIVATE_LINK</a></tt><tt class="py-op">+</tt><tt class="py-string">'\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1310"></a><tt class="py-lineno">1310</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-447" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_footer" class="py-name" href="#" onclick="return doclink('link-447', 'write_footer', 'link-244');">write_footer</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">short</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1311"></a><tt class="py-lineno">1311</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.write_module_toc"></a><div id="HTMLWriter.write_module_toc-def"><a name="L1312"></a><tt class="py-lineno">1312</tt> <a class="py-toggle" href="#" id="HTMLWriter.write_module_toc-toggle" onclick="return toggle('HTMLWriter.write_module_toc');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module_toc">write_module_toc</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write_module_toc-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write_module_toc-expanded"><a name="L1313"></a><tt class="py-lineno">1313</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1314"></a><tt class="py-lineno">1314</tt> <tt class="py-line"><tt class="py-docstring"> Write an HTML page containing the table of contents page for</tt> </tt>
<a name="L1315"></a><tt class="py-lineno">1315</tt> <tt class="py-line"><tt class="py-docstring"> the given module to the given streams. This page lists the</tt> </tt>
<a name="L1316"></a><tt class="py-lineno">1316</tt> <tt class="py-line"><tt class="py-docstring"> modules, classes, exceptions, functions, and variables defined</tt> </tt>
<a name="L1317"></a><tt class="py-lineno">1317</tt> <tt class="py-line"><tt class="py-docstring"> by the module.</tt> </tt>
<a name="L1318"></a><tt class="py-lineno">1318</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1319"></a><tt class="py-lineno">1319</tt> <tt class="py-line"> <tt id="link-448" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-448', 'name', 'link-117');">name</a></tt> <tt class="py-op">=</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-449" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-449', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt>
<a name="L1320"></a><tt class="py-lineno">1320</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-450" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_header
epydoc.docwriter.latex.LatexWriter.write_header" class="py-name" href="#" onclick="return doclink('link-450', 'write_header', 'link-222');">write_header</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt id="link-451" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-451', 'name', 'link-117');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1321"></a><tt class="py-lineno">1321</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<h1 class="toc">Module %s</h1>\n'</tt> <tt class="py-op">%</tt> <tt id="link-452" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-452', 'name', 'link-117');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1322"></a><tt class="py-lineno">1322</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<hr />\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1323"></a><tt class="py-lineno">1323</tt> <tt class="py-line"> </tt>
<a name="L1324"></a><tt class="py-lineno">1324</tt> <tt class="py-line"> </tt>
<a name="L1325"></a><tt class="py-lineno">1325</tt> <tt class="py-line"> <tt class="py-comment"># List the classes.</tt> </tt>
<a name="L1326"></a><tt class="py-lineno">1326</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">classes</tt> <tt class="py-op">=</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-453" class="py-name"><a title="epydoc.apidoc.ClassDoc.select_variables
epydoc.apidoc.ModuleDoc.select_variables" class="py-name" href="#" onclick="return doclink('link-453', 'select_variables', 'link-444');">select_variables</a></tt><tt class="py-op">(</tt><tt class="py-name">value_type</tt><tt class="py-op">=</tt><tt class="py-string">'class'</tt><tt class="py-op">,</tt> <tt class="py-name">imported</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L1327"></a><tt class="py-lineno">1327</tt> <tt class="py-line"> <tt class="py-name">public</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_public_filter</tt><tt class="py-op">)</tt> </tt>
<a name="L1328"></a><tt class="py-lineno">1328</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-454" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_toc_section" class="py-name" href="#" onclick="return doclink('link-454', 'write_toc_section', 'link-440');">write_toc_section</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">"Classes"</tt><tt class="py-op">,</tt> <tt class="py-name">classes</tt><tt class="py-op">,</tt> <tt class="py-name">fullname</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt> </tt>
<a name="L1329"></a><tt class="py-lineno">1329</tt> <tt class="py-line"> </tt>
<a name="L1330"></a><tt class="py-lineno">1330</tt> <tt class="py-line"> <tt class="py-comment"># List the functions.</tt> </tt>
<a name="L1331"></a><tt class="py-lineno">1331</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">funcs</tt> <tt class="py-op">=</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-455" class="py-name"><a title="epydoc.apidoc.ClassDoc.select_variables
epydoc.apidoc.ModuleDoc.select_variables" class="py-name" href="#" onclick="return doclink('link-455', 'select_variables', 'link-444');">select_variables</a></tt><tt class="py-op">(</tt><tt class="py-name">value_type</tt><tt class="py-op">=</tt><tt class="py-string">'function'</tt><tt class="py-op">,</tt> <tt class="py-name">imported</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L1332"></a><tt class="py-lineno">1332</tt> <tt class="py-line"> <tt class="py-name">public</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_public_filter</tt><tt class="py-op">)</tt> </tt>
<a name="L1333"></a><tt class="py-lineno">1333</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-456" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_toc_section" class="py-name" href="#" onclick="return doclink('link-456', 'write_toc_section', 'link-440');">write_toc_section</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">"Functions"</tt><tt class="py-op">,</tt> <tt class="py-name">funcs</tt><tt class="py-op">,</tt> <tt class="py-name">fullname</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt> </tt>
<a name="L1334"></a><tt class="py-lineno">1334</tt> <tt class="py-line"> </tt>
<a name="L1335"></a><tt class="py-lineno">1335</tt> <tt class="py-line"> <tt class="py-comment"># List the variables.</tt> </tt>
<a name="L1336"></a><tt class="py-lineno">1336</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-457" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-457', 'variables', 'link-60');">variables</a></tt> <tt class="py-op">=</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-458" class="py-name"><a title="epydoc.apidoc.ClassDoc.select_variables
epydoc.apidoc.ModuleDoc.select_variables" class="py-name" href="#" onclick="return doclink('link-458', 'select_variables', 'link-444');">select_variables</a></tt><tt class="py-op">(</tt><tt class="py-name">value_type</tt><tt class="py-op">=</tt><tt class="py-string">'other'</tt><tt class="py-op">,</tt> <tt class="py-name">imported</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L1337"></a><tt class="py-lineno">1337</tt> <tt class="py-line"> <tt class="py-name">public</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_public_filter</tt><tt class="py-op">)</tt> </tt>
<a name="L1338"></a><tt class="py-lineno">1338</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-459" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_toc_section" class="py-name" href="#" onclick="return doclink('link-459', 'write_toc_section', 'link-440');">write_toc_section</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">"Variables"</tt><tt class="py-op">,</tt> <tt id="link-460" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-460', 'variables', 'link-60');">variables</a></tt><tt class="py-op">,</tt> <tt class="py-name">fullname</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt> </tt>
<a name="L1339"></a><tt class="py-lineno">1339</tt> <tt class="py-line"> </tt>
<a name="L1340"></a><tt class="py-lineno">1340</tt> <tt class="py-line"> <tt class="py-comment"># Footer material.</tt> </tt>
<a name="L1341"></a><tt class="py-lineno">1341</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<hr />\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1342"></a><tt class="py-lineno">1342</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_show_private</tt><tt class="py-op">:</tt> </tt>
<a name="L1343"></a><tt class="py-lineno">1343</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-461" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.PRIVATE_LINK" class="py-name" href="#" onclick="return doclink('link-461', 'PRIVATE_LINK', 'link-446');">PRIVATE_LINK</a></tt><tt class="py-op">+</tt><tt class="py-string">'\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1344"></a><tt class="py-lineno">1344</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-462" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_footer" class="py-name" href="#" onclick="return doclink('link-462', 'write_footer', 'link-244');">write_footer</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">short</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1345"></a><tt class="py-lineno">1345</tt> <tt class="py-line"> </tt>
<a name="L1346"></a><tt class="py-lineno">1346</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1347"></a><tt class="py-lineno">1347</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ 2.7. Project homepage (index.html)</tt> </tt>
<a name="L1348"></a><tt class="py-lineno">1348</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1349"></a><tt class="py-lineno">1349</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="HTMLWriter.write_homepage"></a><div id="HTMLWriter.write_homepage-def"><a name="L1350"></a><tt class="py-lineno">1350</tt> <a class="py-toggle" href="#" id="HTMLWriter.write_homepage-toggle" onclick="return toggle('HTMLWriter.write_homepage');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write_homepage">write_homepage</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">directory</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write_homepage-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write_homepage-expanded"><a name="L1351"></a><tt class="py-lineno">1351</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1352"></a><tt class="py-lineno">1352</tt> <tt class="py-line"><tt class="py-docstring"> Write an C{index.html} file in the given directory. The</tt> </tt>
<a name="L1353"></a><tt class="py-lineno">1353</tt> <tt class="py-line"><tt class="py-docstring"> contents of this file are copied or linked from an existing</tt> </tt>
<a name="L1354"></a><tt class="py-lineno">1354</tt> <tt class="py-line"><tt class="py-docstring"> page, so this method must be called after all pages have been</tt> </tt>
<a name="L1355"></a><tt class="py-lineno">1355</tt> <tt class="py-line"><tt class="py-docstring"> written. The page used is determined by L{_frames_index} and</tt> </tt>
<a name="L1356"></a><tt class="py-lineno">1356</tt> <tt class="py-line"><tt class="py-docstring"> L{_top_page}:</tt> </tt>
<a name="L1357"></a><tt class="py-lineno">1357</tt> <tt class="py-line"><tt class="py-docstring"> - If L{_frames_index} is true, then C{frames.html} is</tt> </tt>
<a name="L1358"></a><tt class="py-lineno">1358</tt> <tt class="py-line"><tt class="py-docstring"> copied.</tt> </tt>
<a name="L1359"></a><tt class="py-lineno">1359</tt> <tt class="py-line"><tt class="py-docstring"> - Otherwise, the page specified by L{_top_page} is</tt> </tt>
<a name="L1360"></a><tt class="py-lineno">1360</tt> <tt class="py-line"><tt class="py-docstring"> copied.</tt> </tt>
<a name="L1361"></a><tt class="py-lineno">1361</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1362"></a><tt class="py-lineno">1362</tt> <tt class="py-line"> <tt id="link-463" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-463', 'filename', 'link-68');">filename</a></tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-464" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-464', 'path', 'link-211');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">directory</tt><tt class="py-op">,</tt> <tt class="py-string">'index.html'</tt><tt class="py-op">)</tt> </tt>
<a name="L1363"></a><tt class="py-lineno">1363</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_frames_index</tt><tt class="py-op">:</tt> <tt class="py-name">top</tt> <tt class="py-op">=</tt> <tt class="py-string">'frames.html'</tt> </tt>
<a name="L1364"></a><tt class="py-lineno">1364</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-name">top</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_top_page_url</tt> </tt>
<a name="L1365"></a><tt class="py-lineno">1365</tt> <tt class="py-line"> </tt>
<a name="L1366"></a><tt class="py-lineno">1366</tt> <tt class="py-line"> <tt class="py-comment"># Copy the non-frames index file from top, if it's internal.</tt> </tt>
<a name="L1367"></a><tt class="py-lineno">1367</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">top</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-number">5</tt><tt class="py-op">]</tt> <tt class="py-op">!=</tt> <tt class="py-string">'http:'</tt> <tt class="py-keyword">and</tt> <tt class="py-string">'/'</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">top</tt><tt class="py-op">:</tt> </tt>
<a name="L1368"></a><tt class="py-lineno">1368</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L1369"></a><tt class="py-lineno">1369</tt> <tt class="py-line"> <tt class="py-comment"># Read top into `s`.</tt> </tt>
<a name="L1370"></a><tt class="py-lineno">1370</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">topfile</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-465" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-465', 'path', 'link-211');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">directory</tt><tt class="py-op">,</tt> <tt class="py-name">top</tt><tt class="py-op">)</tt> </tt>
<a name="L1371"></a><tt class="py-lineno">1371</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">=</tt> <tt id="link-466" class="py-name"><a title="epydoc.gui.EpydocGUI.open" class="py-name" href="#" onclick="return doclink('link-466', 'open', 'link-214');">open</a></tt><tt class="py-op">(</tt><tt class="py-name">topfile</tt><tt class="py-op">,</tt> <tt class="py-string">'r'</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-467" class="py-name"><a title="epydoc.docintrospecter._DevNull.read
epydoc.docwriter.xlink.ApiLinkReader.read
epydoc.gui.GUILogger.read" class="py-name" href="#" onclick="return doclink('link-467', 'read', 'link-419');">read</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1372"></a><tt class="py-lineno">1372</tt> <tt class="py-line"> </tt>
<a name="L1373"></a><tt class="py-lineno">1373</tt> <tt class="py-line"> <tt class="py-comment"># Write the output file.</tt> </tt>
<a name="L1374"></a><tt class="py-lineno">1374</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-468" class="py-name"><a title="epydoc.gui.EpydocGUI.open" class="py-name" href="#" onclick="return doclink('link-468', 'open', 'link-214');">open</a></tt><tt class="py-op">(</tt><tt id="link-469" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-469', 'filename', 'link-68');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-string">'w'</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-470" class="py-name"><a title="epydoc.docintrospecter._DevNull.write
epydoc.docwriter.dotgraph.DotGraph.write
epydoc.docwriter.html.HTMLWriter.write
epydoc.docwriter.latex.LatexWriter.write
epydoc.docwriter.plaintext.PlaintextWriter.write" class="py-name" href="#" onclick="return doclink('link-470', 'write', 'link-216');">write</a></tt><tt class="py-op">(</tt><tt class="py-name">s</tt><tt class="py-op">)</tt> </tt>
<a name="L1375"></a><tt class="py-lineno">1375</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
<a name="L1376"></a><tt class="py-lineno">1376</tt> <tt class="py-line"> <tt class="py-keyword">except</tt><tt class="py-op">:</tt> </tt>
<a name="L1377"></a><tt class="py-lineno">1377</tt> <tt class="py-line"> <tt id="link-471" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-471', 'log', 'link-29');">log</a></tt><tt class="py-op">.</tt><tt id="link-472" class="py-name"><a title="epydoc.log.error" class="py-name" href="#" onclick="return doclink('link-472', 'error', 'link-45');">error</a></tt><tt class="py-op">(</tt><tt class="py-string">'Warning: error copying index; '</tt> </tt>
<a name="L1378"></a><tt class="py-lineno">1378</tt> <tt class="py-line"> <tt class="py-string">'using a redirect page'</tt><tt class="py-op">)</tt> </tt>
<a name="L1379"></a><tt class="py-lineno">1379</tt> <tt class="py-line"> </tt>
<a name="L1380"></a><tt class="py-lineno">1380</tt> <tt class="py-line"> <tt class="py-comment"># Use a redirect if top is external, or if we faild to copy.</tt> </tt>
<a name="L1381"></a><tt class="py-lineno">1381</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-473" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-473', 'name', 'link-117');">name</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_prj_name</tt> <tt class="py-keyword">or</tt> <tt class="py-string">'this project'</tt> </tt>
<a name="L1382"></a><tt class="py-lineno">1382</tt> <tt class="py-line"> <tt class="py-name">f</tt> <tt class="py-op">=</tt> <tt id="link-474" class="py-name"><a title="epydoc.gui.EpydocGUI.open" class="py-name" href="#" onclick="return doclink('link-474', 'open', 'link-214');">open</a></tt><tt class="py-op">(</tt><tt id="link-475" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-475', 'filename', 'link-68');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-string">'w'</tt><tt class="py-op">)</tt> </tt>
<a name="L1383"></a><tt class="py-lineno">1383</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-476" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_redirect_index()=epydoc.docwriter.html.HTMLWriter-class.html#write_redirect_index"><a title="epydoc.docwriter.html.HTMLWriter.write_redirect_index" class="py-name" href="#" onclick="return doclink('link-476', 'write_redirect_index', 'link-476');">write_redirect_index</a></tt><tt class="py-op">(</tt><tt class="py-name">f</tt><tt class="py-op">.</tt><tt id="link-477" class="py-name"><a title="epydoc.docintrospecter._DevNull.write
epydoc.docwriter.dotgraph.DotGraph.write
epydoc.docwriter.html.HTMLWriter.write
epydoc.docwriter.latex.LatexWriter.write
epydoc.docwriter.plaintext.PlaintextWriter.write" class="py-name" href="#" onclick="return doclink('link-477', 'write', 'link-216');">write</a></tt><tt class="py-op">,</tt> <tt class="py-name">top</tt><tt class="py-op">,</tt> <tt id="link-478" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-478', 'name', 'link-117');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1384"></a><tt class="py-lineno">1384</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt id="link-479" class="py-name"><a title="epydoc.cli.HTMLLogger.close
epydoc.docintrospecter._DevNull.close
epydoc.log.Logger.close
epydoc.log.close" class="py-name" href="#" onclick="return doclink('link-479', 'close', 'link-217');">close</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1385"></a><tt class="py-lineno">1385</tt> <tt class="py-line"> </tt>
<a name="L1386"></a><tt class="py-lineno">1386</tt> <tt class="py-line"> <tt id="link-480" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_redirect_index" class="py-name" href="#" onclick="return doclink('link-480', 'write_redirect_index', 'link-476');">write_redirect_index</a></tt> <tt class="py-op">=</tt> <tt id="link-481" class="py-name"><a title="epydoc.docwriter.html.compile_template" class="py-name" href="#" onclick="return doclink('link-481', 'compile_template', 'link-427');">compile_template</a></tt><tt class="py-op">(</tt> </tt>
<a name="L1387"></a><tt class="py-lineno">1387</tt> <tt class="py-line"> <tt class="py-string">"""</tt> </tt>
<a name="L1388"></a><tt class="py-lineno">1388</tt> <tt class="py-line"><tt class="py-string"> write_redirect_index(self, out, top, name)</tt> </tt>
<a name="L1389"></a><tt class="py-lineno">1389</tt> <tt class="py-line"><tt class="py-string"> """</tt><tt class="py-op">,</tt> </tt>
<a name="L1390"></a><tt class="py-lineno">1390</tt> <tt class="py-line"> <tt class="py-comment"># /------------------------- Template -------------------------\</tt> </tt>
<a name="L1391"></a><tt class="py-lineno">1391</tt> <tt class="py-line"> <tt class="py-string">'''</tt> </tt>
<a name="L1392"></a><tt class="py-lineno">1392</tt> <tt class="py-line"><tt class="py-string"> <?xml version="1.0" encoding="iso-8859-1"?></tt> </tt>
<a name="L1393"></a><tt class="py-lineno">1393</tt> <tt class="py-line"><tt class="py-string"> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"</tt> </tt>
<a name="L1394"></a><tt class="py-lineno">1394</tt> <tt class="py-line"><tt class="py-string"> "DTD/xhtml1-strict.dtd"></tt> </tt>
<a name="L1395"></a><tt class="py-lineno">1395</tt> <tt class="py-line"><tt class="py-string"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"></tt> </tt>
<a name="L1396"></a><tt class="py-lineno">1396</tt> <tt class="py-line"><tt class="py-string"> <head></tt> </tt>
<a name="L1397"></a><tt class="py-lineno">1397</tt> <tt class="py-line"><tt class="py-string"> <title> Redirect </title></tt> </tt>
<a name="L1398"></a><tt class="py-lineno">1398</tt> <tt class="py-line"><tt class="py-string"> <meta http-equiv="refresh" content="1;url=$top$" /></tt> </tt>
<a name="L1399"></a><tt class="py-lineno">1399</tt> <tt class="py-line"><tt class="py-string"> <link rel="stylesheet" href="epydoc.css" type="text/css"></link></tt> </tt>
<a name="L1400"></a><tt class="py-lineno">1400</tt> <tt class="py-line"><tt class="py-string"> </head></tt> </tt>
<a name="L1401"></a><tt class="py-lineno">1401</tt> <tt class="py-line"><tt class="py-string"> <body></tt> </tt>
<a name="L1402"></a><tt class="py-lineno">1402</tt> <tt class="py-line"><tt class="py-string"> <p>Redirecting to the API documentation for</tt> </tt>
<a name="L1403"></a><tt class="py-lineno">1403</tt> <tt class="py-line"><tt class="py-string"> <a href="$top$">$self._prj_name or "this project"$</a>...</p></tt> </tt>
<a name="L1404"></a><tt class="py-lineno">1404</tt> <tt class="py-line"><tt class="py-string"> </body></tt> </tt>
<a name="L1405"></a><tt class="py-lineno">1405</tt> <tt class="py-line"><tt class="py-string"> </html></tt> </tt>
<a name="L1406"></a><tt class="py-lineno">1406</tt> <tt class="py-line"><tt class="py-string"> '''</tt><tt class="py-op">)</tt> </tt>
<a name="L1407"></a><tt class="py-lineno">1407</tt> <tt class="py-line"> <tt class="py-comment"># \------------------------------------------------------------/</tt> </tt>
<a name="L1408"></a><tt class="py-lineno">1408</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L1409"></a><tt class="py-lineno">1409</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1410"></a><tt class="py-lineno">1410</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ 2.8. Stylesheet (epydoc.css)</tt> </tt>
<a name="L1411"></a><tt class="py-lineno">1411</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1412"></a><tt class="py-lineno">1412</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="HTMLWriter.write_css"></a><div id="HTMLWriter.write_css-def"><a name="L1413"></a><tt class="py-lineno">1413</tt> <a class="py-toggle" href="#" id="HTMLWriter.write_css-toggle" onclick="return toggle('HTMLWriter.write_css');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write_css">write_css</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">directory</tt><tt class="py-op">,</tt> <tt class="py-param">cssname</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write_css-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write_css-expanded"><a name="L1414"></a><tt class="py-lineno">1414</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1415"></a><tt class="py-lineno">1415</tt> <tt class="py-line"><tt class="py-docstring"> Write the CSS stylesheet in the given directory. If</tt> </tt>
<a name="L1416"></a><tt class="py-lineno">1416</tt> <tt class="py-line"><tt class="py-docstring"> C{cssname} contains a stylesheet file or name (from</tt> </tt>
<a name="L1417"></a><tt class="py-lineno">1417</tt> <tt class="py-line"><tt class="py-docstring"> L{epydoc.docwriter.html_css}), then use that stylesheet;</tt> </tt>
<a name="L1418"></a><tt class="py-lineno">1418</tt> <tt class="py-line"><tt class="py-docstring"> otherwise, use the default stylesheet.</tt> </tt>
<a name="L1419"></a><tt class="py-lineno">1419</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1420"></a><tt class="py-lineno">1420</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{None}</tt> </tt>
<a name="L1421"></a><tt class="py-lineno">1421</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1422"></a><tt class="py-lineno">1422</tt> <tt class="py-line"> <tt id="link-482" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-482', 'filename', 'link-68');">filename</a></tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-483" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-483', 'path', 'link-211');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">directory</tt><tt class="py-op">,</tt> <tt class="py-string">'epydoc.css'</tt><tt class="py-op">)</tt> </tt>
<a name="L1423"></a><tt class="py-lineno">1423</tt> <tt class="py-line"> </tt>
<a name="L1424"></a><tt class="py-lineno">1424</tt> <tt class="py-line"> <tt class="py-comment"># Get the contents for the stylesheet file.</tt> </tt>
<a name="L1425"></a><tt class="py-lineno">1425</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">cssname</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L1426"></a><tt class="py-lineno">1426</tt> <tt class="py-line"> <tt class="py-name">css</tt> <tt class="py-op">=</tt> <tt id="link-484" class="py-name"><a title="epydoc.docwriter.html_css.STYLESHEETS" class="py-name" href="#" onclick="return doclink('link-484', 'STYLESHEETS', 'link-20');">STYLESHEETS</a></tt><tt class="py-op">[</tt><tt class="py-string">'default'</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L1427"></a><tt class="py-lineno">1427</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1428"></a><tt class="py-lineno">1428</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-485" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-485', 'path', 'link-211');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">exists</tt><tt class="py-op">(</tt><tt class="py-name">cssname</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1429"></a><tt class="py-lineno">1429</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> <tt class="py-name">css</tt> <tt class="py-op">=</tt> <tt id="link-486" class="py-name"><a title="epydoc.gui.EpydocGUI.open" class="py-name" href="#" onclick="return doclink('link-486', 'open', 'link-214');">open</a></tt><tt class="py-op">(</tt><tt class="py-name">cssname</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-487" class="py-name"><a title="epydoc.docintrospecter._DevNull.read
epydoc.docwriter.xlink.ApiLinkReader.read
epydoc.gui.GUILogger.read" class="py-name" href="#" onclick="return doclink('link-487', 'read', 'link-419');">read</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1430"></a><tt class="py-lineno">1430</tt> <tt class="py-line"> <tt class="py-keyword">except</tt><tt class="py-op">:</tt> <tt class="py-keyword">raise</tt> <tt class="py-name">IOError</tt><tt class="py-op">(</tt><tt class="py-string">"Can't open CSS file: %r"</tt> <tt class="py-op">%</tt> <tt class="py-name">cssname</tt><tt class="py-op">)</tt> </tt>
<a name="L1431"></a><tt class="py-lineno">1431</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">cssname</tt> <tt class="py-keyword">in</tt> <tt id="link-488" class="py-name"><a title="epydoc.docwriter.html_css.STYLESHEETS" class="py-name" href="#" onclick="return doclink('link-488', 'STYLESHEETS', 'link-20');">STYLESHEETS</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1432"></a><tt class="py-lineno">1432</tt> <tt class="py-line"> <tt class="py-name">css</tt> <tt class="py-op">=</tt> <tt id="link-489" class="py-name"><a title="epydoc.docwriter.html_css.STYLESHEETS" class="py-name" href="#" onclick="return doclink('link-489', 'STYLESHEETS', 'link-20');">STYLESHEETS</a></tt><tt class="py-op">[</tt><tt class="py-name">cssname</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L1433"></a><tt class="py-lineno">1433</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1434"></a><tt class="py-lineno">1434</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">IOError</tt><tt class="py-op">(</tt><tt class="py-string">"Can't find CSS file: %r"</tt> <tt class="py-op">%</tt> <tt class="py-name">cssname</tt><tt class="py-op">)</tt> </tt>
<a name="L1435"></a><tt class="py-lineno">1435</tt> <tt class="py-line"> </tt>
<a name="L1436"></a><tt class="py-lineno">1436</tt> <tt class="py-line"> <tt class="py-comment"># Write the stylesheet.</tt> </tt>
<a name="L1437"></a><tt class="py-lineno">1437</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">cssfile</tt> <tt class="py-op">=</tt> <tt id="link-490" class="py-name"><a title="epydoc.gui.EpydocGUI.open" class="py-name" href="#" onclick="return doclink('link-490', 'open', 'link-214');">open</a></tt><tt class="py-op">(</tt><tt id="link-491" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-491', 'filename', 'link-68');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-string">'w'</tt><tt class="py-op">)</tt> </tt>
<a name="L1438"></a><tt class="py-lineno">1438</tt> <tt class="py-line"> <tt class="py-name">cssfile</tt><tt class="py-op">.</tt><tt id="link-492" class="py-name"><a title="epydoc.docintrospecter._DevNull.write
epydoc.docwriter.dotgraph.DotGraph.write
epydoc.docwriter.html.HTMLWriter.write
epydoc.docwriter.latex.LatexWriter.write
epydoc.docwriter.plaintext.PlaintextWriter.write" class="py-name" href="#" onclick="return doclink('link-492', 'write', 'link-216');">write</a></tt><tt class="py-op">(</tt><tt class="py-name">css</tt><tt class="py-op">)</tt> </tt>
<a name="L1439"></a><tt class="py-lineno">1439</tt> <tt class="py-line"> <tt class="py-name">cssfile</tt><tt class="py-op">.</tt><tt id="link-493" class="py-name"><a title="epydoc.cli.HTMLLogger.close
epydoc.docintrospecter._DevNull.close
epydoc.log.Logger.close
epydoc.log.close" class="py-name" href="#" onclick="return doclink('link-493', 'close', 'link-217');">close</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1440"></a><tt class="py-lineno">1440</tt> <tt class="py-line"> </tt>
<a name="L1441"></a><tt class="py-lineno">1441</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1442"></a><tt class="py-lineno">1442</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ 2.9. Javascript (epydoc.js)</tt> </tt>
<a name="L1443"></a><tt class="py-lineno">1443</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1444"></a><tt class="py-lineno">1444</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="HTMLWriter.write_javascript"></a><div id="HTMLWriter.write_javascript-def"><a name="L1445"></a><tt class="py-lineno">1445</tt> <a class="py-toggle" href="#" id="HTMLWriter.write_javascript-toggle" onclick="return toggle('HTMLWriter.write_javascript');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write_javascript">write_javascript</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">directory</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write_javascript-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write_javascript-expanded"><a name="L1446"></a><tt class="py-lineno">1446</tt> <tt class="py-line"> <tt class="py-name">jsfile</tt> <tt class="py-op">=</tt> <tt id="link-494" class="py-name"><a title="epydoc.gui.EpydocGUI.open" class="py-name" href="#" onclick="return doclink('link-494', 'open', 'link-214');">open</a></tt><tt class="py-op">(</tt><tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-495" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-495', 'path', 'link-211');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">directory</tt><tt class="py-op">,</tt> <tt class="py-string">'epydoc.js'</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-string">'w'</tt><tt class="py-op">)</tt> </tt>
<a name="L1447"></a><tt class="py-lineno">1447</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> <tt class="py-op">>></tt> <tt class="py-name">jsfile</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-496" class="py-name" targets="Variable epydoc.docwriter.html.HTMLWriter.TOGGLE_PRIVATE_JS=epydoc.docwriter.html.HTMLWriter-class.html#TOGGLE_PRIVATE_JS"><a title="epydoc.docwriter.html.HTMLWriter.TOGGLE_PRIVATE_JS" class="py-name" href="#" onclick="return doclink('link-496', 'TOGGLE_PRIVATE_JS', 'link-496');">TOGGLE_PRIVATE_JS</a></tt> </tt>
<a name="L1448"></a><tt class="py-lineno">1448</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> <tt class="py-op">>></tt> <tt class="py-name">jsfile</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-497" class="py-name" targets="Variable epydoc.docwriter.html.HTMLWriter.SHOW_PRIVATE_JS=epydoc.docwriter.html.HTMLWriter-class.html#SHOW_PRIVATE_JS"><a title="epydoc.docwriter.html.HTMLWriter.SHOW_PRIVATE_JS" class="py-name" href="#" onclick="return doclink('link-497', 'SHOW_PRIVATE_JS', 'link-497');">SHOW_PRIVATE_JS</a></tt> </tt>
<a name="L1449"></a><tt class="py-lineno">1449</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> <tt class="py-op">>></tt> <tt class="py-name">jsfile</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-498" class="py-name" targets="Variable epydoc.docwriter.html.HTMLWriter.GET_COOKIE_JS=epydoc.docwriter.html.HTMLWriter-class.html#GET_COOKIE_JS"><a title="epydoc.docwriter.html.HTMLWriter.GET_COOKIE_JS" class="py-name" href="#" onclick="return doclink('link-498', 'GET_COOKIE_JS', 'link-498');">GET_COOKIE_JS</a></tt> </tt>
<a name="L1450"></a><tt class="py-lineno">1450</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> <tt class="py-op">>></tt> <tt class="py-name">jsfile</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-499" class="py-name" targets="Variable epydoc.docwriter.html.HTMLWriter.SET_FRAME_JS=epydoc.docwriter.html.HTMLWriter-class.html#SET_FRAME_JS"><a title="epydoc.docwriter.html.HTMLWriter.SET_FRAME_JS" class="py-name" href="#" onclick="return doclink('link-499', 'SET_FRAME_JS', 'link-499');">SET_FRAME_JS</a></tt> </tt>
<a name="L1451"></a><tt class="py-lineno">1451</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> <tt class="py-op">>></tt> <tt class="py-name">jsfile</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-500" class="py-name" targets="Variable epydoc.docwriter.html.HTMLWriter.HIDE_PRIVATE_JS=epydoc.docwriter.html.HTMLWriter-class.html#HIDE_PRIVATE_JS"><a title="epydoc.docwriter.html.HTMLWriter.HIDE_PRIVATE_JS" class="py-name" href="#" onclick="return doclink('link-500', 'HIDE_PRIVATE_JS', 'link-500');">HIDE_PRIVATE_JS</a></tt> </tt>
<a name="L1452"></a><tt class="py-lineno">1452</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> <tt class="py-op">>></tt> <tt class="py-name">jsfile</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-501" class="py-name" targets="Variable epydoc.docwriter.html.HTMLWriter.TOGGLE_CALLGRAPH_JS=epydoc.docwriter.html.HTMLWriter-class.html#TOGGLE_CALLGRAPH_JS"><a title="epydoc.docwriter.html.HTMLWriter.TOGGLE_CALLGRAPH_JS" class="py-name" href="#" onclick="return doclink('link-501', 'TOGGLE_CALLGRAPH_JS', 'link-501');">TOGGLE_CALLGRAPH_JS</a></tt> </tt>
<a name="L1453"></a><tt class="py-lineno">1453</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> <tt class="py-op">>></tt> <tt class="py-name">jsfile</tt><tt class="py-op">,</tt> <tt id="link-502" class="py-name"><a title="epydoc.docwriter.html_colorize" class="py-name" href="#" onclick="return doclink('link-502', 'html_colorize', 'link-12');">html_colorize</a></tt><tt class="py-op">.</tt><tt id="link-503" class="py-name" targets="Variable epydoc.docwriter.html_colorize.PYSRC_JAVASCRIPTS=epydoc.docwriter.html_colorize-module.html#PYSRC_JAVASCRIPTS"><a title="epydoc.docwriter.html_colorize.PYSRC_JAVASCRIPTS" class="py-name" href="#" onclick="return doclink('link-503', 'PYSRC_JAVASCRIPTS', 'link-503');">PYSRC_JAVASCRIPTS</a></tt> </tt>
<a name="L1454"></a><tt class="py-lineno">1454</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> <tt class="py-op">>></tt> <tt class="py-name">jsfile</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-504" class="py-name" targets="Variable epydoc.docwriter.html.HTMLWriter.GET_ANCHOR_JS=epydoc.docwriter.html.HTMLWriter-class.html#GET_ANCHOR_JS"><a title="epydoc.docwriter.html.HTMLWriter.GET_ANCHOR_JS" class="py-name" href="#" onclick="return doclink('link-504', 'GET_ANCHOR_JS', 'link-504');">GET_ANCHOR_JS</a></tt> </tt>
<a name="L1455"></a><tt class="py-lineno">1455</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> <tt class="py-op">>></tt> <tt class="py-name">jsfile</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-505" class="py-name" targets="Variable epydoc.docwriter.html.HTMLWriter.REDIRECT_URL_JS=epydoc.docwriter.html.HTMLWriter-class.html#REDIRECT_URL_JS"><a title="epydoc.docwriter.html.HTMLWriter.REDIRECT_URL_JS" class="py-name" href="#" onclick="return doclink('link-505', 'REDIRECT_URL_JS', 'link-505');">REDIRECT_URL_JS</a></tt> </tt>
<a name="L1456"></a><tt class="py-lineno">1456</tt> <tt class="py-line"> <tt class="py-name">jsfile</tt><tt class="py-op">.</tt><tt id="link-506" class="py-name"><a title="epydoc.cli.HTMLLogger.close
epydoc.docintrospecter._DevNull.close
epydoc.log.Logger.close
epydoc.log.close" class="py-name" href="#" onclick="return doclink('link-506', 'close', 'link-217');">close</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1457"></a><tt class="py-lineno">1457</tt> <tt class="py-line"> </tt>
<a name="L1458"></a><tt class="py-lineno">1458</tt> <tt class="py-line"> <tt class="py-comment">#: A javascript that is used to show or hide the API documentation</tt> </tt>
<a name="L1459"></a><tt class="py-lineno">1459</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: for private objects. In order for this to work correctly, all</tt> </tt>
<a name="L1460"></a><tt class="py-lineno">1460</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: documentation for private objects should be enclosed in </tt> </tt>
<a name="L1461"></a><tt class="py-lineno">1461</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: C{<div class="private">...</div>} elements.</tt> </tt>
<a name="L1462"></a><tt class="py-lineno">1462</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-507" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.TOGGLE_PRIVATE_JS" class="py-name" href="#" onclick="return doclink('link-507', 'TOGGLE_PRIVATE_JS', 'link-496');">TOGGLE_PRIVATE_JS</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'''</tt> </tt>
<a name="L1463"></a><tt class="py-lineno">1463</tt> <tt class="py-line"><tt class="py-string"> function toggle_private() {</tt> </tt>
<a name="L1464"></a><tt class="py-lineno">1464</tt> <tt class="py-line"><tt class="py-string"> // Search for any private/public links on this page. Store</tt> </tt>
<a name="L1465"></a><tt class="py-lineno">1465</tt> <tt class="py-line"><tt class="py-string"> // their old text in "cmd," so we will know what action to</tt> </tt>
<a name="L1466"></a><tt class="py-lineno">1466</tt> <tt class="py-line"><tt class="py-string"> // take; and change their text to the opposite action.</tt> </tt>
<a name="L1467"></a><tt class="py-lineno">1467</tt> <tt class="py-line"><tt class="py-string"> var cmd = "?";</tt> </tt>
<a name="L1468"></a><tt class="py-lineno">1468</tt> <tt class="py-line"><tt class="py-string"> var elts = document.getElementsByTagName("a");</tt> </tt>
<a name="L1469"></a><tt class="py-lineno">1469</tt> <tt class="py-line"><tt class="py-string"> for(var i=0; i<elts.length; i++) {</tt> </tt>
<a name="L1470"></a><tt class="py-lineno">1470</tt> <tt class="py-line"><tt class="py-string"> if (elts[i].className == "privatelink") {</tt> </tt>
<a name="L1471"></a><tt class="py-lineno">1471</tt> <tt class="py-line"><tt class="py-string"> cmd = elts[i].innerHTML;</tt> </tt>
<a name="L1472"></a><tt class="py-lineno">1472</tt> <tt class="py-line"><tt class="py-string"> elts[i].innerHTML = ((cmd && cmd.substr(0,4)=="show")?</tt> </tt>
<a name="L1473"></a><tt class="py-lineno">1473</tt> <tt class="py-line"><tt class="py-string"> "hide&nbsp;private":"show&nbsp;private");</tt> </tt>
<a name="L1474"></a><tt class="py-lineno">1474</tt> <tt class="py-line"><tt class="py-string"> }</tt> </tt>
<a name="L1475"></a><tt class="py-lineno">1475</tt> <tt class="py-line"><tt class="py-string"> }</tt> </tt>
<a name="L1476"></a><tt class="py-lineno">1476</tt> <tt class="py-line"><tt class="py-string"> // Update all DIVs containing private objects.</tt> </tt>
<a name="L1477"></a><tt class="py-lineno">1477</tt> <tt class="py-line"><tt class="py-string"> var elts = document.getElementsByTagName("div");</tt> </tt>
<a name="L1478"></a><tt class="py-lineno">1478</tt> <tt class="py-line"><tt class="py-string"> for(var i=0; i<elts.length; i++) {</tt> </tt>
<a name="L1479"></a><tt class="py-lineno">1479</tt> <tt class="py-line"><tt class="py-string"> if (elts[i].className == "private") {</tt> </tt>
<a name="L1480"></a><tt class="py-lineno">1480</tt> <tt class="py-line"><tt class="py-string"> elts[i].style.display = ((cmd && cmd.substr(0,4)=="hide")?"none":"block");</tt> </tt>
<a name="L1481"></a><tt class="py-lineno">1481</tt> <tt class="py-line"><tt class="py-string"> }</tt> </tt>
<a name="L1482"></a><tt class="py-lineno">1482</tt> <tt class="py-line"><tt class="py-string"> else if (elts[i].className == "public") {</tt> </tt>
<a name="L1483"></a><tt class="py-lineno">1483</tt> <tt class="py-line"><tt class="py-string"> elts[i].style.display = ((cmd && cmd.substr(0,4)=="hide")?"block":"none");</tt> </tt>
<a name="L1484"></a><tt class="py-lineno">1484</tt> <tt class="py-line"><tt class="py-string"> }</tt> </tt>
<a name="L1485"></a><tt class="py-lineno">1485</tt> <tt class="py-line"><tt class="py-string"> }</tt> </tt>
<a name="L1486"></a><tt class="py-lineno">1486</tt> <tt class="py-line"><tt class="py-string"> // Update all table rows containing private objects. Note, we</tt> </tt>
<a name="L1487"></a><tt class="py-lineno">1487</tt> <tt class="py-line"><tt class="py-string"> // use "" instead of "block" becaue IE & firefox disagree on what</tt> </tt>
<a name="L1488"></a><tt class="py-lineno">1488</tt> <tt class="py-line"><tt class="py-string"> // this should be (block vs table-row), and "" just gives the</tt> </tt>
<a name="L1489"></a><tt class="py-lineno">1489</tt> <tt class="py-line"><tt class="py-string"> // default for both browsers.</tt> </tt>
<a name="L1490"></a><tt class="py-lineno">1490</tt> <tt class="py-line"><tt class="py-string"> var elts = document.getElementsByTagName("tr");</tt> </tt>
<a name="L1491"></a><tt class="py-lineno">1491</tt> <tt class="py-line"><tt class="py-string"> for(var i=0; i<elts.length; i++) {</tt> </tt>
<a name="L1492"></a><tt class="py-lineno">1492</tt> <tt class="py-line"><tt class="py-string"> if (elts[i].className == "private") {</tt> </tt>
<a name="L1493"></a><tt class="py-lineno">1493</tt> <tt class="py-line"><tt class="py-string"> elts[i].style.display = ((cmd && cmd.substr(0,4)=="hide")?"none":"");</tt> </tt>
<a name="L1494"></a><tt class="py-lineno">1494</tt> <tt class="py-line"><tt class="py-string"> }</tt> </tt>
<a name="L1495"></a><tt class="py-lineno">1495</tt> <tt class="py-line"><tt class="py-string"> }</tt> </tt>
<a name="L1496"></a><tt class="py-lineno">1496</tt> <tt class="py-line"><tt class="py-string"> // Update all list items containing private objects.</tt> </tt>
<a name="L1497"></a><tt class="py-lineno">1497</tt> <tt class="py-line"><tt class="py-string"> var elts = document.getElementsByTagName("li");</tt> </tt>
<a name="L1498"></a><tt class="py-lineno">1498</tt> <tt class="py-line"><tt class="py-string"> for(var i=0; i<elts.length; i++) {</tt> </tt>
<a name="L1499"></a><tt class="py-lineno">1499</tt> <tt class="py-line"><tt class="py-string"> if (elts[i].className == "private") {</tt> </tt>
<a name="L1500"></a><tt class="py-lineno">1500</tt> <tt class="py-line"><tt class="py-string"> elts[i].style.display = ((cmd && cmd.substr(0,4)=="hide")?</tt> </tt>
<a name="L1501"></a><tt class="py-lineno">1501</tt> <tt class="py-line"><tt class="py-string"> "none":"");</tt> </tt>
<a name="L1502"></a><tt class="py-lineno">1502</tt> <tt class="py-line"><tt class="py-string"> }</tt> </tt>
<a name="L1503"></a><tt class="py-lineno">1503</tt> <tt class="py-line"><tt class="py-string"> }</tt> </tt>
<a name="L1504"></a><tt class="py-lineno">1504</tt> <tt class="py-line"><tt class="py-string"> // Update all list items containing private objects.</tt> </tt>
<a name="L1505"></a><tt class="py-lineno">1505</tt> <tt class="py-line"><tt class="py-string"> var elts = document.getElementsByTagName("ul");</tt> </tt>
<a name="L1506"></a><tt class="py-lineno">1506</tt> <tt class="py-line"><tt class="py-string"> for(var i=0; i<elts.length; i++) {</tt> </tt>
<a name="L1507"></a><tt class="py-lineno">1507</tt> <tt class="py-line"><tt class="py-string"> if (elts[i].className == "private") {</tt> </tt>
<a name="L1508"></a><tt class="py-lineno">1508</tt> <tt class="py-line"><tt class="py-string"> elts[i].style.display = ((cmd && cmd.substr(0,4)=="hide")?"none":"block");</tt> </tt>
<a name="L1509"></a><tt class="py-lineno">1509</tt> <tt class="py-line"><tt class="py-string"> }</tt> </tt>
<a name="L1510"></a><tt class="py-lineno">1510</tt> <tt class="py-line"><tt class="py-string"> }</tt> </tt>
<a name="L1511"></a><tt class="py-lineno">1511</tt> <tt class="py-line"><tt class="py-string"> // Set a cookie to remember the current option.</tt> </tt>
<a name="L1512"></a><tt class="py-lineno">1512</tt> <tt class="py-line"><tt class="py-string"> document.cookie = "EpydocPrivate="+cmd;</tt> </tt>
<a name="L1513"></a><tt class="py-lineno">1513</tt> <tt class="py-line"><tt class="py-string"> }</tt> </tt>
<a name="L1514"></a><tt class="py-lineno">1514</tt> <tt class="py-line"><tt class="py-string"> '''</tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1515"></a><tt class="py-lineno">1515</tt> <tt class="py-line"> </tt>
<a name="L1516"></a><tt class="py-lineno">1516</tt> <tt class="py-line"> <tt class="py-comment">#: A javascript that is used to read the value of a cookie. This</tt> </tt>
<a name="L1517"></a><tt class="py-lineno">1517</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: is used to remember whether private variables should be shown or</tt> </tt>
<a name="L1518"></a><tt class="py-lineno">1518</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: hidden.</tt> </tt>
<a name="L1519"></a><tt class="py-lineno">1519</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-508" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.GET_COOKIE_JS" class="py-name" href="#" onclick="return doclink('link-508', 'GET_COOKIE_JS', 'link-498');">GET_COOKIE_JS</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'''</tt> </tt>
<a name="L1520"></a><tt class="py-lineno">1520</tt> <tt class="py-line"><tt class="py-string"> function getCookie(name) {</tt> </tt>
<a name="L1521"></a><tt class="py-lineno">1521</tt> <tt class="py-line"><tt class="py-string"> var dc = document.cookie;</tt> </tt>
<a name="L1522"></a><tt class="py-lineno">1522</tt> <tt class="py-line"><tt class="py-string"> var prefix = name + "=";</tt> </tt>
<a name="L1523"></a><tt class="py-lineno">1523</tt> <tt class="py-line"><tt class="py-string"> var begin = dc.indexOf("; " + prefix);</tt> </tt>
<a name="L1524"></a><tt class="py-lineno">1524</tt> <tt class="py-line"><tt class="py-string"> if (begin == -1) {</tt> </tt>
<a name="L1525"></a><tt class="py-lineno">1525</tt> <tt class="py-line"><tt class="py-string"> begin = dc.indexOf(prefix);</tt> </tt>
<a name="L1526"></a><tt class="py-lineno">1526</tt> <tt class="py-line"><tt class="py-string"> if (begin != 0) return null;</tt> </tt>
<a name="L1527"></a><tt class="py-lineno">1527</tt> <tt class="py-line"><tt class="py-string"> } else</tt> </tt>
<a name="L1528"></a><tt class="py-lineno">1528</tt> <tt class="py-line"><tt class="py-string"> { begin += 2; }</tt> </tt>
<a name="L1529"></a><tt class="py-lineno">1529</tt> <tt class="py-line"><tt class="py-string"> var end = document.cookie.indexOf(";", begin);</tt> </tt>
<a name="L1530"></a><tt class="py-lineno">1530</tt> <tt class="py-line"><tt class="py-string"> if (end == -1)</tt> </tt>
<a name="L1531"></a><tt class="py-lineno">1531</tt> <tt class="py-line"><tt class="py-string"> { end = dc.length; }</tt> </tt>
<a name="L1532"></a><tt class="py-lineno">1532</tt> <tt class="py-line"><tt class="py-string"> return unescape(dc.substring(begin + prefix.length, end));</tt> </tt>
<a name="L1533"></a><tt class="py-lineno">1533</tt> <tt class="py-line"><tt class="py-string"> }</tt> </tt>
<a name="L1534"></a><tt class="py-lineno">1534</tt> <tt class="py-line"><tt class="py-string"> '''</tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1535"></a><tt class="py-lineno">1535</tt> <tt class="py-line"> </tt>
<a name="L1536"></a><tt class="py-lineno">1536</tt> <tt class="py-line"> <tt class="py-comment">#: A javascript that is used to set the contents of two frames at</tt> </tt>
<a name="L1537"></a><tt class="py-lineno">1537</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: once. This is used by the project table-of-contents frame to</tt> </tt>
<a name="L1538"></a><tt class="py-lineno">1538</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: set both the module table-of-contents frame and the main frame</tt> </tt>
<a name="L1539"></a><tt class="py-lineno">1539</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: when the user clicks on a module.</tt> </tt>
<a name="L1540"></a><tt class="py-lineno">1540</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-509" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.SET_FRAME_JS" class="py-name" href="#" onclick="return doclink('link-509', 'SET_FRAME_JS', 'link-499');">SET_FRAME_JS</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'''</tt> </tt>
<a name="L1541"></a><tt class="py-lineno">1541</tt> <tt class="py-line"><tt class="py-string"> function setFrame(url1, url2) {</tt> </tt>
<a name="L1542"></a><tt class="py-lineno">1542</tt> <tt class="py-line"><tt class="py-string"> parent.frames[1].location.href = url1;</tt> </tt>
<a name="L1543"></a><tt class="py-lineno">1543</tt> <tt class="py-line"><tt class="py-string"> parent.frames[2].location.href = url2;</tt> </tt>
<a name="L1544"></a><tt class="py-lineno">1544</tt> <tt class="py-line"><tt class="py-string"> }</tt> </tt>
<a name="L1545"></a><tt class="py-lineno">1545</tt> <tt class="py-line"><tt class="py-string"> '''</tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1546"></a><tt class="py-lineno">1546</tt> <tt class="py-line"> </tt>
<a name="L1547"></a><tt class="py-lineno">1547</tt> <tt class="py-line"> <tt class="py-comment">#: A javascript that is used to hide private variables, unless</tt> </tt>
<a name="L1548"></a><tt class="py-lineno">1548</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: either: (a) the cookie says not to; or (b) we appear to be</tt> </tt>
<a name="L1549"></a><tt class="py-lineno">1549</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: linking to a private variable.</tt> </tt>
<a name="L1550"></a><tt class="py-lineno">1550</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-510" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.HIDE_PRIVATE_JS" class="py-name" href="#" onclick="return doclink('link-510', 'HIDE_PRIVATE_JS', 'link-500');">HIDE_PRIVATE_JS</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'''</tt> </tt>
<a name="L1551"></a><tt class="py-lineno">1551</tt> <tt class="py-line"><tt class="py-string"> function checkCookie() {</tt> </tt>
<a name="L1552"></a><tt class="py-lineno">1552</tt> <tt class="py-line"><tt class="py-string"> var cmd=getCookie("EpydocPrivate");</tt> </tt>
<a name="L1553"></a><tt class="py-lineno">1553</tt> <tt class="py-line"><tt class="py-string"> if (cmd && cmd.substr(0,4)!="show" && location.href.indexOf("#_") < 0)</tt> </tt>
<a name="L1554"></a><tt class="py-lineno">1554</tt> <tt class="py-line"><tt class="py-string"> toggle_private();</tt> </tt>
<a name="L1555"></a><tt class="py-lineno">1555</tt> <tt class="py-line"><tt class="py-string"> }</tt> </tt>
<a name="L1556"></a><tt class="py-lineno">1556</tt> <tt class="py-line"><tt class="py-string"> '''</tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1557"></a><tt class="py-lineno">1557</tt> <tt class="py-line"> </tt>
<a name="L1558"></a><tt class="py-lineno">1558</tt> <tt class="py-line"> <tt id="link-511" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.TOGGLE_CALLGRAPH_JS" class="py-name" href="#" onclick="return doclink('link-511', 'TOGGLE_CALLGRAPH_JS', 'link-501');">TOGGLE_CALLGRAPH_JS</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'''</tt> </tt>
<a name="L1559"></a><tt class="py-lineno">1559</tt> <tt class="py-line"><tt class="py-string"> function toggleCallGraph(id) {</tt> </tt>
<a name="L1560"></a><tt class="py-lineno">1560</tt> <tt class="py-line"><tt class="py-string"> var elt = document.getElementById(id);</tt> </tt>
<a name="L1561"></a><tt class="py-lineno">1561</tt> <tt class="py-line"><tt class="py-string"> if (elt.style.display == "none")</tt> </tt>
<a name="L1562"></a><tt class="py-lineno">1562</tt> <tt class="py-line"><tt class="py-string"> elt.style.display = "block";</tt> </tt>
<a name="L1563"></a><tt class="py-lineno">1563</tt> <tt class="py-line"><tt class="py-string"> else</tt> </tt>
<a name="L1564"></a><tt class="py-lineno">1564</tt> <tt class="py-line"><tt class="py-string"> elt.style.display = "none";</tt> </tt>
<a name="L1565"></a><tt class="py-lineno">1565</tt> <tt class="py-line"><tt class="py-string"> }</tt> </tt>
<a name="L1566"></a><tt class="py-lineno">1566</tt> <tt class="py-line"><tt class="py-string"> '''</tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1567"></a><tt class="py-lineno">1567</tt> <tt class="py-line"> </tt>
<a name="L1568"></a><tt class="py-lineno">1568</tt> <tt class="py-line"> <tt id="link-512" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.SHOW_PRIVATE_JS" class="py-name" href="#" onclick="return doclink('link-512', 'SHOW_PRIVATE_JS', 'link-497');">SHOW_PRIVATE_JS</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'''</tt> </tt>
<a name="L1569"></a><tt class="py-lineno">1569</tt> <tt class="py-line"><tt class="py-string"> function show_private() {</tt> </tt>
<a name="L1570"></a><tt class="py-lineno">1570</tt> <tt class="py-line"><tt class="py-string"> var elts = document.getElementsByTagName("a");</tt> </tt>
<a name="L1571"></a><tt class="py-lineno">1571</tt> <tt class="py-line"><tt class="py-string"> for(var i=0; i<elts.length; i++) {</tt> </tt>
<a name="L1572"></a><tt class="py-lineno">1572</tt> <tt class="py-line"><tt class="py-string"> if (elts[i].className == "privatelink") {</tt> </tt>
<a name="L1573"></a><tt class="py-lineno">1573</tt> <tt class="py-line"><tt class="py-string"> cmd = elts[i].innerHTML;</tt> </tt>
<a name="L1574"></a><tt class="py-lineno">1574</tt> <tt class="py-line"><tt class="py-string"> if (cmd && cmd.substr(0,4)=="show")</tt> </tt>
<a name="L1575"></a><tt class="py-lineno">1575</tt> <tt class="py-line"><tt class="py-string"> toggle_private();</tt> </tt>
<a name="L1576"></a><tt class="py-lineno">1576</tt> <tt class="py-line"><tt class="py-string"> }</tt> </tt>
<a name="L1577"></a><tt class="py-lineno">1577</tt> <tt class="py-line"><tt class="py-string"> }</tt> </tt>
<a name="L1578"></a><tt class="py-lineno">1578</tt> <tt class="py-line"><tt class="py-string"> }</tt> </tt>
<a name="L1579"></a><tt class="py-lineno">1579</tt> <tt class="py-line"><tt class="py-string"> '''</tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1580"></a><tt class="py-lineno">1580</tt> <tt class="py-line"> </tt>
<a name="L1581"></a><tt class="py-lineno">1581</tt> <tt class="py-line"> <tt id="link-513" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.GET_ANCHOR_JS" class="py-name" href="#" onclick="return doclink('link-513', 'GET_ANCHOR_JS', 'link-504');">GET_ANCHOR_JS</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'''</tt> </tt>
<a name="L1582"></a><tt class="py-lineno">1582</tt> <tt class="py-line"><tt class="py-string"> function get_anchor() {</tt> </tt>
<a name="L1583"></a><tt class="py-lineno">1583</tt> <tt class="py-line"><tt class="py-string"> var href = location.href;</tt> </tt>
<a name="L1584"></a><tt class="py-lineno">1584</tt> <tt class="py-line"><tt class="py-string"> var start = href.indexOf("#")+1;</tt> </tt>
<a name="L1585"></a><tt class="py-lineno">1585</tt> <tt class="py-line"><tt class="py-string"> if ((start != 0) && (start != href.length))</tt> </tt>
<a name="L1586"></a><tt class="py-lineno">1586</tt> <tt class="py-line"><tt class="py-string"> return href.substring(start, href.length);</tt> </tt>
<a name="L1587"></a><tt class="py-lineno">1587</tt> <tt class="py-line"><tt class="py-string"> }</tt> </tt>
<a name="L1588"></a><tt class="py-lineno">1588</tt> <tt class="py-line"><tt class="py-string"> '''</tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1589"></a><tt class="py-lineno">1589</tt> <tt class="py-line"> </tt>
<a name="L1590"></a><tt class="py-lineno">1590</tt> <tt class="py-line"> <tt class="py-comment">#: A javascript that is used to implement the auto-redirect page.</tt> </tt>
<a name="L1591"></a><tt class="py-lineno">1591</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: When the user visits <redirect.html#dotted.name>, they will</tt> </tt>
<a name="L1592"></a><tt class="py-lineno">1592</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: automatically get redirected to the page for the object with</tt> </tt>
<a name="L1593"></a><tt class="py-lineno">1593</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: the given fully-qualified dotted name. E.g., for epydoc,</tt> </tt>
<a name="L1594"></a><tt class="py-lineno">1594</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: <redirect.html#epydoc.apidoc.UNKNOWN> redirects the user to</tt> </tt>
<a name="L1595"></a><tt class="py-lineno">1595</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: <epydoc.apidoc-module.html#UNKNOWN>.</tt> </tt>
<a name="L1596"></a><tt class="py-lineno">1596</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-514" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.REDIRECT_URL_JS" class="py-name" href="#" onclick="return doclink('link-514', 'REDIRECT_URL_JS', 'link-505');">REDIRECT_URL_JS</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'''</tt> </tt>
<a name="L1597"></a><tt class="py-lineno">1597</tt> <tt class="py-line"><tt class="py-string"> function redirect_url(dottedName) {</tt> </tt>
<a name="L1598"></a><tt class="py-lineno">1598</tt> <tt class="py-line"><tt class="py-string"> // Scan through each element of the "pages" list, and check</tt> </tt>
<a name="L1599"></a><tt class="py-lineno">1599</tt> <tt class="py-line"><tt class="py-string"> // if "name" matches with any of them.</tt> </tt>
<a name="L1600"></a><tt class="py-lineno">1600</tt> <tt class="py-line"><tt class="py-string"> for (var i=0; i<pages.length; i++) {</tt> </tt>
<a name="L1601"></a><tt class="py-lineno">1601</tt> <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L1602"></a><tt class="py-lineno">1602</tt> <tt class="py-line"><tt class="py-string"> // Each page has the form "<pagename>-m" or "<pagename>-c";</tt> </tt>
<a name="L1603"></a><tt class="py-lineno">1603</tt> <tt class="py-line"><tt class="py-string"> // extract the <pagename> portion & compare it to dottedName.</tt> </tt>
<a name="L1604"></a><tt class="py-lineno">1604</tt> <tt class="py-line"><tt class="py-string"> var pagename = pages[i].substring(0, pages[i].length-2);</tt> </tt>
<a name="L1605"></a><tt class="py-lineno">1605</tt> <tt class="py-line"><tt class="py-string"> if (pagename == dottedName.substring(0,pagename.length)) {</tt> </tt>
<a name="L1606"></a><tt class="py-lineno">1606</tt> <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L1607"></a><tt class="py-lineno">1607</tt> <tt class="py-line"><tt class="py-string"> // We\'ve found a page that matches `dottedName`;</tt> </tt>
<a name="L1608"></a><tt class="py-lineno">1608</tt> <tt class="py-line"><tt class="py-string"> // construct its URL, using leftover `dottedName`</tt> </tt>
<a name="L1609"></a><tt class="py-lineno">1609</tt> <tt class="py-line"><tt class="py-string"> // content to form an anchor.</tt> </tt>
<a name="L1610"></a><tt class="py-lineno">1610</tt> <tt class="py-line"><tt class="py-string"> var pagetype = pages[i].charAt(pages[i].length-1);</tt> </tt>
<a name="L1611"></a><tt class="py-lineno">1611</tt> <tt class="py-line"><tt class="py-string"> var url = pagename + ((pagetype=="m")?"-module.html":</tt> </tt>
<a name="L1612"></a><tt class="py-lineno">1612</tt> <tt class="py-line"><tt class="py-string"> "-class.html");</tt> </tt>
<a name="L1613"></a><tt class="py-lineno">1613</tt> <tt class="py-line"><tt class="py-string"> if (dottedName.length > pagename.length)</tt> </tt>
<a name="L1614"></a><tt class="py-lineno">1614</tt> <tt class="py-line"><tt class="py-string"> url += "#" + dottedName.substring(pagename.length+1,</tt> </tt>
<a name="L1615"></a><tt class="py-lineno">1615</tt> <tt class="py-line"><tt class="py-string"> dottedName.length);</tt> </tt>
<a name="L1616"></a><tt class="py-lineno">1616</tt> <tt class="py-line"><tt class="py-string"> return url;</tt> </tt>
<a name="L1617"></a><tt class="py-lineno">1617</tt> <tt class="py-line"><tt class="py-string"> }</tt> </tt>
<a name="L1618"></a><tt class="py-lineno">1618</tt> <tt class="py-line"><tt class="py-string"> }</tt> </tt>
<a name="L1619"></a><tt class="py-lineno">1619</tt> <tt class="py-line"><tt class="py-string"> }</tt> </tt>
<a name="L1620"></a><tt class="py-lineno">1620</tt> <tt class="py-line"><tt class="py-string"> '''</tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1621"></a><tt class="py-lineno">1621</tt> <tt class="py-line"> </tt>
<a name="L1622"></a><tt class="py-lineno">1622</tt> <tt class="py-line"> </tt>
<a name="L1623"></a><tt class="py-lineno">1623</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1624"></a><tt class="py-lineno">1624</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ 2.10. Graphs</tt> </tt>
<a name="L1625"></a><tt class="py-lineno">1625</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1626"></a><tt class="py-lineno">1626</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="HTMLWriter.render_graph"></a><div id="HTMLWriter.render_graph-def"><a name="L1627"></a><tt class="py-lineno">1627</tt> <a class="py-toggle" href="#" id="HTMLWriter.render_graph-toggle" onclick="return toggle('HTMLWriter.render_graph');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#render_graph">render_graph</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">graph</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.render_graph-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.render_graph-expanded"><a name="L1628"></a><tt class="py-lineno">1628</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-515" class="py-name" targets="Method epydoc.markup.restructuredtext.dotgraph.graph()=epydoc.markup.restructuredtext.dotgraph-class.html#graph"><a title="epydoc.markup.restructuredtext.dotgraph.graph" class="py-name" href="#" onclick="return doclink('link-515', 'graph', 'link-515');">graph</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-string">''</tt> </tt>
<a name="L1629"></a><tt class="py-lineno">1629</tt> <tt class="py-line"> <tt id="link-516" class="py-name"><a title="epydoc.markup.restructuredtext.dotgraph.graph" class="py-name" href="#" onclick="return doclink('link-516', 'graph', 'link-515');">graph</a></tt><tt class="py-op">.</tt><tt class="py-name">caption</tt> <tt class="py-op">=</tt> <tt id="link-517" class="py-name"><a title="epydoc.markup.restructuredtext.dotgraph.graph" class="py-name" href="#" onclick="return doclink('link-517', 'graph', 'link-515');">graph</a></tt><tt class="py-op">.</tt><tt id="link-518" class="py-name"><a title="epydoc.docwriter.plaintext.PlaintextWriter.title" class="py-name" href="#" onclick="return doclink('link-518', 'title', 'link-347');">title</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L1630"></a><tt class="py-lineno">1630</tt> <tt class="py-line"> <tt class="py-name">image_url</tt> <tt class="py-op">=</tt> <tt class="py-string">'%s.gif'</tt> <tt class="py-op">%</tt> <tt id="link-519" class="py-name"><a title="epydoc.markup.restructuredtext.dotgraph.graph" class="py-name" href="#" onclick="return doclink('link-519', 'graph', 'link-515');">graph</a></tt><tt class="py-op">.</tt><tt class="py-name">uid</tt> </tt>
<a name="L1631"></a><tt class="py-lineno">1631</tt> <tt class="py-line"> <tt class="py-name">image_file</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-520" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-520', 'path', 'link-211');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_directory</tt><tt class="py-op">,</tt> <tt class="py-name">image_url</tt><tt class="py-op">)</tt> </tt>
<a name="L1632"></a><tt class="py-lineno">1632</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-521" class="py-name"><a title="epydoc.markup.restructuredtext.dotgraph.graph" class="py-name" href="#" onclick="return doclink('link-521', 'graph', 'link-515');">graph</a></tt><tt class="py-op">.</tt><tt id="link-522" class="py-name" targets="Method epydoc.docwriter.dotgraph.DotGraph.to_html()=epydoc.docwriter.dotgraph.DotGraph-class.html#to_html,Method epydoc.markup.ConcatenatedDocstring.to_html()=epydoc.markup.ConcatenatedDocstring-class.html#to_html,Method epydoc.markup.ParsedDocstring.to_html()=epydoc.markup.ParsedDocstring-class.html#to_html,Method epydoc.markup.epytext.ParsedEpytextDocstring.to_html()=epydoc.markup.epytext.ParsedEpytextDocstring-class.html#to_html,Method epydoc.markup.javadoc.ParsedJavadocDocstring.to_html()=epydoc.markup.javadoc.ParsedJavadocDocstring-class.html#to_html,Method epydoc.markup.plaintext.ParsedPlaintextDocstring.to_html()=epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#to_html,Method epydoc.markup.restructuredtext.ParsedRstDocstring.to_html()=epydoc.markup.restructuredtext.ParsedRstDocstring-class.html#to_html"><a title="epydoc.docwriter.dotgraph.DotGraph.to_html
epydoc.markup.ConcatenatedDocstring.to_html
epydoc.markup.ParsedDocstring.to_html
epydoc.markup.epytext.ParsedEpytextDocstring.to_html
epydoc.markup.javadoc.ParsedJavadocDocstring.to_html
epydoc.markup.plaintext.ParsedPlaintextDocstring.to_html
epydoc.markup.restructuredtext.ParsedRstDocstring.to_html" class="py-name" href="#" onclick="return doclink('link-522', 'to_html', 'link-522');">to_html</a></tt><tt class="py-op">(</tt><tt class="py-name">image_file</tt><tt class="py-op">,</tt> <tt class="py-name">image_url</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1633"></a><tt class="py-lineno">1633</tt> <tt class="py-line"> </tt>
<a name="L1634"></a><tt class="py-lineno">1634</tt> <tt class="py-line"> <tt id="link-523" class="py-name" targets="Variable epydoc.docwriter.html.HTMLWriter.RE_CALLGRAPH_ID=epydoc.docwriter.html.HTMLWriter-class.html#RE_CALLGRAPH_ID"><a title="epydoc.docwriter.html.HTMLWriter.RE_CALLGRAPH_ID" class="py-name" href="#" onclick="return doclink('link-523', 'RE_CALLGRAPH_ID', 'link-523');">RE_CALLGRAPH_ID</a></tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-string">r"""["'](.+-div)['"]"""</tt><tt class="py-op">)</tt> </tt>
<a name="L1635"></a><tt class="py-lineno">1635</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.render_callgraph"></a><div id="HTMLWriter.render_callgraph-def"><a name="L1636"></a><tt class="py-lineno">1636</tt> <a class="py-toggle" href="#" id="HTMLWriter.render_callgraph-toggle" onclick="return toggle('HTMLWriter.render_callgraph');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#render_callgraph">render_callgraph</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">callgraph</tt><tt class="py-op">,</tt> <tt class="py-param">token</tt><tt class="py-op">=</tt><tt class="py-string">""</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.render_callgraph-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.render_callgraph-expanded"><a name="L1637"></a><tt class="py-lineno">1637</tt> <tt class="py-line"> <tt class="py-docstring">"""Render the HTML chunk of a callgraph.</tt> </tt>
<a name="L1638"></a><tt class="py-lineno">1638</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1639"></a><tt class="py-lineno">1639</tt> <tt class="py-line"><tt class="py-docstring"> If C{callgraph} is a string, use the L{_callgraph_cache} to return</tt> </tt>
<a name="L1640"></a><tt class="py-lineno">1640</tt> <tt class="py-line"><tt class="py-docstring"> a pre-rendered HTML chunk. This mostly avoids to run C{dot} twice for</tt> </tt>
<a name="L1641"></a><tt class="py-lineno">1641</tt> <tt class="py-line"><tt class="py-docstring"> the same callgraph. Else, run the graph and store its HTML output in</tt> </tt>
<a name="L1642"></a><tt class="py-lineno">1642</tt> <tt class="py-line"><tt class="py-docstring"> the cache.</tt> </tt>
<a name="L1643"></a><tt class="py-lineno">1643</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1644"></a><tt class="py-lineno">1644</tt> <tt class="py-line"><tt class="py-docstring"> @param callgraph: The graph to render or its L{uid<DotGraph.uid>}.</tt> </tt>
<a name="L1645"></a><tt class="py-lineno">1645</tt> <tt class="py-line"><tt class="py-docstring"> @type callgraph: L{DotGraph} or C{str}</tt> </tt>
<a name="L1646"></a><tt class="py-lineno">1646</tt> <tt class="py-line"><tt class="py-docstring"> @param token: A string that can be used to make the C{<div>} id</tt> </tt>
<a name="L1647"></a><tt class="py-lineno">1647</tt> <tt class="py-line"><tt class="py-docstring"> unambiguous, if the callgraph is used more than once in a page.</tt> </tt>
<a name="L1648"></a><tt class="py-lineno">1648</tt> <tt class="py-line"><tt class="py-docstring"> @type token: C{str}</tt> </tt>
<a name="L1649"></a><tt class="py-lineno">1649</tt> <tt class="py-line"><tt class="py-docstring"> @return: The HTML representation of the graph.</tt> </tt>
<a name="L1650"></a><tt class="py-lineno">1650</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{str}</tt> </tt>
<a name="L1651"></a><tt class="py-lineno">1651</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1652"></a><tt class="py-lineno">1652</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">callgraph</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-string">""</tt> </tt>
<a name="L1653"></a><tt class="py-lineno">1653</tt> <tt class="py-line"> </tt>
<a name="L1654"></a><tt class="py-lineno">1654</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">callgraph</tt><tt class="py-op">,</tt> <tt class="py-name">basestring</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1655"></a><tt class="py-lineno">1655</tt> <tt class="py-line"> <tt class="py-name">uid</tt> <tt class="py-op">=</tt> <tt class="py-name">callgraph</tt> </tt>
<a name="L1656"></a><tt class="py-lineno">1656</tt> <tt class="py-line"> <tt class="py-name">rv</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_callgraph_cache</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-name">callgraph</tt><tt class="py-op">,</tt> <tt class="py-string">""</tt><tt class="py-op">)</tt> </tt>
<a name="L1657"></a><tt class="py-lineno">1657</tt> <tt class="py-line"> </tt>
<a name="L1658"></a><tt class="py-lineno">1658</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1659"></a><tt class="py-lineno">1659</tt> <tt class="py-line"> <tt class="py-name">uid</tt> <tt class="py-op">=</tt> <tt class="py-name">callgraph</tt><tt class="py-op">.</tt><tt class="py-name">uid</tt> </tt>
<a name="L1660"></a><tt class="py-lineno">1660</tt> <tt class="py-line"> <tt class="py-name">graph_html</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-524" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.render_graph" class="py-name" href="#" onclick="return doclink('link-524', 'render_graph', 'link-321');">render_graph</a></tt><tt class="py-op">(</tt><tt class="py-name">callgraph</tt><tt class="py-op">)</tt> </tt>
<a name="L1661"></a><tt class="py-lineno">1661</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">graph_html</tt> <tt class="py-op">==</tt> <tt class="py-string">''</tt><tt class="py-op">:</tt> </tt>
<a name="L1662"></a><tt class="py-lineno">1662</tt> <tt class="py-line"> <tt class="py-name">rv</tt> <tt class="py-op">=</tt> <tt class="py-string">""</tt> </tt>
<a name="L1663"></a><tt class="py-lineno">1663</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1664"></a><tt class="py-lineno">1664</tt> <tt class="py-line"> <tt class="py-name">rv</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">'<div style="display:none" id="%%s-div"><center>\n'</tt> </tt>
<a name="L1665"></a><tt class="py-lineno">1665</tt> <tt class="py-line"> <tt class="py-string">'<table border="0" cellpadding="0" cellspacing="0">\n'</tt> </tt>
<a name="L1666"></a><tt class="py-lineno">1666</tt> <tt class="py-line"> <tt class="py-string">' <tr><td>%s</td></tr>\n'</tt> </tt>
<a name="L1667"></a><tt class="py-lineno">1667</tt> <tt class="py-line"> <tt class="py-string">' <tr><th>Call Graph</th></tr>\n'</tt> </tt>
<a name="L1668"></a><tt class="py-lineno">1668</tt> <tt class="py-line"> <tt class="py-string">'</table><br />\n</center></div>\n'</tt> <tt class="py-op">%</tt> <tt class="py-name">graph_html</tt><tt class="py-op">)</tt> </tt>
<a name="L1669"></a><tt class="py-lineno">1669</tt> <tt class="py-line"> </tt>
<a name="L1670"></a><tt class="py-lineno">1670</tt> <tt class="py-line"> <tt class="py-comment"># Store in the cache the complete HTML chunk without the</tt> </tt>
<a name="L1671"></a><tt class="py-lineno">1671</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># div id, which may be made unambiguous by the token</tt> </tt>
<a name="L1672"></a><tt class="py-lineno">1672</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_callgraph_cache</tt><tt class="py-op">[</tt><tt class="py-name">uid</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">rv</tt> </tt>
<a name="L1673"></a><tt class="py-lineno">1673</tt> <tt class="py-line"> </tt>
<a name="L1674"></a><tt class="py-lineno">1674</tt> <tt class="py-line"> <tt class="py-comment"># Mangle with the graph</tt> </tt>
<a name="L1675"></a><tt class="py-lineno">1675</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">rv</tt><tt class="py-op">:</tt> <tt class="py-name">rv</tt> <tt class="py-op">=</tt> <tt class="py-name">rv</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">uid</tt> <tt class="py-op">+</tt> <tt class="py-name">token</tt><tt class="py-op">)</tt> </tt>
<a name="L1676"></a><tt class="py-lineno">1676</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">rv</tt> </tt>
</div><a name="L1677"></a><tt class="py-lineno">1677</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.callgraph_link"></a><div id="HTMLWriter.callgraph_link-def"><a name="L1678"></a><tt class="py-lineno">1678</tt> <a class="py-toggle" href="#" id="HTMLWriter.callgraph_link-toggle" onclick="return toggle('HTMLWriter.callgraph_link');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#callgraph_link">callgraph_link</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">callgraph</tt><tt class="py-op">,</tt> <tt class="py-param">token</tt><tt class="py-op">=</tt><tt class="py-string">""</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.callgraph_link-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.callgraph_link-expanded"><a name="L1679"></a><tt class="py-lineno">1679</tt> <tt class="py-line"> <tt class="py-docstring">"""Render the HTML chunk of a callgraph link.</tt> </tt>
<a name="L1680"></a><tt class="py-lineno">1680</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1681"></a><tt class="py-lineno">1681</tt> <tt class="py-line"><tt class="py-docstring"> The link can toggles the visibility of the callgraph rendered using</tt> </tt>
<a name="L1682"></a><tt class="py-lineno">1682</tt> <tt class="py-line"><tt class="py-docstring"> L{render_callgraph} with matching parameters.</tt> </tt>
<a name="L1683"></a><tt class="py-lineno">1683</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1684"></a><tt class="py-lineno">1684</tt> <tt class="py-line"><tt class="py-docstring"> @param callgraph: The graph to render or its L{uid<DotGraph.uid>}.</tt> </tt>
<a name="L1685"></a><tt class="py-lineno">1685</tt> <tt class="py-line"><tt class="py-docstring"> @type callgraph: L{DotGraph} or C{str}</tt> </tt>
<a name="L1686"></a><tt class="py-lineno">1686</tt> <tt class="py-line"><tt class="py-docstring"> @param token: A string that can be used to make the C{<div>} id</tt> </tt>
<a name="L1687"></a><tt class="py-lineno">1687</tt> <tt class="py-line"><tt class="py-docstring"> unambiguous, if the callgraph is used more than once in a page.</tt> </tt>
<a name="L1688"></a><tt class="py-lineno">1688</tt> <tt class="py-line"><tt class="py-docstring"> @type token: C{str}</tt> </tt>
<a name="L1689"></a><tt class="py-lineno">1689</tt> <tt class="py-line"><tt class="py-docstring"> @return: The HTML representation of the graph link.</tt> </tt>
<a name="L1690"></a><tt class="py-lineno">1690</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{str}</tt> </tt>
<a name="L1691"></a><tt class="py-lineno">1691</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1692"></a><tt class="py-lineno">1692</tt> <tt class="py-line"> <tt class="py-comment"># Use class=codelink, to match style w/ the source code link.</tt> </tt>
<a name="L1693"></a><tt class="py-lineno">1693</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">callgraph</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-string">''</tt> </tt>
<a name="L1694"></a><tt class="py-lineno">1694</tt> <tt class="py-line"> </tt>
<a name="L1695"></a><tt class="py-lineno">1695</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">callgraph</tt><tt class="py-op">,</tt> <tt class="py-name">basestring</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1696"></a><tt class="py-lineno">1696</tt> <tt class="py-line"> <tt class="py-name">uid</tt> <tt class="py-op">=</tt> <tt class="py-name">callgraph</tt> </tt>
<a name="L1697"></a><tt class="py-lineno">1697</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1698"></a><tt class="py-lineno">1698</tt> <tt class="py-line"> <tt class="py-name">uid</tt> <tt class="py-op">=</tt> <tt class="py-name">callgraph</tt><tt class="py-op">.</tt><tt class="py-name">uid</tt> </tt>
<a name="L1699"></a><tt class="py-lineno">1699</tt> <tt class="py-line"> </tt>
<a name="L1700"></a><tt class="py-lineno">1700</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-string">'<br /><span class="codelink"><a href="javascript:void(0);" '</tt> </tt>
<a name="L1701"></a><tt class="py-lineno">1701</tt> <tt class="py-line"> <tt class="py-string">'onclick="toggleCallGraph(\'%s-div\');return false;">'</tt> </tt>
<a name="L1702"></a><tt class="py-lineno">1702</tt> <tt class="py-line"> <tt class="py-string">'call&nbsp;graph</a></span>&nbsp;'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">uid</tt> <tt class="py-op">+</tt> <tt class="py-name">token</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1703"></a><tt class="py-lineno">1703</tt> <tt class="py-line"> </tt>
<a name="L1704"></a><tt class="py-lineno">1704</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1705"></a><tt class="py-lineno">1705</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ 2.11. Images</tt> </tt>
<a name="L1706"></a><tt class="py-lineno">1706</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1707"></a><tt class="py-lineno">1707</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L1708"></a><tt class="py-lineno">1708</tt> <tt class="py-line"> <tt id="link-525" class="py-name" targets="Variable epydoc.docwriter.html.HTMLWriter.IMAGES=epydoc.docwriter.html.HTMLWriter-class.html#IMAGES"><a title="epydoc.docwriter.html.HTMLWriter.IMAGES" class="py-name" href="#" onclick="return doclink('link-525', 'IMAGES', 'link-525');">IMAGES</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-string">'crarr.png'</tt><tt class="py-op">:</tt> <tt class="py-comment"># Carriage-return arrow, used for LINEWRAP.</tt> </tt>
<a name="L1709"></a><tt class="py-lineno">1709</tt> <tt class="py-line"> <tt class="py-string">'iVBORw0KGgoAAAANSUhEUgAAABEAAAAKCAMAAABlokWQAAAALHRFWHRD'</tt> </tt>
<a name="L1710"></a><tt class="py-lineno">1710</tt> <tt class="py-line"> <tt class="py-string">'cmVhdGlvbiBUaW1lAFR1\nZSAyMiBBdWcgMjAwNiAwMDo0MzoxMCAtMD'</tt> </tt>
<a name="L1711"></a><tt class="py-lineno">1711</tt> <tt class="py-line"> <tt class="py-string">'UwMGAMEFgAAAAHdElNRQfWCBYFASkQ033WAAAACXBI\nWXMAAB7CAAAe'</tt> </tt>
<a name="L1712"></a><tt class="py-lineno">1712</tt> <tt class="py-line"> <tt class="py-string">'wgFu0HU+AAAABGdBTUEAALGPC/xhBQAAAEVQTFRF////zcOw18/AgGY0'</tt> </tt>
<a name="L1713"></a><tt class="py-lineno">1713</tt> <tt class="py-line"> <tt class="py-string">'c1cg4dvQ\ninJEYEAAYkME3NXI6eTcloFYe2Asr5+AbE4Uh29A9fPwqp'</tt> </tt>
<a name="L1714"></a><tt class="py-lineno">1714</tt> <tt class="py-line"> <tt class="py-string">'l4ZEUI8O3onopk0Ma0lH5U1nfFdgAA\nAAF0Uk5TAEDm2GYAAABNSURB'</tt> </tt>
<a name="L1715"></a><tt class="py-lineno">1715</tt> <tt class="py-line"> <tt class="py-string">'VHjaY2BAAbzsvDAmK5oIlxgfioiwCAe7KJKIgKAQOzsLLwTwA0VY\n+d'</tt> </tt>
<a name="L1716"></a><tt class="py-lineno">1716</tt> <tt class="py-line"> <tt class="py-string">'iRAT8T0AxuIIMHqoaXCWIPGzsHJ6orGJiYWRjQASOcBQAocgMSPKMTIg'</tt> </tt>
<a name="L1717"></a><tt class="py-lineno">1717</tt> <tt class="py-line"> <tt class="py-string">'AAAABJRU5ErkJggg==\n'</tt><tt class="py-op">,</tt> </tt>
<a name="L1718"></a><tt class="py-lineno">1718</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt>
<a name="L1719"></a><tt class="py-lineno">1719</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.write_images"></a><div id="HTMLWriter.write_images-def"><a name="L1720"></a><tt class="py-lineno">1720</tt> <a class="py-toggle" href="#" id="HTMLWriter.write_images-toggle" onclick="return toggle('HTMLWriter.write_images');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write_images">write_images</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">directory</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write_images-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write_images-expanded"><a name="L1721"></a><tt class="py-lineno">1721</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt id="link-526" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-526', 'name', 'link-117');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">data</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-527" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.IMAGES" class="py-name" href="#" onclick="return doclink('link-527', 'IMAGES', 'link-525');">IMAGES</a></tt><tt class="py-op">.</tt><tt class="py-name">items</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1722"></a><tt class="py-lineno">1722</tt> <tt class="py-line"> <tt class="py-name">f</tt> <tt class="py-op">=</tt> <tt id="link-528" class="py-name"><a title="epydoc.gui.EpydocGUI.open" class="py-name" href="#" onclick="return doclink('link-528', 'open', 'link-214');">open</a></tt><tt class="py-op">(</tt><tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-529" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-529', 'path', 'link-211');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">directory</tt><tt class="py-op">,</tt> <tt id="link-530" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-530', 'name', 'link-117');">name</a></tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-string">'wb'</tt><tt class="py-op">)</tt> </tt>
<a name="L1723"></a><tt class="py-lineno">1723</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt id="link-531" class="py-name"><a title="epydoc.docintrospecter._DevNull.write
epydoc.docwriter.dotgraph.DotGraph.write
epydoc.docwriter.html.HTMLWriter.write
epydoc.docwriter.latex.LatexWriter.write
epydoc.docwriter.plaintext.PlaintextWriter.write" class="py-name" href="#" onclick="return doclink('link-531', 'write', 'link-216');">write</a></tt><tt class="py-op">(</tt><tt class="py-name">base64</tt><tt class="py-op">.</tt><tt class="py-name">decodestring</tt><tt class="py-op">(</tt><tt class="py-name">data</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1724"></a><tt class="py-lineno">1724</tt> <tt class="py-line"> <tt class="py-name">f</tt><tt class="py-op">.</tt><tt id="link-532" class="py-name"><a title="epydoc.cli.HTMLLogger.close
epydoc.docintrospecter._DevNull.close
epydoc.log.Logger.close
epydoc.log.close" class="py-name" href="#" onclick="return doclink('link-532', 'close', 'link-217');">close</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1725"></a><tt class="py-lineno">1725</tt> <tt class="py-line"> </tt>
<a name="L1726"></a><tt class="py-lineno">1726</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1727"></a><tt class="py-lineno">1727</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ 3.1. Page Header</tt> </tt>
<a name="L1728"></a><tt class="py-lineno">1728</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1729"></a><tt class="py-lineno">1729</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L1730"></a><tt class="py-lineno">1730</tt> <tt class="py-line"> <tt id="link-533" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_header
epydoc.docwriter.latex.LatexWriter.write_header" class="py-name" href="#" onclick="return doclink('link-533', 'write_header', 'link-222');">write_header</a></tt> <tt class="py-op">=</tt> <tt id="link-534" class="py-name"><a title="epydoc.docwriter.html.compile_template" class="py-name" href="#" onclick="return doclink('link-534', 'compile_template', 'link-427');">compile_template</a></tt><tt class="py-op">(</tt> </tt>
<a name="L1731"></a><tt class="py-lineno">1731</tt> <tt class="py-line"> <tt class="py-string">"""</tt> </tt>
<a name="L1732"></a><tt class="py-lineno">1732</tt> <tt class="py-line"><tt class="py-string"> write_header(self, out, title)</tt> </tt>
<a name="L1733"></a><tt class="py-lineno">1733</tt> <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L1734"></a><tt class="py-lineno">1734</tt> <tt class="py-line"><tt class="py-string"> Generate HTML code for the standard page header, and write it</tt> </tt>
<a name="L1735"></a><tt class="py-lineno">1735</tt> <tt class="py-line"><tt class="py-string"> to C{out}. C{title} is a string containing the page title.</tt> </tt>
<a name="L1736"></a><tt class="py-lineno">1736</tt> <tt class="py-line"><tt class="py-string"> It should be appropriately escaped/encoded.</tt> </tt>
<a name="L1737"></a><tt class="py-lineno">1737</tt> <tt class="py-line"><tt class="py-string"> """</tt><tt class="py-op">,</tt> </tt>
<a name="L1738"></a><tt class="py-lineno">1738</tt> <tt class="py-line"> <tt class="py-comment"># /------------------------- Template -------------------------\</tt> </tt>
<a name="L1739"></a><tt class="py-lineno">1739</tt> <tt class="py-line"> <tt class="py-string">'''</tt> </tt>
<a name="L1740"></a><tt class="py-lineno">1740</tt> <tt class="py-line"><tt class="py-string"> <?xml version="1.0" encoding="ascii"?></tt> </tt>
<a name="L1741"></a><tt class="py-lineno">1741</tt> <tt class="py-line"><tt class="py-string"> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"</tt> </tt>
<a name="L1742"></a><tt class="py-lineno">1742</tt> <tt class="py-line"><tt class="py-string"> "DTD/xhtml1-transitional.dtd"></tt> </tt>
<a name="L1743"></a><tt class="py-lineno">1743</tt> <tt class="py-line"><tt class="py-string"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"></tt> </tt>
<a name="L1744"></a><tt class="py-lineno">1744</tt> <tt class="py-line"><tt class="py-string"> <head></tt> </tt>
<a name="L1745"></a><tt class="py-lineno">1745</tt> <tt class="py-line"><tt class="py-string"> <title>$title$</title></tt> </tt>
<a name="L1746"></a><tt class="py-lineno">1746</tt> <tt class="py-line"><tt class="py-string"> <link rel="stylesheet" href="epydoc.css" type="text/css" /></tt> </tt>
<a name="L1747"></a><tt class="py-lineno">1747</tt> <tt class="py-line"><tt class="py-string"> <script type="text/javascript" src="epydoc.js"></script></tt> </tt>
<a name="L1748"></a><tt class="py-lineno">1748</tt> <tt class="py-line"><tt class="py-string"> </head></tt> </tt>
<a name="L1749"></a><tt class="py-lineno">1749</tt> <tt class="py-line"><tt class="py-string"> </tt> </tt>
<a name="L1750"></a><tt class="py-lineno">1750</tt> <tt class="py-line"><tt class="py-string"> <body bgcolor="white" text="black" link="blue" vlink="#204080"</tt> </tt>
<a name="L1751"></a><tt class="py-lineno">1751</tt> <tt class="py-line"><tt class="py-string"> alink="#204080"></tt> </tt>
<a name="L1752"></a><tt class="py-lineno">1752</tt> <tt class="py-line"><tt class="py-string"> '''</tt><tt class="py-op">)</tt> </tt>
<a name="L1753"></a><tt class="py-lineno">1753</tt> <tt class="py-line"> <tt class="py-comment"># \------------------------------------------------------------/</tt> </tt>
<a name="L1754"></a><tt class="py-lineno">1754</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L1755"></a><tt class="py-lineno">1755</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1756"></a><tt class="py-lineno">1756</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ 3.2. Page Footer</tt> </tt>
<a name="L1757"></a><tt class="py-lineno">1757</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1758"></a><tt class="py-lineno">1758</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L1759"></a><tt class="py-lineno">1759</tt> <tt class="py-line"> <tt id="link-535" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_footer" class="py-name" href="#" onclick="return doclink('link-535', 'write_footer', 'link-244');">write_footer</a></tt> <tt class="py-op">=</tt> <tt id="link-536" class="py-name"><a title="epydoc.docwriter.html.compile_template" class="py-name" href="#" onclick="return doclink('link-536', 'compile_template', 'link-427');">compile_template</a></tt><tt class="py-op">(</tt> </tt>
<a name="L1760"></a><tt class="py-lineno">1760</tt> <tt class="py-line"> <tt class="py-string">"""</tt> </tt>
<a name="L1761"></a><tt class="py-lineno">1761</tt> <tt class="py-line"><tt class="py-string"> write_footer(self, out, short=False)</tt> </tt>
<a name="L1762"></a><tt class="py-lineno">1762</tt> <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L1763"></a><tt class="py-lineno">1763</tt> <tt class="py-line"><tt class="py-string"> Generate HTML code for the standard page footer, and write it</tt> </tt>
<a name="L1764"></a><tt class="py-lineno">1764</tt> <tt class="py-line"><tt class="py-string"> to C{out}.</tt> </tt>
<a name="L1765"></a><tt class="py-lineno">1765</tt> <tt class="py-line"><tt class="py-string"> """</tt><tt class="py-op">,</tt> </tt>
<a name="L1766"></a><tt class="py-lineno">1766</tt> <tt class="py-line"> <tt class="py-comment"># /------------------------- Template -------------------------\</tt> </tt>
<a name="L1767"></a><tt class="py-lineno">1767</tt> <tt class="py-line"> <tt class="py-string">'''</tt> </tt>
<a name="L1768"></a><tt class="py-lineno">1768</tt> <tt class="py-line"><tt class="py-string"> >>> if not short:</tt> </tt>
<a name="L1769"></a><tt class="py-lineno">1769</tt> <tt class="py-line"><tt class="py-string"> <table border="0" cellpadding="0" cellspacing="0" width="100%%"></tt> </tt>
<a name="L1770"></a><tt class="py-lineno">1770</tt> <tt class="py-line"><tt class="py-string"> <tr></tt> </tt>
<a name="L1771"></a><tt class="py-lineno">1771</tt> <tt class="py-line"><tt class="py-string"> <td align="left" class="footer"></tt> </tt>
<a name="L1772"></a><tt class="py-lineno">1772</tt> <tt class="py-line"><tt class="py-string"> >>> if self._include_log:</tt> </tt>
<a name="L1773"></a><tt class="py-lineno">1773</tt> <tt class="py-line"><tt class="py-string"> <a href="epydoc-log.html">Generated by Epydoc</tt> </tt>
<a name="L1774"></a><tt class="py-lineno">1774</tt> <tt class="py-line"><tt class="py-string"> $epydoc.__version__$ on $time.asctime()$</a></tt> </tt>
<a name="L1775"></a><tt class="py-lineno">1775</tt> <tt class="py-line"><tt class="py-string"> >>> else:</tt> </tt>
<a name="L1776"></a><tt class="py-lineno">1776</tt> <tt class="py-line"><tt class="py-string"> Generated by Epydoc $epydoc.__version__$ on $time.asctime()$</tt> </tt>
<a name="L1777"></a><tt class="py-lineno">1777</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L1778"></a><tt class="py-lineno">1778</tt> <tt class="py-line"><tt class="py-string"> </td></tt> </tt>
<a name="L1779"></a><tt class="py-lineno">1779</tt> <tt class="py-line"><tt class="py-string"> <td align="right" class="footer"></tt> </tt>
<a name="L1780"></a><tt class="py-lineno">1780</tt> <tt class="py-line"><tt class="py-string"> <a target="mainFrame" href="http://epydoc.sourceforge.net"</tt> </tt>
<a name="L1781"></a><tt class="py-lineno">1781</tt> <tt class="py-line"><tt class="py-string"> >http://epydoc.sourceforge.net</a></tt> </tt>
<a name="L1782"></a><tt class="py-lineno">1782</tt> <tt class="py-line"><tt class="py-string"> </td></tt> </tt>
<a name="L1783"></a><tt class="py-lineno">1783</tt> <tt class="py-line"><tt class="py-string"> </tr></tt> </tt>
<a name="L1784"></a><tt class="py-lineno">1784</tt> <tt class="py-line"><tt class="py-string"> </table></tt> </tt>
<a name="L1785"></a><tt class="py-lineno">1785</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L1786"></a><tt class="py-lineno">1786</tt> <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L1787"></a><tt class="py-lineno">1787</tt> <tt class="py-line"><tt class="py-string"> <script type="text/javascript"></tt> </tt>
<a name="L1788"></a><tt class="py-lineno">1788</tt> <tt class="py-line"><tt class="py-string"> <!--</tt> </tt>
<a name="L1789"></a><tt class="py-lineno">1789</tt> <tt class="py-line"><tt class="py-string"> // Private objects are initially displayed (because if</tt> </tt>
<a name="L1790"></a><tt class="py-lineno">1790</tt> <tt class="py-line"><tt class="py-string"> // javascript is turned off then we want them to be</tt> </tt>
<a name="L1791"></a><tt class="py-lineno">1791</tt> <tt class="py-line"><tt class="py-string"> // visible); but by default, we want to hide them. So hide</tt> </tt>
<a name="L1792"></a><tt class="py-lineno">1792</tt> <tt class="py-line"><tt class="py-string"> // them unless we have a cookie that says to show them.</tt> </tt>
<a name="L1793"></a><tt class="py-lineno">1793</tt> <tt class="py-line"><tt class="py-string"> checkCookie();</tt> </tt>
<a name="L1794"></a><tt class="py-lineno">1794</tt> <tt class="py-line"><tt class="py-string"> // --></tt> </tt>
<a name="L1795"></a><tt class="py-lineno">1795</tt> <tt class="py-line"><tt class="py-string"> </script></tt> </tt>
<a name="L1796"></a><tt class="py-lineno">1796</tt> <tt class="py-line"><tt class="py-string"> </body></tt> </tt>
<a name="L1797"></a><tt class="py-lineno">1797</tt> <tt class="py-line"><tt class="py-string"> </html></tt> </tt>
<a name="L1798"></a><tt class="py-lineno">1798</tt> <tt class="py-line"><tt class="py-string"> '''</tt><tt class="py-op">)</tt> </tt>
<a name="L1799"></a><tt class="py-lineno">1799</tt> <tt class="py-line"> <tt class="py-comment"># \------------------------------------------------------------/</tt> </tt>
<a name="L1800"></a><tt class="py-lineno">1800</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L1801"></a><tt class="py-lineno">1801</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1802"></a><tt class="py-lineno">1802</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ 3.3. Navigation Bar</tt> </tt>
<a name="L1803"></a><tt class="py-lineno">1803</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1804"></a><tt class="py-lineno">1804</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L1805"></a><tt class="py-lineno">1805</tt> <tt class="py-line"> <tt id="link-537" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_navbar" class="py-name" href="#" onclick="return doclink('link-537', 'write_navbar', 'link-223');">write_navbar</a></tt> <tt class="py-op">=</tt> <tt id="link-538" class="py-name"><a title="epydoc.docwriter.html.compile_template" class="py-name" href="#" onclick="return doclink('link-538', 'compile_template', 'link-427');">compile_template</a></tt><tt class="py-op">(</tt> </tt>
<a name="L1806"></a><tt class="py-lineno">1806</tt> <tt class="py-line"> <tt class="py-string">"""</tt> </tt>
<a name="L1807"></a><tt class="py-lineno">1807</tt> <tt class="py-line"><tt class="py-string"> write_navbar(self, out, context)</tt> </tt>
<a name="L1808"></a><tt class="py-lineno">1808</tt> <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L1809"></a><tt class="py-lineno">1809</tt> <tt class="py-line"><tt class="py-string"> Generate HTML code for the navigation bar, and write it to</tt> </tt>
<a name="L1810"></a><tt class="py-lineno">1810</tt> <tt class="py-line"><tt class="py-string"> C{out}. The navigation bar typically looks like::</tt> </tt>
<a name="L1811"></a><tt class="py-lineno">1811</tt> <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L1812"></a><tt class="py-lineno">1812</tt> <tt class="py-line"><tt class="py-string"> [ Home Trees Index Help Project ]</tt> </tt>
<a name="L1813"></a><tt class="py-lineno">1813</tt> <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L1814"></a><tt class="py-lineno">1814</tt> <tt class="py-line"><tt class="py-string"> @param context: A value indicating what page we're generating</tt> </tt>
<a name="L1815"></a><tt class="py-lineno">1815</tt> <tt class="py-line"><tt class="py-string"> a navigation bar for. If we're generating an API</tt> </tt>
<a name="L1816"></a><tt class="py-lineno">1816</tt> <tt class="py-line"><tt class="py-string"> documentation page for an object, then C{context} is a</tt> </tt>
<a name="L1817"></a><tt class="py-lineno">1817</tt> <tt class="py-line"><tt class="py-string"> L{ValueDoc} containing the documentation for that object;</tt> </tt>
<a name="L1818"></a><tt class="py-lineno">1818</tt> <tt class="py-line"><tt class="py-string"> otherwise, C{context} is a string name for the page. The</tt> </tt>
<a name="L1819"></a><tt class="py-lineno">1819</tt> <tt class="py-line"><tt class="py-string"> following string names are recognized: C{'tree'}, C{'index'},</tt> </tt>
<a name="L1820"></a><tt class="py-lineno">1820</tt> <tt class="py-line"><tt class="py-string"> and C{'help'}.</tt> </tt>
<a name="L1821"></a><tt class="py-lineno">1821</tt> <tt class="py-line"><tt class="py-string"> """</tt><tt class="py-op">,</tt> </tt>
<a name="L1822"></a><tt class="py-lineno">1822</tt> <tt class="py-line"> <tt class="py-comment"># /------------------------- Template -------------------------\</tt> </tt>
<a name="L1823"></a><tt class="py-lineno">1823</tt> <tt class="py-line"> <tt class="py-string">'''</tt> </tt>
<a name="L1824"></a><tt class="py-lineno">1824</tt> <tt class="py-line"><tt class="py-string"> <!-- ==================== NAVIGATION BAR ==================== --></tt> </tt>
<a name="L1825"></a><tt class="py-lineno">1825</tt> <tt class="py-line"><tt class="py-string"> <table class="navbar" border="0" width="100%" cellpadding="0"</tt> </tt>
<a name="L1826"></a><tt class="py-lineno">1826</tt> <tt class="py-line"><tt class="py-string"> bgcolor="#a0c0ff" cellspacing="0"></tt> </tt>
<a name="L1827"></a><tt class="py-lineno">1827</tt> <tt class="py-line"><tt class="py-string"> <tr valign="middle"></tt> </tt>
<a name="L1828"></a><tt class="py-lineno">1828</tt> <tt class="py-line"><tt class="py-string"> >>> if self._top_page_url not in (self._trees_url, "identifier-index.html", "help.html"):</tt> </tt>
<a name="L1829"></a><tt class="py-lineno">1829</tt> <tt class="py-line"><tt class="py-string"> <!-- Home link --></tt> </tt>
<a name="L1830"></a><tt class="py-lineno">1830</tt> <tt class="py-line"><tt class="py-string"> >>> if (isinstance(context, ValueDoc) and</tt> </tt>
<a name="L1831"></a><tt class="py-lineno">1831</tt> <tt class="py-line"><tt class="py-string"> >>> self._top_page_url == self.url(context.canonical_name)):</tt> </tt>
<a name="L1832"></a><tt class="py-lineno">1832</tt> <tt class="py-line"><tt class="py-string"> <th bgcolor="#70b0f0" class="navbar-select"</tt> </tt>
<a name="L1833"></a><tt class="py-lineno">1833</tt> <tt class="py-line"><tt class="py-string"> >&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th></tt> </tt>
<a name="L1834"></a><tt class="py-lineno">1834</tt> <tt class="py-line"><tt class="py-string"> >>> else:</tt> </tt>
<a name="L1835"></a><tt class="py-lineno">1835</tt> <tt class="py-line"><tt class="py-string"> <th>&nbsp;&nbsp;&nbsp;<a</tt> </tt>
<a name="L1836"></a><tt class="py-lineno">1836</tt> <tt class="py-line"><tt class="py-string"> href="$self._top_page_url$">Home</a>&nbsp;&nbsp;&nbsp;</th></tt> </tt>
<a name="L1837"></a><tt class="py-lineno">1837</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L1838"></a><tt class="py-lineno">1838</tt> <tt class="py-line"><tt class="py-string"> </tt> </tt>
<a name="L1839"></a><tt class="py-lineno">1839</tt> <tt class="py-line"><tt class="py-string"> <!-- Tree link --></tt> </tt>
<a name="L1840"></a><tt class="py-lineno">1840</tt> <tt class="py-line"><tt class="py-string"> >>> if context == "trees":</tt> </tt>
<a name="L1841"></a><tt class="py-lineno">1841</tt> <tt class="py-line"><tt class="py-string"> <th bgcolor="#70b0f0" class="navbar-select"</tt> </tt>
<a name="L1842"></a><tt class="py-lineno">1842</tt> <tt class="py-line"><tt class="py-string"> >&nbsp;&nbsp;&nbsp;Trees&nbsp;&nbsp;&nbsp;</th></tt> </tt>
<a name="L1843"></a><tt class="py-lineno">1843</tt> <tt class="py-line"><tt class="py-string"> >>> else:</tt> </tt>
<a name="L1844"></a><tt class="py-lineno">1844</tt> <tt class="py-line"><tt class="py-string"> <th>&nbsp;&nbsp;&nbsp;<a</tt> </tt>
<a name="L1845"></a><tt class="py-lineno">1845</tt> <tt class="py-line"><tt class="py-string"> href="$self._trees_url$">Trees</a>&nbsp;&nbsp;&nbsp;</th></tt> </tt>
<a name="L1846"></a><tt class="py-lineno">1846</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L1847"></a><tt class="py-lineno">1847</tt> <tt class="py-line"><tt class="py-string"> </tt> </tt>
<a name="L1848"></a><tt class="py-lineno">1848</tt> <tt class="py-line"><tt class="py-string"> <!-- Index link --></tt> </tt>
<a name="L1849"></a><tt class="py-lineno">1849</tt> <tt class="py-line"><tt class="py-string"> >>> if context == "indices":</tt> </tt>
<a name="L1850"></a><tt class="py-lineno">1850</tt> <tt class="py-line"><tt class="py-string"> <th bgcolor="#70b0f0" class="navbar-select"</tt> </tt>
<a name="L1851"></a><tt class="py-lineno">1851</tt> <tt class="py-line"><tt class="py-string"> >&nbsp;&nbsp;&nbsp;Indices&nbsp;&nbsp;&nbsp;</th></tt> </tt>
<a name="L1852"></a><tt class="py-lineno">1852</tt> <tt class="py-line"><tt class="py-string"> >>> else:</tt> </tt>
<a name="L1853"></a><tt class="py-lineno">1853</tt> <tt class="py-line"><tt class="py-string"> <th>&nbsp;&nbsp;&nbsp;<a</tt> </tt>
<a name="L1854"></a><tt class="py-lineno">1854</tt> <tt class="py-line"><tt class="py-string"> href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th></tt> </tt>
<a name="L1855"></a><tt class="py-lineno">1855</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L1856"></a><tt class="py-lineno">1856</tt> <tt class="py-line"><tt class="py-string"> </tt> </tt>
<a name="L1857"></a><tt class="py-lineno">1857</tt> <tt class="py-line"><tt class="py-string"> <!-- Help link --></tt> </tt>
<a name="L1858"></a><tt class="py-lineno">1858</tt> <tt class="py-line"><tt class="py-string"> >>> if context == "help":</tt> </tt>
<a name="L1859"></a><tt class="py-lineno">1859</tt> <tt class="py-line"><tt class="py-string"> <th bgcolor="#70b0f0" class="navbar-select"</tt> </tt>
<a name="L1860"></a><tt class="py-lineno">1860</tt> <tt class="py-line"><tt class="py-string"> >&nbsp;&nbsp;&nbsp;Help&nbsp;&nbsp;&nbsp;</th></tt> </tt>
<a name="L1861"></a><tt class="py-lineno">1861</tt> <tt class="py-line"><tt class="py-string"> >>> else:</tt> </tt>
<a name="L1862"></a><tt class="py-lineno">1862</tt> <tt class="py-line"><tt class="py-string"> <th>&nbsp;&nbsp;&nbsp;<a</tt> </tt>
<a name="L1863"></a><tt class="py-lineno">1863</tt> <tt class="py-line"><tt class="py-string"> href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th></tt> </tt>
<a name="L1864"></a><tt class="py-lineno">1864</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L1865"></a><tt class="py-lineno">1865</tt> <tt class="py-line"><tt class="py-string"> </tt> </tt>
<a name="L1866"></a><tt class="py-lineno">1866</tt> <tt class="py-line"><tt class="py-string"> >>> if self._prj_link:</tt> </tt>
<a name="L1867"></a><tt class="py-lineno">1867</tt> <tt class="py-line"><tt class="py-string"> <!-- Project homepage --></tt> </tt>
<a name="L1868"></a><tt class="py-lineno">1868</tt> <tt class="py-line"><tt class="py-string"> <th class="navbar" align="right" width="100%"></tt> </tt>
<a name="L1869"></a><tt class="py-lineno">1869</tt> <tt class="py-line"><tt class="py-string"> <table border="0" cellpadding="0" cellspacing="0"></tt> </tt>
<a name="L1870"></a><tt class="py-lineno">1870</tt> <tt class="py-line"><tt class="py-string"> <tr><th class="navbar" align="center"</tt> </tt>
<a name="L1871"></a><tt class="py-lineno">1871</tt> <tt class="py-line"><tt class="py-string"> >$self._prj_link.strip()$</th></tt> </tt>
<a name="L1872"></a><tt class="py-lineno">1872</tt> <tt class="py-line"><tt class="py-string"> </tr></table></th></tt> </tt>
<a name="L1873"></a><tt class="py-lineno">1873</tt> <tt class="py-line"><tt class="py-string"> >>> else:</tt> </tt>
<a name="L1874"></a><tt class="py-lineno">1874</tt> <tt class="py-line"><tt class="py-string"> <th class="navbar" width="100%"></th></tt> </tt>
<a name="L1875"></a><tt class="py-lineno">1875</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L1876"></a><tt class="py-lineno">1876</tt> <tt class="py-line"><tt class="py-string"> </tr></tt> </tt>
<a name="L1877"></a><tt class="py-lineno">1877</tt> <tt class="py-line"><tt class="py-string"> </table></tt> </tt>
<a name="L1878"></a><tt class="py-lineno">1878</tt> <tt class="py-line"><tt class="py-string"> '''</tt><tt class="py-op">)</tt> </tt>
<a name="L1879"></a><tt class="py-lineno">1879</tt> <tt class="py-line"> <tt class="py-comment"># \------------------------------------------------------------/</tt> </tt>
<a name="L1880"></a><tt class="py-lineno">1880</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L1881"></a><tt class="py-lineno">1881</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1882"></a><tt class="py-lineno">1882</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ 3.4. Breadcrumbs</tt> </tt>
<a name="L1883"></a><tt class="py-lineno">1883</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1884"></a><tt class="py-lineno">1884</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L1885"></a><tt class="py-lineno">1885</tt> <tt class="py-line"> <tt id="link-539" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_breadcrumbs" class="py-name" href="#" onclick="return doclink('link-539', 'write_breadcrumbs', 'link-224');">write_breadcrumbs</a></tt> <tt class="py-op">=</tt> <tt id="link-540" class="py-name"><a title="epydoc.docwriter.html.compile_template" class="py-name" href="#" onclick="return doclink('link-540', 'compile_template', 'link-427');">compile_template</a></tt><tt class="py-op">(</tt> </tt>
<a name="L1886"></a><tt class="py-lineno">1886</tt> <tt class="py-line"> <tt class="py-string">"""</tt> </tt>
<a name="L1887"></a><tt class="py-lineno">1887</tt> <tt class="py-line"><tt class="py-string"> write_breadcrumbs(self, out, context, context_url)</tt> </tt>
<a name="L1888"></a><tt class="py-lineno">1888</tt> <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L1889"></a><tt class="py-lineno">1889</tt> <tt class="py-line"><tt class="py-string"> Generate HTML for the breadcrumbs line, and write it to</tt> </tt>
<a name="L1890"></a><tt class="py-lineno">1890</tt> <tt class="py-line"><tt class="py-string"> C{out}. The breadcrumbs line is an invisible table with a</tt> </tt>
<a name="L1891"></a><tt class="py-lineno">1891</tt> <tt class="py-line"><tt class="py-string"> list of pointers to the current object's ancestors on the</tt> </tt>
<a name="L1892"></a><tt class="py-lineno">1892</tt> <tt class="py-line"><tt class="py-string"> left; and the show/hide private selector and the</tt> </tt>
<a name="L1893"></a><tt class="py-lineno">1893</tt> <tt class="py-line"><tt class="py-string"> frames/noframes selector on the right.</tt> </tt>
<a name="L1894"></a><tt class="py-lineno">1894</tt> <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L1895"></a><tt class="py-lineno">1895</tt> <tt class="py-line"><tt class="py-string"> @param context: The API documentation for the object whose</tt> </tt>
<a name="L1896"></a><tt class="py-lineno">1896</tt> <tt class="py-line"><tt class="py-string"> breadcrumbs we should generate.</tt> </tt>
<a name="L1897"></a><tt class="py-lineno">1897</tt> <tt class="py-line"><tt class="py-string"> @type context: L{ValueDoc}</tt> </tt>
<a name="L1898"></a><tt class="py-lineno">1898</tt> <tt class="py-line"><tt class="py-string"> """</tt><tt class="py-op">,</tt> </tt>
<a name="L1899"></a><tt class="py-lineno">1899</tt> <tt class="py-line"> <tt class="py-comment"># /------------------------- Template -------------------------\</tt> </tt>
<a name="L1900"></a><tt class="py-lineno">1900</tt> <tt class="py-line"> <tt class="py-string">'''</tt> </tt>
<a name="L1901"></a><tt class="py-lineno">1901</tt> <tt class="py-line"><tt class="py-string"> <table width="100%" cellpadding="0" cellspacing="0"></tt> </tt>
<a name="L1902"></a><tt class="py-lineno">1902</tt> <tt class="py-line"><tt class="py-string"> <tr valign="top"></tt> </tt>
<a name="L1903"></a><tt class="py-lineno">1903</tt> <tt class="py-line"><tt class="py-string"> >>> if isinstance(context, APIDoc):</tt> </tt>
<a name="L1904"></a><tt class="py-lineno">1904</tt> <tt class="py-line"><tt class="py-string"> <td width="100%"></tt> </tt>
<a name="L1905"></a><tt class="py-lineno">1905</tt> <tt class="py-line"><tt class="py-string"> <span class="breadcrumbs"></tt> </tt>
<a name="L1906"></a><tt class="py-lineno">1906</tt> <tt class="py-line"><tt class="py-string"> >>> crumbs = self.breadcrumbs(context)</tt> </tt>
<a name="L1907"></a><tt class="py-lineno">1907</tt> <tt class="py-line"><tt class="py-string"> >>> for crumb in crumbs[:-1]:</tt> </tt>
<a name="L1908"></a><tt class="py-lineno">1908</tt> <tt class="py-line"><tt class="py-string"> $crumb$ ::</tt> </tt>
<a name="L1909"></a><tt class="py-lineno">1909</tt> <tt class="py-line"><tt class="py-string"> >>> #endfor</tt> </tt>
<a name="L1910"></a><tt class="py-lineno">1910</tt> <tt class="py-line"><tt class="py-string"> $crumbs[-1]$</tt> </tt>
<a name="L1911"></a><tt class="py-lineno">1911</tt> <tt class="py-line"><tt class="py-string"> </span></tt> </tt>
<a name="L1912"></a><tt class="py-lineno">1912</tt> <tt class="py-line"><tt class="py-string"> </td></tt> </tt>
<a name="L1913"></a><tt class="py-lineno">1913</tt> <tt class="py-line"><tt class="py-string"> >>> else:</tt> </tt>
<a name="L1914"></a><tt class="py-lineno">1914</tt> <tt class="py-line"><tt class="py-string"> <td width="100%">&nbsp;</td></tt> </tt>
<a name="L1915"></a><tt class="py-lineno">1915</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L1916"></a><tt class="py-lineno">1916</tt> <tt class="py-line"><tt class="py-string"> <td></tt> </tt>
<a name="L1917"></a><tt class="py-lineno">1917</tt> <tt class="py-line"><tt class="py-string"> <table cellpadding="0" cellspacing="0"></tt> </tt>
<a name="L1918"></a><tt class="py-lineno">1918</tt> <tt class="py-line"><tt class="py-string"> <!-- hide/show private --></tt> </tt>
<a name="L1919"></a><tt class="py-lineno">1919</tt> <tt class="py-line"><tt class="py-string"> >>> if self._show_private:</tt> </tt>
<a name="L1920"></a><tt class="py-lineno">1920</tt> <tt class="py-line"><tt class="py-string"> <tr><td align="right">$self.PRIVATE_LINK$</td></tr></tt> </tt>
<a name="L1921"></a><tt class="py-lineno">1921</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L1922"></a><tt class="py-lineno">1922</tt> <tt class="py-line"><tt class="py-string"> >>> if self._frames_index:</tt> </tt>
<a name="L1923"></a><tt class="py-lineno">1923</tt> <tt class="py-line"><tt class="py-string"> <tr><td align="right"><span class="options"</tt> </tt>
<a name="L1924"></a><tt class="py-lineno">1924</tt> <tt class="py-line"><tt class="py-string"> >[<a href="frames.html" target="_top">frames</a</tt> </tt>
<a name="L1925"></a><tt class="py-lineno">1925</tt> <tt class="py-line"><tt class="py-string"> >]&nbsp;|&nbsp;<a href="$context_url$"</tt> </tt>
<a name="L1926"></a><tt class="py-lineno">1926</tt> <tt class="py-line"><tt class="py-string"> target="_top">no&nbsp;frames</a>]</span></td></tr></tt> </tt>
<a name="L1927"></a><tt class="py-lineno">1927</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L1928"></a><tt class="py-lineno">1928</tt> <tt class="py-line"><tt class="py-string"> </table></tt> </tt>
<a name="L1929"></a><tt class="py-lineno">1929</tt> <tt class="py-line"><tt class="py-string"> </td></tt> </tt>
<a name="L1930"></a><tt class="py-lineno">1930</tt> <tt class="py-line"><tt class="py-string"> </tr></tt> </tt>
<a name="L1931"></a><tt class="py-lineno">1931</tt> <tt class="py-line"><tt class="py-string"> </table></tt> </tt>
<a name="L1932"></a><tt class="py-lineno">1932</tt> <tt class="py-line"><tt class="py-string"> '''</tt><tt class="py-op">)</tt> </tt>
<a name="L1933"></a><tt class="py-lineno">1933</tt> <tt class="py-line"> <tt class="py-comment"># \------------------------------------------------------------/</tt> </tt>
<a name="L1934"></a><tt class="py-lineno">1934</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="HTMLWriter.breadcrumbs"></a><div id="HTMLWriter.breadcrumbs-def"><a name="L1935"></a><tt class="py-lineno">1935</tt> <a class="py-toggle" href="#" id="HTMLWriter.breadcrumbs-toggle" onclick="return toggle('HTMLWriter.breadcrumbs');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#breadcrumbs">breadcrumbs</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.breadcrumbs-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.breadcrumbs-expanded"><a name="L1936"></a><tt class="py-lineno">1936</tt> <tt class="py-line"> <tt class="py-name">crumbs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-541" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter._crumb()=epydoc.docwriter.html.HTMLWriter-class.html#_crumb"><a title="epydoc.docwriter.html.HTMLWriter._crumb" class="py-name" href="#" onclick="return doclink('link-541', '_crumb', 'link-541');">_crumb</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L1937"></a><tt class="py-lineno">1937</tt> <tt class="py-line"> </tt>
<a name="L1938"></a><tt class="py-lineno">1938</tt> <tt class="py-line"> <tt class="py-comment"># Generate the crumbs for uid's ancestors.</tt> </tt>
<a name="L1939"></a><tt class="py-lineno">1939</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">while</tt> <tt class="py-name">True</tt><tt class="py-op">:</tt> </tt>
<a name="L1940"></a><tt class="py-lineno">1940</tt> <tt class="py-line"> <tt id="link-542" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-542', 'container', 'link-63');">container</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt id="link-543" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-543', 'container', 'link-63');">container</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L1941"></a><tt class="py-lineno">1941</tt> <tt class="py-line"> <tt class="py-keyword">assert</tt> <tt class="py-name">doc</tt> <tt class="py-op">!=</tt> <tt id="link-544" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-544', 'container', 'link-63');">container</a></tt><tt class="py-op">,</tt> <tt class="py-string">'object is its own container?'</tt> </tt>
<a name="L1942"></a><tt class="py-lineno">1942</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-545" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-545', 'container', 'link-63');">container</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L1943"></a><tt class="py-lineno">1943</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-546" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-546', 'canonical_name', 'link-82');">canonical_name</a></tt> <tt class="py-keyword">is</tt> <tt id="link-547" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-547', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1944"></a><tt class="py-lineno">1944</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt class="py-string">'??'</tt><tt class="py-op">]</tt><tt class="py-op">+</tt><tt class="py-name">crumbs</tt> </tt>
<a name="L1945"></a><tt class="py-lineno">1945</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-548" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-548', 'ModuleDoc', 'link-55');">ModuleDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1946"></a><tt class="py-lineno">1946</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt class="py-string">'Package&nbsp;%s'</tt> <tt class="py-op">%</tt> <tt class="py-name">ident</tt> </tt>
<a name="L1947"></a><tt class="py-lineno">1947</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">ident</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-549" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-549', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">]</tt><tt class="py-op">+</tt><tt class="py-name">crumbs</tt> </tt>
<a name="L1948"></a><tt class="py-lineno">1948</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1949"></a><tt class="py-lineno">1949</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">list</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-550" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-550', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">)</tt><tt class="py-op">+</tt><tt class="py-name">crumbs</tt> </tt>
<a name="L1950"></a><tt class="py-lineno">1950</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1951"></a><tt class="py-lineno">1951</tt> <tt class="py-line"> <tt id="link-551" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-551', 'label', 'link-118');">label</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-552" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._crumb" class="py-name" href="#" onclick="return doclink('link-552', '_crumb', 'link-541');">_crumb</a></tt><tt class="py-op">(</tt><tt id="link-553" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-553', 'container', 'link-63');">container</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1952"></a><tt class="py-lineno">1952</tt> <tt class="py-line"> <tt id="link-554" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-554', 'name', 'link-117');">name</a></tt> <tt class="py-op">=</tt> <tt id="link-555" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-555', 'container', 'link-63');">container</a></tt><tt class="py-op">.</tt><tt id="link-556" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-556', 'canonical_name', 'link-82');">canonical_name</a></tt> </tt>
<a name="L1953"></a><tt class="py-lineno">1953</tt> <tt class="py-line"> <tt class="py-name">crumbs</tt><tt class="py-op">.</tt><tt class="py-name">insert</tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-557" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.href" class="py-name" href="#" onclick="return doclink('link-557', 'href', 'link-254');">href</a></tt><tt class="py-op">(</tt><tt id="link-558" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-558', 'container', 'link-63');">container</a></tt><tt class="py-op">,</tt> <tt id="link-559" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-559', 'label', 'link-118');">label</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-comment"># [xx] code=0??</tt> </tt>
<a name="L1954"></a><tt class="py-lineno">1954</tt> <tt class="py-line"> <tt class="py-name">doc</tt> <tt class="py-op">=</tt> <tt id="link-560" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-560', 'container', 'link-63');">container</a></tt> </tt>
</div><a name="L1955"></a><tt class="py-lineno">1955</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter._crumb"></a><div id="HTMLWriter._crumb-def"><a name="L1956"></a><tt class="py-lineno">1956</tt> <a class="py-toggle" href="#" id="HTMLWriter._crumb-toggle" onclick="return toggle('HTMLWriter._crumb');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#_crumb">_crumb</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter._crumb-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter._crumb-expanded"><a name="L1957"></a><tt class="py-lineno">1957</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-561" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-561', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">)</tt><tt class="py-op">==</tt><tt class="py-number">1</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1958"></a><tt class="py-lineno">1958</tt> <tt class="py-line"> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-562" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-562', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">'script-'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1959"></a><tt class="py-lineno">1959</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'Script&nbsp;%s'</tt> <tt class="py-op">%</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-563" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-563', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-number">7</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L1960"></a><tt class="py-lineno">1960</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'%s&nbsp;%s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-564" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.doc_kind
epydoc.docwriter.html_colorize.PythonSourceColorizer.doc_kind
epydoc.docwriter.latex.LatexWriter.doc_kind" class="py-name" href="#" onclick="return doclink('link-564', 'doc_kind', 'link-256');">doc_kind</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-565" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-565', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1961"></a><tt class="py-lineno">1961</tt> <tt class="py-line"> </tt>
<a name="L1962"></a><tt class="py-lineno">1962</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1963"></a><tt class="py-lineno">1963</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ 3.5. Summary Tables</tt> </tt>
<a name="L1964"></a><tt class="py-lineno">1964</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1965"></a><tt class="py-lineno">1965</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="HTMLWriter.write_summary_table"></a><div id="HTMLWriter.write_summary_table-def"><a name="L1966"></a><tt class="py-lineno">1966</tt> <a class="py-toggle" href="#" id="HTMLWriter.write_summary_table-toggle" onclick="return toggle('HTMLWriter.write_summary_table');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_table">write_summary_table</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">heading</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">,</tt> <tt class="py-param">value_type</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write_summary_table-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write_summary_table-expanded"><a name="L1967"></a><tt class="py-lineno">1967</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1968"></a><tt class="py-lineno">1968</tt> <tt class="py-line"><tt class="py-docstring"> Generate HTML code for a summary table, and write it to</tt> </tt>
<a name="L1969"></a><tt class="py-lineno">1969</tt> <tt class="py-line"><tt class="py-docstring"> C{out}. A summary table is a table that includes a one-row</tt> </tt>
<a name="L1970"></a><tt class="py-lineno">1970</tt> <tt class="py-line"><tt class="py-docstring"> description for each variable (of a given type) in a module</tt> </tt>
<a name="L1971"></a><tt class="py-lineno">1971</tt> <tt class="py-line"><tt class="py-docstring"> or class.</tt> </tt>
<a name="L1972"></a><tt class="py-lineno">1972</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1973"></a><tt class="py-lineno">1973</tt> <tt class="py-line"><tt class="py-docstring"> @param heading: The heading for the summary table; typically,</tt> </tt>
<a name="L1974"></a><tt class="py-lineno">1974</tt> <tt class="py-line"><tt class="py-docstring"> this indicates what kind of value the table describes</tt> </tt>
<a name="L1975"></a><tt class="py-lineno">1975</tt> <tt class="py-line"><tt class="py-docstring"> (e.g., functions or classes).</tt> </tt>
<a name="L1976"></a><tt class="py-lineno">1976</tt> <tt class="py-line"><tt class="py-docstring"> @param doc: A L{ValueDoc} object containing the API</tt> </tt>
<a name="L1977"></a><tt class="py-lineno">1977</tt> <tt class="py-line"><tt class="py-docstring"> documentation for the module or class whose variables</tt> </tt>
<a name="L1978"></a><tt class="py-lineno">1978</tt> <tt class="py-line"><tt class="py-docstring"> we should summarize.</tt> </tt>
<a name="L1979"></a><tt class="py-lineno">1979</tt> <tt class="py-line"><tt class="py-docstring"> @param value_type: A string indicating what type of value</tt> </tt>
<a name="L1980"></a><tt class="py-lineno">1980</tt> <tt class="py-line"><tt class="py-docstring"> should be listed in this summary table. This value</tt> </tt>
<a name="L1981"></a><tt class="py-lineno">1981</tt> <tt class="py-line"><tt class="py-docstring"> is passed on to C{doc}'s C{select_variables()} method.</tt> </tt>
<a name="L1982"></a><tt class="py-lineno">1982</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1983"></a><tt class="py-lineno">1983</tt> <tt class="py-line"> <tt class="py-comment"># inh_var_groups is a dictionary used to hold "inheritance</tt> </tt>
<a name="L1984"></a><tt class="py-lineno">1984</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># pseudo-groups", which are created when inheritance is</tt> </tt>
<a name="L1985"></a><tt class="py-lineno">1985</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># 'grouped'. It maps each base to a list of vars inherited</tt> </tt>
<a name="L1986"></a><tt class="py-lineno">1986</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># from that base.</tt> </tt>
<a name="L1987"></a><tt class="py-lineno">1987</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">grouped_inh_vars</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L1988"></a><tt class="py-lineno">1988</tt> <tt class="py-line"> </tt>
<a name="L1989"></a><tt class="py-lineno">1989</tt> <tt class="py-line"> <tt class="py-comment"># Divide all public variables of the given type into groups.</tt> </tt>
<a name="L1990"></a><tt class="py-lineno">1990</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">groups</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">(</tt><tt id="link-566" class="py-name"><a title="epydoc.util.plaintext_to_html" class="py-name" href="#" onclick="return doclink('link-566', 'plaintext_to_html', 'link-32');">plaintext_to_html</a></tt><tt class="py-op">(</tt><tt class="py-name">group_name</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L1991"></a><tt class="py-lineno">1991</tt> <tt class="py-line"> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-567" class="py-name"><a title="epydoc.apidoc.ClassDoc.select_variables
epydoc.apidoc.ModuleDoc.select_variables" class="py-name" href="#" onclick="return doclink('link-567', 'select_variables', 'link-444');">select_variables</a></tt><tt class="py-op">(</tt><tt class="py-name">group</tt><tt class="py-op">=</tt><tt class="py-name">group_name</tt><tt class="py-op">,</tt> <tt class="py-name">imported</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L1992"></a><tt class="py-lineno">1992</tt> <tt class="py-line"> <tt class="py-name">value_type</tt><tt class="py-op">=</tt><tt class="py-name">value_type</tt><tt class="py-op">,</tt> </tt>
<a name="L1993"></a><tt class="py-lineno">1993</tt> <tt class="py-line"> <tt class="py-name">public</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_public_filter</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1994"></a><tt class="py-lineno">1994</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">group_name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-568" class="py-name" targets="Method epydoc.apidoc.NamespaceDoc.group_names()=epydoc.apidoc.NamespaceDoc-class.html#group_names"><a title="epydoc.apidoc.NamespaceDoc.group_names" class="py-name" href="#" onclick="return doclink('link-568', 'group_names', 'link-568');">group_names</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L1995"></a><tt class="py-lineno">1995</tt> <tt class="py-line"> </tt>
<a name="L1996"></a><tt class="py-lineno">1996</tt> <tt class="py-line"> <tt class="py-comment"># Discard any empty groups; and return if they're all empty.</tt> </tt>
<a name="L1997"></a><tt class="py-lineno">1997</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">groups</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">(</tt><tt class="py-name">g</tt><tt class="py-op">,</tt><tt class="py-name">vars</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt class="py-name">g</tt><tt class="py-op">,</tt><tt class="py-name">vars</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">groups</tt> <tt class="py-keyword">if</tt> <tt class="py-name">vars</tt><tt class="py-op">]</tt> </tt>
<a name="L1998"></a><tt class="py-lineno">1998</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">groups</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> </tt>
<a name="L1999"></a><tt class="py-lineno">1999</tt> <tt class="py-line"> </tt>
<a name="L2000"></a><tt class="py-lineno">2000</tt> <tt class="py-line"> <tt class="py-comment"># Write a header</tt> </tt>
<a name="L2001"></a><tt class="py-lineno">2001</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-569" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_table_header" class="py-name" href="#" onclick="return doclink('link-569', 'write_table_header', 'link-375');">write_table_header</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">"summary"</tt><tt class="py-op">,</tt> <tt class="py-name">heading</tt><tt class="py-op">)</tt> </tt>
<a name="L2002"></a><tt class="py-lineno">2002</tt> <tt class="py-line"> </tt>
<a name="L2003"></a><tt class="py-lineno">2003</tt> <tt class="py-line"> <tt class="py-comment"># Write a section for each group.</tt> </tt>
<a name="L2004"></a><tt class="py-lineno">2004</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt id="link-570" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-570', 'name', 'link-117');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">var_docs</tt> <tt class="py-keyword">in</tt> <tt class="py-name">groups</tt><tt class="py-op">:</tt> </tt>
<a name="L2005"></a><tt class="py-lineno">2005</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-571" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_summary_group()=epydoc.docwriter.html.HTMLWriter-class.html#write_summary_group"><a title="epydoc.docwriter.html.HTMLWriter.write_summary_group" class="py-name" href="#" onclick="return doclink('link-571', 'write_summary_group', 'link-571');">write_summary_group</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-572" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-572', 'name', 'link-117');">name</a></tt><tt class="py-op">,</tt> </tt>
<a name="L2006"></a><tt class="py-lineno">2006</tt> <tt class="py-line"> <tt class="py-name">var_docs</tt><tt class="py-op">,</tt> <tt class="py-name">grouped_inh_vars</tt><tt class="py-op">)</tt> </tt>
<a name="L2007"></a><tt class="py-lineno">2007</tt> <tt class="py-line"> </tt>
<a name="L2008"></a><tt class="py-lineno">2008</tt> <tt class="py-line"> <tt class="py-comment"># Write a section for each inheritance pseudo-group (used if</tt> </tt>
<a name="L2009"></a><tt class="py-lineno">2009</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># inheritance=='grouped')</tt> </tt>
<a name="L2010"></a><tt class="py-lineno">2010</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">grouped_inh_vars</tt><tt class="py-op">:</tt> </tt>
<a name="L2011"></a><tt class="py-lineno">2011</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">base</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-573" class="py-name"><a title="epydoc.apidoc.ClassDoc.mro" class="py-name" href="#" onclick="return doclink('link-573', 'mro', 'link-336');">mro</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2012"></a><tt class="py-lineno">2012</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">base</tt> <tt class="py-keyword">in</tt> <tt class="py-name">grouped_inh_vars</tt><tt class="py-op">:</tt> </tt>
<a name="L2013"></a><tt class="py-lineno">2013</tt> <tt class="py-line"> <tt class="py-name">hdr</tt> <tt class="py-op">=</tt> <tt class="py-string">'Inherited from %s'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-574" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.href" class="py-name" href="#" onclick="return doclink('link-574', 'href', 'link-254');">href</a></tt><tt class="py-op">(</tt><tt class="py-name">base</tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">=</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L2014"></a><tt class="py-lineno">2014</tt> <tt class="py-line"> <tt class="py-name">tr_class</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
<a name="L2015"></a><tt class="py-lineno">2015</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt id="link-575" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-575', 'v', 'link-80');">v</a></tt> <tt class="py-keyword">for</tt> <tt id="link-576" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-576', 'v', 'link-80');">v</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">grouped_inh_vars</tt><tt class="py-op">[</tt><tt class="py-name">base</tt><tt class="py-op">]</tt> </tt>
<a name="L2016"></a><tt class="py-lineno">2016</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-577" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-577', 'v', 'link-80');">v</a></tt><tt class="py-op">.</tt><tt id="link-578" class="py-name" targets="Variable epydoc.apidoc.VariableDoc.is_public=epydoc.apidoc.VariableDoc-class.html#is_public"><a title="epydoc.apidoc.VariableDoc.is_public" class="py-name" href="#" onclick="return doclink('link-578', 'is_public', 'link-578');">is_public</a></tt><tt class="py-op">]</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L2017"></a><tt class="py-lineno">2017</tt> <tt class="py-line"> <tt class="py-name">tr_class</tt> <tt class="py-op">=</tt> <tt class="py-string">' class="private"'</tt> </tt>
<a name="L2018"></a><tt class="py-lineno">2018</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-579" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_group_header()=epydoc.docwriter.html.HTMLWriter-class.html#write_group_header"><a title="epydoc.docwriter.html.HTMLWriter.write_group_header" class="py-name" href="#" onclick="return doclink('link-579', 'write_group_header', 'link-579');">write_group_header</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">hdr</tt><tt class="py-op">,</tt> <tt class="py-name">tr_class</tt><tt class="py-op">)</tt> </tt>
<a name="L2019"></a><tt class="py-lineno">2019</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">grouped_inh_vars</tt><tt class="py-op">[</tt><tt class="py-name">base</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L2020"></a><tt class="py-lineno">2020</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-580" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_summary_line()=epydoc.docwriter.html.HTMLWriter-class.html#write_summary_line"><a title="epydoc.docwriter.html.HTMLWriter.write_summary_line" class="py-name" href="#" onclick="return doclink('link-580', 'write_summary_line', 'link-580');">write_summary_line</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">var_doc</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L2021"></a><tt class="py-lineno">2021</tt> <tt class="py-line"> </tt>
<a name="L2022"></a><tt class="py-lineno">2022</tt> <tt class="py-line"> <tt class="py-comment"># Write a footer for the table.</tt> </tt>
<a name="L2023"></a><tt class="py-lineno">2023</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-581" class="py-name" targets="Variable epydoc.docwriter.html.HTMLWriter.TABLE_FOOTER=epydoc.docwriter.html.HTMLWriter-class.html#TABLE_FOOTER"><a title="epydoc.docwriter.html.HTMLWriter.TABLE_FOOTER" class="py-name" href="#" onclick="return doclink('link-581', 'TABLE_FOOTER', 'link-581');">TABLE_FOOTER</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L2024"></a><tt class="py-lineno">2024</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.write_summary_group"></a><div id="HTMLWriter.write_summary_group-def"><a name="L2025"></a><tt class="py-lineno">2025</tt> <a class="py-toggle" href="#" id="HTMLWriter.write_summary_group-toggle" onclick="return toggle('HTMLWriter.write_summary_group');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_group">write_summary_group</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">var_docs</tt><tt class="py-op">,</tt> <tt class="py-param">grouped_inh_vars</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write_summary_group-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write_summary_group-expanded"><a name="L2026"></a><tt class="py-lineno">2026</tt> <tt class="py-line"> <tt class="py-comment"># Split up the var_docs list, according to the way each var</tt> </tt>
<a name="L2027"></a><tt class="py-lineno">2027</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># should be displayed:</tt> </tt>
<a name="L2028"></a><tt class="py-lineno">2028</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># - listed_inh_vars -- for listed inherited variables.</tt> </tt>
<a name="L2029"></a><tt class="py-lineno">2029</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># - grouped_inh_vars -- for grouped inherited variables.</tt> </tt>
<a name="L2030"></a><tt class="py-lineno">2030</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># - normal_vars -- for all other variables.</tt> </tt>
<a name="L2031"></a><tt class="py-lineno">2031</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">listed_inh_vars</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L2032"></a><tt class="py-lineno">2032</tt> <tt class="py-line"> <tt class="py-name">normal_vars</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L2033"></a><tt class="py-lineno">2033</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_docs</tt><tt class="py-op">:</tt> </tt>
<a name="L2034"></a><tt class="py-lineno">2034</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-582" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-582', 'container', 'link-63');">container</a></tt> <tt class="py-op">!=</tt> <tt class="py-name">doc</tt><tt class="py-op">:</tt> </tt>
<a name="L2035"></a><tt class="py-lineno">2035</tt> <tt class="py-line"> <tt class="py-name">base</tt> <tt class="py-op">=</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-583" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-583', 'container', 'link-63');">container</a></tt> </tt>
<a name="L2036"></a><tt class="py-lineno">2036</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">base</tt><tt class="py-op">,</tt> <tt id="link-584" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-584', 'ClassDoc', 'link-56');">ClassDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2037"></a><tt class="py-lineno">2037</tt> <tt class="py-line"> <tt class="py-comment"># This *should* never happen:</tt> </tt>
<a name="L2038"></a><tt class="py-lineno">2038</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-585" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-585', 'log', 'link-29');">log</a></tt><tt class="py-op">.</tt><tt id="link-586" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-586', 'warning', 'link-74');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">"%s's container is not a class!"</tt> <tt class="py-op">%</tt> <tt class="py-name">var_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L2039"></a><tt class="py-lineno">2039</tt> <tt class="py-line"> <tt class="py-name">normal_vars</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L2040"></a><tt class="py-lineno">2040</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-op">(</tt><tt class="py-name">base</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">class_set</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L2041"></a><tt class="py-lineno">2041</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_inheritance</tt> <tt class="py-op">==</tt> <tt class="py-string">'listed'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2042"></a><tt class="py-lineno">2042</tt> <tt class="py-line"> <tt class="py-name">listed_inh_vars</tt><tt class="py-op">.</tt><tt class="py-name">setdefault</tt><tt class="py-op">(</tt><tt class="py-name">base</tt><tt class="py-op">,</tt><tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L2043"></a><tt class="py-lineno">2043</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_inheritance</tt> <tt class="py-op">==</tt> <tt class="py-string">'grouped'</tt><tt class="py-op">:</tt> </tt>
<a name="L2044"></a><tt class="py-lineno">2044</tt> <tt class="py-line"> <tt class="py-name">grouped_inh_vars</tt><tt class="py-op">.</tt><tt class="py-name">setdefault</tt><tt class="py-op">(</tt><tt class="py-name">base</tt><tt class="py-op">,</tt><tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L2045"></a><tt class="py-lineno">2045</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2046"></a><tt class="py-lineno">2046</tt> <tt class="py-line"> <tt class="py-name">normal_vars</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L2047"></a><tt class="py-lineno">2047</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2048"></a><tt class="py-lineno">2048</tt> <tt class="py-line"> <tt class="py-name">normal_vars</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L2049"></a><tt class="py-lineno">2049</tt> <tt class="py-line"> </tt>
<a name="L2050"></a><tt class="py-lineno">2050</tt> <tt class="py-line"> <tt class="py-comment"># Write a header for the group.</tt> </tt>
<a name="L2051"></a><tt class="py-lineno">2051</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt id="link-587" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-587', 'name', 'link-117');">name</a></tt> <tt class="py-op">!=</tt> <tt class="py-string">''</tt><tt class="py-op">:</tt> </tt>
<a name="L2052"></a><tt class="py-lineno">2052</tt> <tt class="py-line"> <tt class="py-name">tr_class</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
<a name="L2053"></a><tt class="py-lineno">2053</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt id="link-588" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-588', 'v', 'link-80');">v</a></tt> <tt class="py-keyword">for</tt> <tt id="link-589" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-589', 'v', 'link-80');">v</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_docs</tt> <tt class="py-keyword">if</tt> <tt id="link-590" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-590', 'v', 'link-80');">v</a></tt><tt class="py-op">.</tt><tt id="link-591" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_public" class="py-name" href="#" onclick="return doclink('link-591', 'is_public', 'link-578');">is_public</a></tt><tt class="py-op">]</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L2054"></a><tt class="py-lineno">2054</tt> <tt class="py-line"> <tt class="py-name">tr_class</tt> <tt class="py-op">=</tt> <tt class="py-string">' class="private"'</tt> </tt>
<a name="L2055"></a><tt class="py-lineno">2055</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-592" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_group_header" class="py-name" href="#" onclick="return doclink('link-592', 'write_group_header', 'link-579');">write_group_header</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt id="link-593" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-593', 'name', 'link-117');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">tr_class</tt><tt class="py-op">)</tt> </tt>
<a name="L2056"></a><tt class="py-lineno">2056</tt> <tt class="py-line"> </tt>
<a name="L2057"></a><tt class="py-lineno">2057</tt> <tt class="py-line"> <tt class="py-comment"># Write a line for each normal var:</tt> </tt>
<a name="L2058"></a><tt class="py-lineno">2058</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">normal_vars</tt><tt class="py-op">:</tt> </tt>
<a name="L2059"></a><tt class="py-lineno">2059</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-594" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_summary_line" class="py-name" href="#" onclick="return doclink('link-594', 'write_summary_line', 'link-580');">write_summary_line</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">var_doc</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L2060"></a><tt class="py-lineno">2060</tt> <tt class="py-line"> <tt class="py-comment"># Write a subsection for inherited vars:</tt> </tt>
<a name="L2061"></a><tt class="py-lineno">2061</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">listed_inh_vars</tt><tt class="py-op">:</tt> </tt>
<a name="L2062"></a><tt class="py-lineno">2062</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-595" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_inheritance_list()=epydoc.docwriter.html.HTMLWriter-class.html#write_inheritance_list"><a title="epydoc.docwriter.html.HTMLWriter.write_inheritance_list" class="py-name" href="#" onclick="return doclink('link-595', 'write_inheritance_list', 'link-595');">write_inheritance_list</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-name">listed_inh_vars</tt><tt class="py-op">)</tt> </tt>
</div><a name="L2063"></a><tt class="py-lineno">2063</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.write_inheritance_list"></a><div id="HTMLWriter.write_inheritance_list-def"><a name="L2064"></a><tt class="py-lineno">2064</tt> <a class="py-toggle" href="#" id="HTMLWriter.write_inheritance_list-toggle" onclick="return toggle('HTMLWriter.write_inheritance_list');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write_inheritance_list">write_inheritance_list</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">,</tt> <tt class="py-param">listed_inh_vars</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write_inheritance_list-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write_inheritance_list-expanded"><a name="L2065"></a><tt class="py-lineno">2065</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' <tr>\n <td colspan="2" class="summary">\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L2066"></a><tt class="py-lineno">2066</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">base</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-596" class="py-name"><a title="epydoc.apidoc.ClassDoc.mro" class="py-name" href="#" onclick="return doclink('link-596', 'mro', 'link-336');">mro</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2067"></a><tt class="py-lineno">2067</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">base</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">listed_inh_vars</tt><tt class="py-op">:</tt> <tt class="py-keyword">continue</tt> </tt>
<a name="L2068"></a><tt class="py-lineno">2068</tt> <tt class="py-line"> <tt class="py-name">public_vars</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt id="link-597" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-597', 'v', 'link-80');">v</a></tt> <tt class="py-keyword">for</tt> <tt id="link-598" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-598', 'v', 'link-80');">v</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">listed_inh_vars</tt><tt class="py-op">[</tt><tt class="py-name">base</tt><tt class="py-op">]</tt> </tt>
<a name="L2069"></a><tt class="py-lineno">2069</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-599" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-599', 'v', 'link-80');">v</a></tt><tt class="py-op">.</tt><tt id="link-600" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_public" class="py-name" href="#" onclick="return doclink('link-600', 'is_public', 'link-578');">is_public</a></tt><tt class="py-op">]</tt> </tt>
<a name="L2070"></a><tt class="py-lineno">2070</tt> <tt class="py-line"> <tt class="py-name">private_vars</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt id="link-601" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-601', 'v', 'link-80');">v</a></tt> <tt class="py-keyword">for</tt> <tt id="link-602" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-602', 'v', 'link-80');">v</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">listed_inh_vars</tt><tt class="py-op">[</tt><tt class="py-name">base</tt><tt class="py-op">]</tt> </tt>
<a name="L2071"></a><tt class="py-lineno">2071</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt id="link-603" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-603', 'v', 'link-80');">v</a></tt><tt class="py-op">.</tt><tt id="link-604" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_public" class="py-name" href="#" onclick="return doclink('link-604', 'is_public', 'link-578');">is_public</a></tt><tt class="py-op">]</tt> </tt>
<a name="L2072"></a><tt class="py-lineno">2072</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">public_vars</tt><tt class="py-op">:</tt> </tt>
<a name="L2073"></a><tt class="py-lineno">2073</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' <p class="indent-wrapped-lines">'</tt> </tt>
<a name="L2074"></a><tt class="py-lineno">2074</tt> <tt class="py-line"> <tt class="py-string">'<b>Inherited from <code>%s</code></b>:\n'</tt> <tt class="py-op">%</tt> </tt>
<a name="L2075"></a><tt class="py-lineno">2075</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-605" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.href" class="py-name" href="#" onclick="return doclink('link-605', 'href', 'link-254');">href</a></tt><tt class="py-op">(</tt><tt class="py-name">base</tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">=</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L2076"></a><tt class="py-lineno">2076</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-606" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_var_list()=epydoc.docwriter.html.HTMLWriter-class.html#write_var_list,Method epydoc.docwriter.latex.LatexWriter.write_var_list()=epydoc.docwriter.latex.LatexWriter-class.html#write_var_list"><a title="epydoc.docwriter.html.HTMLWriter.write_var_list
epydoc.docwriter.latex.LatexWriter.write_var_list" class="py-name" href="#" onclick="return doclink('link-606', 'write_var_list', 'link-606');">write_var_list</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">public_vars</tt><tt class="py-op">)</tt> </tt>
<a name="L2077"></a><tt class="py-lineno">2077</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' </p>\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L2078"></a><tt class="py-lineno">2078</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">private_vars</tt> <tt class="py-keyword">and</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_show_private</tt><tt class="py-op">:</tt> </tt>
<a name="L2079"></a><tt class="py-lineno">2079</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' <div class="private">'</tt><tt class="py-op">)</tt> </tt>
<a name="L2080"></a><tt class="py-lineno">2080</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' <p class="indent-wrapped-lines">'</tt> </tt>
<a name="L2081"></a><tt class="py-lineno">2081</tt> <tt class="py-line"> <tt class="py-string">'<b>Inherited from <code>%s</code></b> (private):\n'</tt> <tt class="py-op">%</tt> </tt>
<a name="L2082"></a><tt class="py-lineno">2082</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-607" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.href" class="py-name" href="#" onclick="return doclink('link-607', 'href', 'link-254');">href</a></tt><tt class="py-op">(</tt><tt class="py-name">base</tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">=</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L2083"></a><tt class="py-lineno">2083</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-608" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_var_list
epydoc.docwriter.latex.LatexWriter.write_var_list" class="py-name" href="#" onclick="return doclink('link-608', 'write_var_list', 'link-606');">write_var_list</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">private_vars</tt><tt class="py-op">)</tt> </tt>
<a name="L2084"></a><tt class="py-lineno">2084</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' </p></div>\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L2085"></a><tt class="py-lineno">2085</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' </td>\n </tr>\n'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L2086"></a><tt class="py-lineno">2086</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.write_var_list"></a><div id="HTMLWriter.write_var_list-def"><a name="L2087"></a><tt class="py-lineno">2087</tt> <a class="py-toggle" href="#" id="HTMLWriter.write_var_list-toggle" onclick="return toggle('HTMLWriter.write_var_list');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write_var_list">write_var_list</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">vardocs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write_var_list-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write_var_list-expanded"><a name="L2088"></a><tt class="py-lineno">2088</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">)</tt> </tt>
<a name="L2089"></a><tt class="py-lineno">2089</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">',\n '</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'<code>%s</code>'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-609" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.href" class="py-name" href="#" onclick="return doclink('link-609', 'href', 'link-254');">href</a></tt><tt class="py-op">(</tt><tt id="link-610" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-610', 'v', 'link-80');">v</a></tt><tt class="py-op">,</tt><tt id="link-611" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-611', 'v', 'link-80');">v</a></tt><tt class="py-op">.</tt><tt id="link-612" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-612', 'name', 'link-117');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L2090"></a><tt class="py-lineno">2090</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-613" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-613', 'v', 'link-80');">v</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">vardocs</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">+</tt><tt class="py-string">'\n'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L2091"></a><tt class="py-lineno">2091</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.write_summary_line"></a><div id="HTMLWriter.write_summary_line-def"><a name="L2092"></a><tt class="py-lineno">2092</tt> <a class="py-toggle" href="#" id="HTMLWriter.write_summary_line-toggle" onclick="return toggle('HTMLWriter.write_summary_line');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_line">write_summary_line</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">var_doc</tt><tt class="py-op">,</tt> <tt class="py-param">container</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write_summary_line-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write_summary_line-expanded"><a name="L2093"></a><tt class="py-lineno">2093</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L2094"></a><tt class="py-lineno">2094</tt> <tt class="py-line"><tt class="py-docstring"> Generate HTML code for a single line of a summary table, and</tt> </tt>
<a name="L2095"></a><tt class="py-lineno">2095</tt> <tt class="py-line"><tt class="py-docstring"> write it to C{out}. See L{write_summary_table} for more</tt> </tt>
<a name="L2096"></a><tt class="py-lineno">2096</tt> <tt class="py-line"><tt class="py-docstring"> information.</tt> </tt>
<a name="L2097"></a><tt class="py-lineno">2097</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L2098"></a><tt class="py-lineno">2098</tt> <tt class="py-line"><tt class="py-docstring"> @param var_doc: The API documentation for the variable that</tt> </tt>
<a name="L2099"></a><tt class="py-lineno">2099</tt> <tt class="py-line"><tt class="py-docstring"> should be described by this line of the summary table.</tt> </tt>
<a name="L2100"></a><tt class="py-lineno">2100</tt> <tt class="py-line"><tt class="py-docstring"> @param container: The API documentation for the class or</tt> </tt>
<a name="L2101"></a><tt class="py-lineno">2101</tt> <tt class="py-line"><tt class="py-docstring"> module whose summary table we're writing.</tt> </tt>
<a name="L2102"></a><tt class="py-lineno">2102</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L2103"></a><tt class="py-lineno">2103</tt> <tt class="py-line"> <tt id="link-614" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.pysrc_link" class="py-name" href="#" onclick="return doclink('link-614', 'pysrc_link', 'link-227');">pysrc_link</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L2104"></a><tt class="py-lineno">2104</tt> <tt class="py-line"> <tt class="py-name">callgraph</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L2105"></a><tt class="py-lineno">2105</tt> <tt class="py-line"> </tt>
<a name="L2106"></a><tt class="py-lineno">2106</tt> <tt class="py-line"> <tt class="py-comment"># If it's a private variable, then mark its <tr>.</tt> </tt>
<a name="L2107"></a><tt class="py-lineno">2107</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-615" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_public" class="py-name" href="#" onclick="return doclink('link-615', 'is_public', 'link-578');">is_public</a></tt><tt class="py-op">:</tt> <tt class="py-name">tr_class</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
<a name="L2108"></a><tt class="py-lineno">2108</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-name">tr_class</tt> <tt class="py-op">=</tt> <tt class="py-string">' class="private"'</tt> </tt>
<a name="L2109"></a><tt class="py-lineno">2109</tt> <tt class="py-line"> </tt>
<a name="L2110"></a><tt class="py-lineno">2110</tt> <tt class="py-line"> <tt class="py-comment"># Decide an anchor or a link is to be generated.</tt> </tt>
<a name="L2111"></a><tt class="py-lineno">2111</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">link_name</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_redundant_details</tt> <tt class="py-keyword">or</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-616" class="py-name" targets="Method epydoc.apidoc.APIDoc.is_detailed()=epydoc.apidoc.APIDoc-class.html#is_detailed,Method epydoc.apidoc.GenericValueDoc.is_detailed()=epydoc.apidoc.GenericValueDoc-class.html#is_detailed,Method epydoc.apidoc.NamespaceDoc.is_detailed()=epydoc.apidoc.NamespaceDoc-class.html#is_detailed,Method epydoc.apidoc.PropertyDoc.is_detailed()=epydoc.apidoc.PropertyDoc-class.html#is_detailed,Method epydoc.apidoc.RoutineDoc.is_detailed()=epydoc.apidoc.RoutineDoc-class.html#is_detailed,Method epydoc.apidoc.VariableDoc.is_detailed()=epydoc.apidoc.VariableDoc-class.html#is_detailed"><a title="epydoc.apidoc.APIDoc.is_detailed
epydoc.apidoc.GenericValueDoc.is_detailed
epydoc.apidoc.NamespaceDoc.is_detailed
epydoc.apidoc.PropertyDoc.is_detailed
epydoc.apidoc.RoutineDoc.is_detailed
epydoc.apidoc.VariableDoc.is_detailed" class="py-name" href="#" onclick="return doclink('link-616', 'is_detailed', 'link-616');">is_detailed</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L2112"></a><tt class="py-lineno">2112</tt> <tt class="py-line"> <tt class="py-name">anchor</tt> <tt class="py-op">=</tt> <tt class="py-keyword">not</tt> <tt class="py-name">link_name</tt> </tt>
<a name="L2113"></a><tt class="py-lineno">2113</tt> <tt class="py-line"> </tt>
<a name="L2114"></a><tt class="py-lineno">2114</tt> <tt class="py-line"> <tt class="py-comment"># Construct the HTML code for the type (cell 1) & description</tt> </tt>
<a name="L2115"></a><tt class="py-lineno">2115</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># (cell 2).</tt> </tt>
<a name="L2116"></a><tt class="py-lineno">2116</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-617" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-617', 'value', 'link-61');">value</a></tt><tt class="py-op">,</tt> <tt id="link-618" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-618', 'RoutineDoc', 'link-57');">RoutineDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2117"></a><tt class="py-lineno">2117</tt> <tt class="py-line"> <tt class="py-name">typ</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-619" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.return_type=epydoc.apidoc.RoutineDoc-class.html#return_type,Method epydoc.docwriter.html.HTMLWriter.return_type()=epydoc.docwriter.html.HTMLWriter-class.html#return_type"><a title="epydoc.apidoc.RoutineDoc.return_type
epydoc.docwriter.html.HTMLWriter.return_type" class="py-name" href="#" onclick="return doclink('link-619', 'return_type', 'link-619');">return_type</a></tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">=</tt><tt class="py-number">6</tt><tt class="py-op">)</tt> </tt>
<a name="L2118"></a><tt class="py-lineno">2118</tt> <tt class="py-line"> <tt id="link-620" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.description()=epydoc.docwriter.html.HTMLWriter-class.html#description"><a title="epydoc.docwriter.html.HTMLWriter.description" class="py-name" href="#" onclick="return doclink('link-620', 'description', 'link-620');">description</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-621" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.function_signature()=epydoc.docwriter.html.HTMLWriter-class.html#function_signature,Method epydoc.docwriter.latex.LatexWriter.function_signature()=epydoc.docwriter.latex.LatexWriter-class.html#function_signature"><a title="epydoc.docwriter.html.HTMLWriter.function_signature
epydoc.docwriter.latex.LatexWriter.function_signature" class="py-name" href="#" onclick="return doclink('link-621', 'function_signature', 'link-621');">function_signature</a></tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">,</tt> <tt class="py-name">is_summary</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> </tt>
<a name="L2119"></a><tt class="py-lineno">2119</tt> <tt class="py-line"> <tt class="py-name">link_name</tt><tt class="py-op">=</tt><tt class="py-name">link_name</tt><tt class="py-op">,</tt> <tt class="py-name">anchor</tt><tt class="py-op">=</tt><tt class="py-name">anchor</tt><tt class="py-op">)</tt> </tt>
<a name="L2120"></a><tt class="py-lineno">2120</tt> <tt class="py-line"> <tt id="link-622" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.pysrc_link" class="py-name" href="#" onclick="return doclink('link-622', 'pysrc_link', 'link-227');">pysrc_link</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-623" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.pysrc_link" class="py-name" href="#" onclick="return doclink('link-623', 'pysrc_link', 'link-227');">pysrc_link</a></tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-624" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-624', 'value', 'link-61');">value</a></tt><tt class="py-op">)</tt> </tt>
<a name="L2121"></a><tt class="py-lineno">2121</tt> <tt class="py-line"> </tt>
<a name="L2122"></a><tt class="py-lineno">2122</tt> <tt class="py-line"> <tt class="py-comment"># Perpare the call-graph, if requested</tt> </tt>
<a name="L2123"></a><tt class="py-lineno">2123</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-string">'callgraph'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_graph_types</tt><tt class="py-op">:</tt> </tt>
<a name="L2124"></a><tt class="py-lineno">2124</tt> <tt class="py-line"> <tt class="py-name">linker</tt> <tt class="py-op">=</tt> <tt id="link-625" class="py-name"><a title="epydoc.docwriter.html._HTMLDocstringLinker" class="py-name" href="#" onclick="return doclink('link-625', '_HTMLDocstringLinker', 'link-319');">_HTMLDocstringLinker</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-626" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-626', 'value', 'link-61');">value</a></tt><tt class="py-op">)</tt> </tt>
<a name="L2125"></a><tt class="py-lineno">2125</tt> <tt class="py-line"> <tt class="py-name">callgraph</tt> <tt class="py-op">=</tt> <tt id="link-627" class="py-name" targets="Function epydoc.docwriter.dotgraph.call_graph()=epydoc.docwriter.dotgraph-module.html#call_graph"><a title="epydoc.docwriter.dotgraph.call_graph" class="py-name" href="#" onclick="return doclink('link-627', 'call_graph', 'link-627');">call_graph</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-628" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-628', 'value', 'link-61');">value</a></tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">docindex</tt><tt class="py-op">,</tt> </tt>
<a name="L2126"></a><tt class="py-lineno">2126</tt> <tt class="py-line"> <tt class="py-name">linker</tt><tt class="py-op">,</tt> <tt class="py-name">var_doc</tt><tt class="py-op">,</tt> <tt class="py-name">add_callers</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> </tt>
<a name="L2127"></a><tt class="py-lineno">2127</tt> <tt class="py-line"> <tt class="py-name">add_callees</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L2128"></a><tt class="py-lineno">2128</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">callgraph</tt> <tt class="py-keyword">and</tt> <tt class="py-name">callgraph</tt><tt class="py-op">.</tt><tt class="py-name">nodes</tt><tt class="py-op">:</tt> </tt>
<a name="L2129"></a><tt class="py-lineno">2129</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-629" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-629', 'value', 'link-61');">value</a></tt><tt class="py-op">.</tt><tt id="link-630" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.callgraph_uid=epydoc.apidoc.RoutineDoc-class.html#callgraph_uid"><a title="epydoc.apidoc.RoutineDoc.callgraph_uid" class="py-name" href="#" onclick="return doclink('link-630', 'callgraph_uid', 'link-630');">callgraph_uid</a></tt> <tt class="py-op">=</tt> <tt class="py-name">callgraph</tt><tt class="py-op">.</tt><tt class="py-name">uid</tt> </tt>
<a name="L2130"></a><tt class="py-lineno">2130</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2131"></a><tt class="py-lineno">2131</tt> <tt class="py-line"> <tt class="py-name">callgraph</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L2132"></a><tt class="py-lineno">2132</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2133"></a><tt class="py-lineno">2133</tt> <tt class="py-line"> <tt class="py-name">typ</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-631" class="py-name" targets="Variable epydoc.apidoc.PropertyDoc.type_descr=epydoc.apidoc.PropertyDoc-class.html#type_descr,Variable epydoc.apidoc.VariableDoc.type_descr=epydoc.apidoc.VariableDoc-class.html#type_descr,Method epydoc.docwriter.html.HTMLWriter.type_descr()=epydoc.docwriter.html.HTMLWriter-class.html#type_descr"><a title="epydoc.apidoc.PropertyDoc.type_descr
epydoc.apidoc.VariableDoc.type_descr
epydoc.docwriter.html.HTMLWriter.type_descr" class="py-name" href="#" onclick="return doclink('link-631', 'type_descr', 'link-631');">type_descr</a></tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">=</tt><tt class="py-number">6</tt><tt class="py-op">)</tt> </tt>
<a name="L2134"></a><tt class="py-lineno">2134</tt> <tt class="py-line"> <tt id="link-632" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.description" class="py-name" href="#" onclick="return doclink('link-632', 'description', 'link-620');">description</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-633" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.summary_name()=epydoc.docwriter.html.HTMLWriter-class.html#summary_name"><a title="epydoc.docwriter.html.HTMLWriter.summary_name" class="py-name" href="#" onclick="return doclink('link-633', 'summary_name', 'link-633');">summary_name</a></tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">,</tt> </tt>
<a name="L2135"></a><tt class="py-lineno">2135</tt> <tt class="py-line"> <tt class="py-name">link_name</tt><tt class="py-op">=</tt><tt class="py-name">link_name</tt><tt class="py-op">,</tt> <tt class="py-name">anchor</tt><tt class="py-op">=</tt><tt class="py-name">anchor</tt><tt class="py-op">)</tt> </tt>
<a name="L2136"></a><tt class="py-lineno">2136</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-634" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-634', 'value', 'link-61');">value</a></tt><tt class="py-op">,</tt> <tt id="link-635" class="py-name"><a title="epydoc.apidoc.GenericValueDoc" class="py-name" href="#" onclick="return doclink('link-635', 'GenericValueDoc', 'link-58');">GenericValueDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2137"></a><tt class="py-lineno">2137</tt> <tt class="py-line"> <tt class="py-comment"># The summary max length has been chosen setting</tt> </tt>
<a name="L2138"></a><tt class="py-lineno">2138</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># L{ValueDoc.SUMMARY_REPR_LINELEN} in the constructor</tt> </tt>
<a name="L2139"></a><tt class="py-lineno">2139</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">max_len</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_variable_summary_linelen</tt><tt class="py-op">-</tt><tt class="py-number">3</tt><tt class="py-op">-</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-636" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-636', 'name', 'link-117');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L2140"></a><tt class="py-lineno">2140</tt> <tt class="py-line"> <tt class="py-name">val_repr</tt> <tt class="py-op">=</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-637" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-637', 'value', 'link-61');">value</a></tt><tt class="py-op">.</tt><tt id="link-638" class="py-name" targets="Method epydoc.apidoc.ValueDoc.summary_pyval_repr()=epydoc.apidoc.ValueDoc-class.html#summary_pyval_repr"><a title="epydoc.apidoc.ValueDoc.summary_pyval_repr" class="py-name" href="#" onclick="return doclink('link-638', 'summary_pyval_repr', 'link-638');">summary_pyval_repr</a></tt><tt class="py-op">(</tt><tt class="py-name">max_len</tt><tt class="py-op">)</tt> </tt>
<a name="L2141"></a><tt class="py-lineno">2141</tt> <tt class="py-line"> <tt class="py-name">tooltip</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-639" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.variable_tooltip()=epydoc.docwriter.html.HTMLWriter-class.html#variable_tooltip"><a title="epydoc.docwriter.html.HTMLWriter.variable_tooltip" class="py-name" href="#" onclick="return doclink('link-639', 'variable_tooltip', 'link-639');">variable_tooltip</a></tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L2142"></a><tt class="py-lineno">2142</tt> <tt class="py-line"> <tt id="link-640" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.description" class="py-name" href="#" onclick="return doclink('link-640', 'description', 'link-620');">description</a></tt> <tt class="py-op">+=</tt> <tt class="py-op">(</tt><tt class="py-string">' = <code%s>%s</code>'</tt> <tt class="py-op">%</tt> </tt>
<a name="L2143"></a><tt class="py-lineno">2143</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">tooltip</tt><tt class="py-op">,</tt> <tt class="py-name">val_repr</tt><tt class="py-op">.</tt><tt id="link-641" class="py-name"><a title="epydoc.docwriter.dotgraph.DotGraph.to_html
epydoc.markup.ConcatenatedDocstring.to_html
epydoc.markup.ParsedDocstring.to_html
epydoc.markup.epytext.ParsedEpytextDocstring.to_html
epydoc.markup.javadoc.ParsedJavadocDocstring.to_html
epydoc.markup.plaintext.ParsedPlaintextDocstring.to_html
epydoc.markup.restructuredtext.ParsedRstDocstring.to_html" class="py-name" href="#" onclick="return doclink('link-641', 'to_html', 'link-522');">to_html</a></tt><tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L2144"></a><tt class="py-lineno">2144</tt> <tt class="py-line"> </tt>
<a name="L2145"></a><tt class="py-lineno">2145</tt> <tt class="py-line"> <tt class="py-comment"># Add the summary to the description (if there is one).</tt> </tt>
<a name="L2146"></a><tt class="py-lineno">2146</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-642" class="py-name" targets="Variable epydoc.apidoc.APIDoc.summary=epydoc.apidoc.APIDoc-class.html#summary,Method epydoc.docwriter.html.HTMLWriter.summary()=epydoc.docwriter.html.HTMLWriter-class.html#summary,Method epydoc.markup.ConcatenatedDocstring.summary()=epydoc.markup.ConcatenatedDocstring-class.html#summary,Method epydoc.markup.ParsedDocstring.summary()=epydoc.markup.ParsedDocstring-class.html#summary,Method epydoc.markup.epytext.ParsedEpytextDocstring.summary()=epydoc.markup.epytext.ParsedEpytextDocstring-class.html#summary,Method epydoc.markup.javadoc.ParsedJavadocDocstring.summary()=epydoc.markup.javadoc.ParsedJavadocDocstring-class.html#summary,Method epydoc.markup.plaintext.ParsedPlaintextDocstring.summary()=epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#summary,Method epydoc.markup.restructuredtext.ParsedRstDocstring.summary()=epydoc.markup.restructuredtext.ParsedRstDocstring-class.html#summary"><a title="epydoc.apidoc.APIDoc.summary
epydoc.docwriter.html.HTMLWriter.summary
epydoc.markup.ConcatenatedDocstring.summary
epydoc.markup.ParsedDocstring.summary
epydoc.markup.epytext.ParsedEpytextDocstring.summary
epydoc.markup.javadoc.ParsedJavadocDocstring.summary
epydoc.markup.plaintext.ParsedPlaintextDocstring.summary
epydoc.markup.restructuredtext.ParsedRstDocstring.summary" class="py-name" href="#" onclick="return doclink('link-642', 'summary', 'link-642');">summary</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-643" class="py-name"><a title="epydoc.apidoc.APIDoc.summary
epydoc.docwriter.html.HTMLWriter.summary
epydoc.markup.ConcatenatedDocstring.summary
epydoc.markup.ParsedDocstring.summary
epydoc.markup.epytext.ParsedEpytextDocstring.summary
epydoc.markup.javadoc.ParsedJavadocDocstring.summary
epydoc.markup.plaintext.ParsedPlaintextDocstring.summary
epydoc.markup.restructuredtext.ParsedRstDocstring.summary" class="py-name" href="#" onclick="return doclink('link-643', 'summary', 'link-642');">summary</a></tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">=</tt><tt class="py-number">6</tt><tt class="py-op">)</tt> </tt>
<a name="L2147"></a><tt class="py-lineno">2147</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-644" class="py-name"><a title="epydoc.apidoc.APIDoc.summary
epydoc.docwriter.html.HTMLWriter.summary
epydoc.markup.ConcatenatedDocstring.summary
epydoc.markup.ParsedDocstring.summary
epydoc.markup.epytext.ParsedEpytextDocstring.summary
epydoc.markup.javadoc.ParsedJavadocDocstring.summary
epydoc.markup.plaintext.ParsedPlaintextDocstring.summary
epydoc.markup.restructuredtext.ParsedRstDocstring.summary" class="py-name" href="#" onclick="return doclink('link-644', 'summary', 'link-642');">summary</a></tt><tt class="py-op">:</tt> <tt id="link-645" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.description" class="py-name" href="#" onclick="return doclink('link-645', 'description', 'link-620');">description</a></tt> <tt class="py-op">+=</tt> <tt class="py-string">'<br />\n %s'</tt> <tt class="py-op">%</tt> <tt id="link-646" class="py-name"><a title="epydoc.apidoc.APIDoc.summary
epydoc.docwriter.html.HTMLWriter.summary
epydoc.markup.ConcatenatedDocstring.summary
epydoc.markup.ParsedDocstring.summary
epydoc.markup.epytext.ParsedEpytextDocstring.summary
epydoc.markup.javadoc.ParsedJavadocDocstring.summary
epydoc.markup.plaintext.ParsedPlaintextDocstring.summary
epydoc.markup.restructuredtext.ParsedRstDocstring.summary" class="py-name" href="#" onclick="return doclink('link-646', 'summary', 'link-642');">summary</a></tt> </tt>
<a name="L2148"></a><tt class="py-lineno">2148</tt> <tt class="py-line"> </tt>
<a name="L2149"></a><tt class="py-lineno">2149</tt> <tt class="py-line"> <tt class="py-comment"># If it's inherited, then add a note to the description.</tt> </tt>
<a name="L2150"></a><tt class="py-lineno">2150</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-647" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-647', 'container', 'link-63');">container</a></tt> <tt class="py-op">!=</tt> <tt id="link-648" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-648', 'container', 'link-63');">container</a></tt> <tt class="py-keyword">and</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_inheritance</tt><tt class="py-op">==</tt><tt class="py-string">"included"</tt><tt class="py-op">:</tt> </tt>
<a name="L2151"></a><tt class="py-lineno">2151</tt> <tt class="py-line"> <tt id="link-649" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.description" class="py-name" href="#" onclick="return doclink('link-649', 'description', 'link-620');">description</a></tt> <tt class="py-op">+=</tt> <tt class="py-op">(</tt><tt class="py-string">"\n <em>(Inherited from "</tt> <tt class="py-op">+</tt> </tt>
<a name="L2152"></a><tt class="py-lineno">2152</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-650" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.href" class="py-name" href="#" onclick="return doclink('link-650', 'href', 'link-254');">href</a></tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-651" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-651', 'container', 'link-63');">container</a></tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-string">")</em>"</tt><tt class="py-op">)</tt> </tt>
<a name="L2153"></a><tt class="py-lineno">2153</tt> <tt class="py-line"> </tt>
<a name="L2154"></a><tt class="py-lineno">2154</tt> <tt class="py-line"> <tt class="py-comment"># Write the summary line.</tt> </tt>
<a name="L2155"></a><tt class="py-lineno">2155</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-652" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter._write_summary_line()=epydoc.docwriter.html.HTMLWriter-class.html#_write_summary_line"><a title="epydoc.docwriter.html.HTMLWriter._write_summary_line" class="py-name" href="#" onclick="return doclink('link-652', '_write_summary_line', 'link-652');">_write_summary_line</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">typ</tt><tt class="py-op">,</tt> <tt id="link-653" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.description" class="py-name" href="#" onclick="return doclink('link-653', 'description', 'link-620');">description</a></tt><tt class="py-op">,</tt> <tt class="py-name">tr_class</tt><tt class="py-op">,</tt> <tt id="link-654" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.pysrc_link" class="py-name" href="#" onclick="return doclink('link-654', 'pysrc_link', 'link-227');">pysrc_link</a></tt><tt class="py-op">,</tt> </tt>
<a name="L2156"></a><tt class="py-lineno">2156</tt> <tt class="py-line"> <tt class="py-name">callgraph</tt><tt class="py-op">)</tt> </tt>
</div><a name="L2157"></a><tt class="py-lineno">2157</tt> <tt class="py-line"> </tt>
<a name="L2158"></a><tt class="py-lineno">2158</tt> <tt class="py-line"> <tt id="link-655" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._write_summary_line" class="py-name" href="#" onclick="return doclink('link-655', '_write_summary_line', 'link-652');">_write_summary_line</a></tt> <tt class="py-op">=</tt> <tt id="link-656" class="py-name"><a title="epydoc.docwriter.html.compile_template" class="py-name" href="#" onclick="return doclink('link-656', 'compile_template', 'link-427');">compile_template</a></tt><tt class="py-op">(</tt> </tt>
<a name="L2159"></a><tt class="py-lineno">2159</tt> <tt class="py-line"> <tt class="py-string">"_write_summary_line(self, out, typ, description, tr_class, "</tt> </tt>
<a name="L2160"></a><tt class="py-lineno">2160</tt> <tt class="py-line"> <tt class="py-string">"pysrc_link, callgraph)"</tt><tt class="py-op">,</tt> </tt>
<a name="L2161"></a><tt class="py-lineno">2161</tt> <tt class="py-line"> <tt class="py-comment"># /------------------------- Template -------------------------\</tt> </tt>
<a name="L2162"></a><tt class="py-lineno">2162</tt> <tt class="py-line"> <tt class="py-string">'''</tt> </tt>
<a name="L2163"></a><tt class="py-lineno">2163</tt> <tt class="py-line"><tt class="py-string"> <tr$tr_class$></tt> </tt>
<a name="L2164"></a><tt class="py-lineno">2164</tt> <tt class="py-line"><tt class="py-string"> <td width="15%" align="right" valign="top" class="summary"></tt> </tt>
<a name="L2165"></a><tt class="py-lineno">2165</tt> <tt class="py-line"><tt class="py-string"> <span class="summary-type">$typ or "&nbsp;"$</span></tt> </tt>
<a name="L2166"></a><tt class="py-lineno">2166</tt> <tt class="py-line"><tt class="py-string"> </td><td class="summary"></tt> </tt>
<a name="L2167"></a><tt class="py-lineno">2167</tt> <tt class="py-line"><tt class="py-string"> >>> if pysrc_link is not None or callgraph is not None:</tt> </tt>
<a name="L2168"></a><tt class="py-lineno">2168</tt> <tt class="py-line"><tt class="py-string"> <table width="100%" cellpadding="0" cellspacing="0" border="0"></tt> </tt>
<a name="L2169"></a><tt class="py-lineno">2169</tt> <tt class="py-line"><tt class="py-string"> <tr></tt> </tt>
<a name="L2170"></a><tt class="py-lineno">2170</tt> <tt class="py-line"><tt class="py-string"> <td>$description$</td></tt> </tt>
<a name="L2171"></a><tt class="py-lineno">2171</tt> <tt class="py-line"><tt class="py-string"> <td align="right" valign="top"></tt> </tt>
<a name="L2172"></a><tt class="py-lineno">2172</tt> <tt class="py-line"><tt class="py-string"> $pysrc_link$</tt> </tt>
<a name="L2173"></a><tt class="py-lineno">2173</tt> <tt class="py-line"><tt class="py-string"> $self.callgraph_link(callgraph, token='-summary')$</tt> </tt>
<a name="L2174"></a><tt class="py-lineno">2174</tt> <tt class="py-line"><tt class="py-string"> </td></tt> </tt>
<a name="L2175"></a><tt class="py-lineno">2175</tt> <tt class="py-line"><tt class="py-string"> </tr></tt> </tt>
<a name="L2176"></a><tt class="py-lineno">2176</tt> <tt class="py-line"><tt class="py-string"> </table></tt> </tt>
<a name="L2177"></a><tt class="py-lineno">2177</tt> <tt class="py-line"><tt class="py-string"> $self.render_callgraph(callgraph, token='-summary')$</tt> </tt>
<a name="L2178"></a><tt class="py-lineno">2178</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L2179"></a><tt class="py-lineno">2179</tt> <tt class="py-line"><tt class="py-string"> >>> if pysrc_link is None and callgraph is None:</tt> </tt>
<a name="L2180"></a><tt class="py-lineno">2180</tt> <tt class="py-line"><tt class="py-string"> $description$</tt> </tt>
<a name="L2181"></a><tt class="py-lineno">2181</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L2182"></a><tt class="py-lineno">2182</tt> <tt class="py-line"><tt class="py-string"> </td></tt> </tt>
<a name="L2183"></a><tt class="py-lineno">2183</tt> <tt class="py-line"><tt class="py-string"> </tr></tt> </tt>
<a name="L2184"></a><tt class="py-lineno">2184</tt> <tt class="py-line"><tt class="py-string"> '''</tt><tt class="py-op">)</tt> </tt>
<a name="L2185"></a><tt class="py-lineno">2185</tt> <tt class="py-line"> <tt class="py-comment"># \------------------------------------------------------------/</tt> </tt>
<a name="L2186"></a><tt class="py-lineno">2186</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L2187"></a><tt class="py-lineno">2187</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L2188"></a><tt class="py-lineno">2188</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ 3.6. Details Lists</tt> </tt>
<a name="L2189"></a><tt class="py-lineno">2189</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L2190"></a><tt class="py-lineno">2190</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="HTMLWriter.write_details_list"></a><div id="HTMLWriter.write_details_list-def"><a name="L2191"></a><tt class="py-lineno">2191</tt> <a class="py-toggle" href="#" id="HTMLWriter.write_details_list-toggle" onclick="return toggle('HTMLWriter.write_details_list');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write_details_list">write_details_list</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">heading</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">,</tt> <tt class="py-param">value_type</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write_details_list-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write_details_list-expanded"><a name="L2192"></a><tt class="py-lineno">2192</tt> <tt class="py-line"> <tt class="py-comment"># Get a list of the VarDocs we should describe.</tt> </tt>
<a name="L2193"></a><tt class="py-lineno">2193</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_redundant_details</tt><tt class="py-op">:</tt> </tt>
<a name="L2194"></a><tt class="py-lineno">2194</tt> <tt class="py-line"> <tt class="py-name">detailed</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L2195"></a><tt class="py-lineno">2195</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2196"></a><tt class="py-lineno">2196</tt> <tt class="py-line"> <tt class="py-name">detailed</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L2197"></a><tt class="py-lineno">2197</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-657" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-657', 'ClassDoc', 'link-56');">ClassDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2198"></a><tt class="py-lineno">2198</tt> <tt class="py-line"> <tt class="py-name">var_docs</tt> <tt class="py-op">=</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-658" class="py-name"><a title="epydoc.apidoc.ClassDoc.select_variables
epydoc.apidoc.ModuleDoc.select_variables" class="py-name" href="#" onclick="return doclink('link-658', 'select_variables', 'link-444');">select_variables</a></tt><tt class="py-op">(</tt><tt class="py-name">value_type</tt><tt class="py-op">=</tt><tt class="py-name">value_type</tt><tt class="py-op">,</tt> </tt>
<a name="L2199"></a><tt class="py-lineno">2199</tt> <tt class="py-line"> <tt class="py-name">imported</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-name">inherited</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L2200"></a><tt class="py-lineno">2200</tt> <tt class="py-line"> <tt class="py-name">public</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_public_filter</tt><tt class="py-op">,</tt> </tt>
<a name="L2201"></a><tt class="py-lineno">2201</tt> <tt class="py-line"> <tt class="py-name">detailed</tt><tt class="py-op">=</tt><tt class="py-name">detailed</tt><tt class="py-op">)</tt> </tt>
<a name="L2202"></a><tt class="py-lineno">2202</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2203"></a><tt class="py-lineno">2203</tt> <tt class="py-line"> <tt class="py-name">var_docs</tt> <tt class="py-op">=</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-659" class="py-name"><a title="epydoc.apidoc.ClassDoc.select_variables
epydoc.apidoc.ModuleDoc.select_variables" class="py-name" href="#" onclick="return doclink('link-659', 'select_variables', 'link-444');">select_variables</a></tt><tt class="py-op">(</tt><tt class="py-name">value_type</tt><tt class="py-op">=</tt><tt class="py-name">value_type</tt><tt class="py-op">,</tt> </tt>
<a name="L2204"></a><tt class="py-lineno">2204</tt> <tt class="py-line"> <tt class="py-name">imported</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L2205"></a><tt class="py-lineno">2205</tt> <tt class="py-line"> <tt class="py-name">public</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_public_filter</tt><tt class="py-op">,</tt> </tt>
<a name="L2206"></a><tt class="py-lineno">2206</tt> <tt class="py-line"> <tt class="py-name">detailed</tt><tt class="py-op">=</tt><tt class="py-name">detailed</tt><tt class="py-op">)</tt> </tt>
<a name="L2207"></a><tt class="py-lineno">2207</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">var_docs</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> </tt>
<a name="L2208"></a><tt class="py-lineno">2208</tt> <tt class="py-line"> </tt>
<a name="L2209"></a><tt class="py-lineno">2209</tt> <tt class="py-line"> <tt class="py-comment"># Write a header</tt> </tt>
<a name="L2210"></a><tt class="py-lineno">2210</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-660" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_table_header" class="py-name" href="#" onclick="return doclink('link-660', 'write_table_header', 'link-375');">write_table_header</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">"details"</tt><tt class="py-op">,</tt> <tt class="py-name">heading</tt><tt class="py-op">)</tt> </tt>
<a name="L2211"></a><tt class="py-lineno">2211</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-661" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.TABLE_FOOTER" class="py-name" href="#" onclick="return doclink('link-661', 'TABLE_FOOTER', 'link-581');">TABLE_FOOTER</a></tt><tt class="py-op">)</tt> </tt>
<a name="L2212"></a><tt class="py-lineno">2212</tt> <tt class="py-line"> </tt>
<a name="L2213"></a><tt class="py-lineno">2213</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_docs</tt><tt class="py-op">:</tt> </tt>
<a name="L2214"></a><tt class="py-lineno">2214</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-662" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_details_entry()=epydoc.docwriter.html.HTMLWriter-class.html#write_details_entry"><a title="epydoc.docwriter.html.HTMLWriter.write_details_entry" class="py-name" href="#" onclick="return doclink('link-662', 'write_details_entry', 'link-662');">write_details_entry</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">var_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L2215"></a><tt class="py-lineno">2215</tt> <tt class="py-line"> </tt>
<a name="L2216"></a><tt class="py-lineno">2216</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<br />\n'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L2217"></a><tt class="py-lineno">2217</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.write_details_entry"></a><div id="HTMLWriter.write_details_entry-def"><a name="L2218"></a><tt class="py-lineno">2218</tt> <a class="py-toggle" href="#" id="HTMLWriter.write_details_entry-toggle" onclick="return toggle('HTMLWriter.write_details_entry');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write_details_entry">write_details_entry</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">var_doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write_details_entry-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write_details_entry-expanded"><a name="L2219"></a><tt class="py-lineno">2219</tt> <tt class="py-line"> <tt id="link-663" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-663', 'descr', 'link-228');">descr</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-664" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-664', 'descr', 'link-228');">descr</a></tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">=</tt><tt class="py-number">2</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-string">''</tt> </tt>
<a name="L2220"></a><tt class="py-lineno">2220</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-665" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_public" class="py-name" href="#" onclick="return doclink('link-665', 'is_public', 'link-578');">is_public</a></tt><tt class="py-op">:</tt> <tt class="py-name">div_class</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
<a name="L2221"></a><tt class="py-lineno">2221</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-name">div_class</tt> <tt class="py-op">=</tt> <tt class="py-string">' class="private"'</tt> </tt>
<a name="L2222"></a><tt class="py-lineno">2222</tt> <tt class="py-line"> </tt>
<a name="L2223"></a><tt class="py-lineno">2223</tt> <tt class="py-line"> <tt class="py-comment"># Functions</tt> </tt>
<a name="L2224"></a><tt class="py-lineno">2224</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-666" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-666', 'value', 'link-61');">value</a></tt><tt class="py-op">,</tt> <tt id="link-667" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-667', 'RoutineDoc', 'link-57');">RoutineDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2225"></a><tt class="py-lineno">2225</tt> <tt class="py-line"> <tt class="py-name">rtype</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-668" class="py-name"><a title="epydoc.apidoc.RoutineDoc.return_type
epydoc.docwriter.html.HTMLWriter.return_type" class="py-name" href="#" onclick="return doclink('link-668', 'return_type', 'link-619');">return_type</a></tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">=</tt><tt class="py-number">10</tt><tt class="py-op">)</tt> </tt>
<a name="L2226"></a><tt class="py-lineno">2226</tt> <tt class="py-line"> <tt class="py-name">rdescr</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-669" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.return_descr=epydoc.apidoc.RoutineDoc-class.html#return_descr,Method epydoc.docwriter.html.HTMLWriter.return_descr()=epydoc.docwriter.html.HTMLWriter-class.html#return_descr"><a title="epydoc.apidoc.RoutineDoc.return_descr
epydoc.docwriter.html.HTMLWriter.return_descr" class="py-name" href="#" onclick="return doclink('link-669', 'return_descr', 'link-669');">return_descr</a></tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">=</tt><tt class="py-number">10</tt><tt class="py-op">)</tt> </tt>
<a name="L2227"></a><tt class="py-lineno">2227</tt> <tt class="py-line"> <tt id="link-670" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.arg_descrs=epydoc.apidoc.RoutineDoc-class.html#arg_descrs"><a title="epydoc.apidoc.RoutineDoc.arg_descrs" class="py-name" href="#" onclick="return doclink('link-670', 'arg_descrs', 'link-670');">arg_descrs</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L2228"></a><tt class="py-lineno">2228</tt> <tt class="py-line"> <tt class="py-name">args</tt> <tt class="py-op">=</tt> <tt class="py-name">set</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L2229"></a><tt class="py-lineno">2229</tt> <tt class="py-line"> <tt class="py-comment"># Find the description for each arg. (Leave them in the</tt> </tt>
<a name="L2230"></a><tt class="py-lineno">2230</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># same order that they're listed in the docstring.)</tt> </tt>
<a name="L2231"></a><tt class="py-lineno">2231</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt class="py-name">arg_names</tt><tt class="py-op">,</tt> <tt class="py-name">arg_descr</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-671" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-671', 'value', 'link-61');">value</a></tt><tt class="py-op">.</tt><tt id="link-672" class="py-name"><a title="epydoc.apidoc.RoutineDoc.arg_descrs" class="py-name" href="#" onclick="return doclink('link-672', 'arg_descrs', 'link-670');">arg_descrs</a></tt><tt class="py-op">:</tt> </tt>
<a name="L2232"></a><tt class="py-lineno">2232</tt> <tt class="py-line"> <tt class="py-name">args</tt><tt class="py-op">.</tt><tt class="py-name">update</tt><tt class="py-op">(</tt><tt class="py-name">arg_names</tt><tt class="py-op">)</tt> </tt>
<a name="L2233"></a><tt class="py-lineno">2233</tt> <tt class="py-line"> <tt class="py-name">lhs</tt> <tt class="py-op">=</tt> <tt class="py-string">', '</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-673" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.arg_name_to_html()=epydoc.docwriter.html.HTMLWriter-class.html#arg_name_to_html"><a title="epydoc.docwriter.html.HTMLWriter.arg_name_to_html" class="py-name" href="#" onclick="return doclink('link-673', 'arg_name_to_html', 'link-673');">arg_name_to_html</a></tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-674" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-674', 'value', 'link-61');">value</a></tt><tt class="py-op">,</tt> <tt class="py-name">n</tt><tt class="py-op">)</tt> </tt>
<a name="L2234"></a><tt class="py-lineno">2234</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">n</tt> <tt class="py-keyword">in</tt> <tt class="py-name">arg_names</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L2235"></a><tt class="py-lineno">2235</tt> <tt class="py-line"> <tt class="py-name">rhs</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-675" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.docstring_to_html" class="py-name" href="#" onclick="return doclink('link-675', 'docstring_to_html', 'link-383');">docstring_to_html</a></tt><tt class="py-op">(</tt><tt class="py-name">arg_descr</tt><tt class="py-op">,</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-676" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-676', 'value', 'link-61');">value</a></tt><tt class="py-op">,</tt> <tt class="py-number">10</tt><tt class="py-op">)</tt> </tt>
<a name="L2236"></a><tt class="py-lineno">2236</tt> <tt class="py-line"> <tt id="link-677" class="py-name"><a title="epydoc.apidoc.RoutineDoc.arg_descrs" class="py-name" href="#" onclick="return doclink('link-677', 'arg_descrs', 'link-670');">arg_descrs</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt> <tt class="py-op">(</tt><tt class="py-name">lhs</tt><tt class="py-op">,</tt> <tt class="py-name">rhs</tt><tt class="py-op">)</tt> <tt class="py-op">)</tt> </tt>
<a name="L2237"></a><tt class="py-lineno">2237</tt> <tt class="py-line"> <tt class="py-comment"># Check for arguments for which we have @type but not @param;</tt> </tt>
<a name="L2238"></a><tt class="py-lineno">2238</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># and add them to the arg_descrs list.</tt> </tt>
<a name="L2239"></a><tt class="py-lineno">2239</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt id="link-678" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-678', 'arg', 'link-370');">arg</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-679" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-679', 'value', 'link-61');">value</a></tt><tt class="py-op">.</tt><tt id="link-680" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.arg_types=epydoc.apidoc.RoutineDoc-class.html#arg_types"><a title="epydoc.apidoc.RoutineDoc.arg_types" class="py-name" href="#" onclick="return doclink('link-680', 'arg_types', 'link-680');">arg_types</a></tt><tt class="py-op">:</tt> </tt>
<a name="L2240"></a><tt class="py-lineno">2240</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-681" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-681', 'arg', 'link-370');">arg</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">args</tt><tt class="py-op">:</tt> </tt>
<a name="L2241"></a><tt class="py-lineno">2241</tt> <tt class="py-line"> <tt class="py-name">argname</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-682" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.arg_name_to_html" class="py-name" href="#" onclick="return doclink('link-682', 'arg_name_to_html', 'link-673');">arg_name_to_html</a></tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-683" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-683', 'value', 'link-61');">value</a></tt><tt class="py-op">,</tt> <tt id="link-684" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-684', 'arg', 'link-370');">arg</a></tt><tt class="py-op">)</tt> </tt>
<a name="L2242"></a><tt class="py-lineno">2242</tt> <tt class="py-line"> <tt id="link-685" class="py-name"><a title="epydoc.apidoc.RoutineDoc.arg_descrs" class="py-name" href="#" onclick="return doclink('link-685', 'arg_descrs', 'link-670');">arg_descrs</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt> <tt class="py-op">(</tt><tt class="py-name">argname</tt><tt class="py-op">,</tt><tt class="py-string">''</tt><tt class="py-op">)</tt> <tt class="py-op">)</tt> </tt>
<a name="L2243"></a><tt class="py-lineno">2243</tt> <tt class="py-line"> </tt>
<a name="L2244"></a><tt class="py-lineno">2244</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-686" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_function_details_entry()=epydoc.docwriter.html.HTMLWriter-class.html#write_function_details_entry"><a title="epydoc.docwriter.html.HTMLWriter.write_function_details_entry" class="py-name" href="#" onclick="return doclink('link-686', 'write_function_details_entry', 'link-686');">write_function_details_entry</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">var_doc</tt><tt class="py-op">,</tt> <tt id="link-687" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-687', 'descr', 'link-228');">descr</a></tt><tt class="py-op">,</tt> </tt>
<a name="L2245"></a><tt class="py-lineno">2245</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-688" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-688', 'value', 'link-61');">value</a></tt><tt class="py-op">.</tt><tt id="link-689" class="py-name"><a title="epydoc.apidoc.RoutineDoc.callgraph_uid" class="py-name" href="#" onclick="return doclink('link-689', 'callgraph_uid', 'link-630');">callgraph_uid</a></tt><tt class="py-op">,</tt> </tt>
<a name="L2246"></a><tt class="py-lineno">2246</tt> <tt class="py-line"> <tt class="py-name">rtype</tt><tt class="py-op">,</tt> <tt class="py-name">rdescr</tt><tt class="py-op">,</tt> <tt id="link-690" class="py-name"><a title="epydoc.apidoc.RoutineDoc.arg_descrs" class="py-name" href="#" onclick="return doclink('link-690', 'arg_descrs', 'link-670');">arg_descrs</a></tt><tt class="py-op">,</tt> </tt>
<a name="L2247"></a><tt class="py-lineno">2247</tt> <tt class="py-line"> <tt class="py-name">div_class</tt><tt class="py-op">)</tt> </tt>
<a name="L2248"></a><tt class="py-lineno">2248</tt> <tt class="py-line"> </tt>
<a name="L2249"></a><tt class="py-lineno">2249</tt> <tt class="py-line"> <tt class="py-comment"># Properties</tt> </tt>
<a name="L2250"></a><tt class="py-lineno">2250</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-691" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-691', 'value', 'link-61');">value</a></tt><tt class="py-op">,</tt> <tt id="link-692" class="py-name" targets="Class epydoc.apidoc.PropertyDoc=epydoc.apidoc.PropertyDoc-class.html"><a title="epydoc.apidoc.PropertyDoc" class="py-name" href="#" onclick="return doclink('link-692', 'PropertyDoc', 'link-692');">PropertyDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2251"></a><tt class="py-lineno">2251</tt> <tt class="py-line"> <tt class="py-name">prop_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-693" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-693', 'value', 'link-61');">value</a></tt> </tt>
<a name="L2252"></a><tt class="py-lineno">2252</tt> <tt class="py-line"> <tt class="py-name">accessors</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt> <tt class="py-op">(</tt><tt id="link-694" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-694', 'name', 'link-117');">name</a></tt><tt class="py-op">,</tt> </tt>
<a name="L2253"></a><tt class="py-lineno">2253</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-695" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.property_accessor_to_html()=epydoc.docwriter.html.HTMLWriter-class.html#property_accessor_to_html"><a title="epydoc.docwriter.html.HTMLWriter.property_accessor_to_html" class="py-name" href="#" onclick="return doclink('link-695', 'property_accessor_to_html', 'link-695');">property_accessor_to_html</a></tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt class="py-name">prop_doc</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L2254"></a><tt class="py-lineno">2254</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-696" class="py-name"><a title="epydoc.apidoc.APIDoc.summary
epydoc.docwriter.html.HTMLWriter.summary
epydoc.markup.ConcatenatedDocstring.summary
epydoc.markup.ParsedDocstring.summary
epydoc.markup.epytext.ParsedEpytextDocstring.summary
epydoc.markup.javadoc.ParsedJavadocDocstring.summary
epydoc.markup.plaintext.ParsedPlaintextDocstring.summary
epydoc.markup.restructuredtext.ParsedRstDocstring.summary" class="py-name" href="#" onclick="return doclink('link-696', 'summary', 'link-642');">summary</a></tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L2255"></a><tt class="py-lineno">2255</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt id="link-697" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-697', 'name', 'link-117');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">val_doc</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> </tt>
<a name="L2256"></a><tt class="py-lineno">2256</tt> <tt class="py-line"> <tt class="py-op">[</tt><tt class="py-op">(</tt><tt class="py-string">'Get'</tt><tt class="py-op">,</tt> <tt class="py-name">prop_doc</tt><tt class="py-op">.</tt><tt id="link-698" class="py-name" targets="Variable epydoc.apidoc.PropertyDoc.fget=epydoc.apidoc.PropertyDoc-class.html#fget"><a title="epydoc.apidoc.PropertyDoc.fget" class="py-name" href="#" onclick="return doclink('link-698', 'fget', 'link-698');">fget</a></tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-string">'Set'</tt><tt class="py-op">,</tt> <tt class="py-name">prop_doc</tt><tt class="py-op">.</tt><tt id="link-699" class="py-name" targets="Variable epydoc.apidoc.PropertyDoc.fset=epydoc.apidoc.PropertyDoc-class.html#fset"><a title="epydoc.apidoc.PropertyDoc.fset" class="py-name" href="#" onclick="return doclink('link-699', 'fset', 'link-699');">fset</a></tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L2257"></a><tt class="py-lineno">2257</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'Delete'</tt><tt class="py-op">,</tt> <tt class="py-name">prop_doc</tt><tt class="py-op">.</tt><tt id="link-700" class="py-name" targets="Variable epydoc.apidoc.PropertyDoc.fdel=epydoc.apidoc.PropertyDoc-class.html#fdel"><a title="epydoc.apidoc.PropertyDoc.fdel" class="py-name" href="#" onclick="return doclink('link-700', 'fdel', 'link-700');">fdel</a></tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L2258"></a><tt class="py-lineno">2258</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">val_doc</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-701" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-701', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">)</tt> </tt>
<a name="L2259"></a><tt class="py-lineno">2259</tt> <tt class="py-line"> <tt class="py-keyword">and</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-702" class="py-name" targets="Variable epydoc.apidoc.ValueDoc.pyval=epydoc.apidoc.ValueDoc-class.html#pyval"><a title="epydoc.apidoc.ValueDoc.pyval" class="py-name" href="#" onclick="return doclink('link-702', 'pyval', 'link-702');">pyval</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> <tt class="py-op">]</tt> </tt>
<a name="L2260"></a><tt class="py-lineno">2260</tt> <tt class="py-line"> </tt>
<a name="L2261"></a><tt class="py-lineno">2261</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-703" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_property_details_entry()=epydoc.docwriter.html.HTMLWriter-class.html#write_property_details_entry"><a title="epydoc.docwriter.html.HTMLWriter.write_property_details_entry" class="py-name" href="#" onclick="return doclink('link-703', 'write_property_details_entry', 'link-703');">write_property_details_entry</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">var_doc</tt><tt class="py-op">,</tt> <tt id="link-704" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-704', 'descr', 'link-228');">descr</a></tt><tt class="py-op">,</tt> </tt>
<a name="L2262"></a><tt class="py-lineno">2262</tt> <tt class="py-line"> <tt class="py-name">accessors</tt><tt class="py-op">,</tt> <tt class="py-name">div_class</tt><tt class="py-op">)</tt> </tt>
<a name="L2263"></a><tt class="py-lineno">2263</tt> <tt class="py-line"> </tt>
<a name="L2264"></a><tt class="py-lineno">2264</tt> <tt class="py-line"> <tt class="py-comment"># Variables</tt> </tt>
<a name="L2265"></a><tt class="py-lineno">2265</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2266"></a><tt class="py-lineno">2266</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-705" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_variable_details_entry()=epydoc.docwriter.html.HTMLWriter-class.html#write_variable_details_entry"><a title="epydoc.docwriter.html.HTMLWriter.write_variable_details_entry" class="py-name" href="#" onclick="return doclink('link-705', 'write_variable_details_entry', 'link-705');">write_variable_details_entry</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">var_doc</tt><tt class="py-op">,</tt> <tt id="link-706" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-706', 'descr', 'link-228');">descr</a></tt><tt class="py-op">,</tt> <tt class="py-name">div_class</tt><tt class="py-op">)</tt> </tt>
</div><a name="L2267"></a><tt class="py-lineno">2267</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.labelled_list_item"></a><div id="HTMLWriter.labelled_list_item-def"><a name="L2268"></a><tt class="py-lineno">2268</tt> <a class="py-toggle" href="#" id="HTMLWriter.labelled_list_item-toggle" onclick="return toggle('HTMLWriter.labelled_list_item');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#labelled_list_item">labelled_list_item</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">lhs</tt><tt class="py-op">,</tt> <tt class="py-param">rhs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.labelled_list_item-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.labelled_list_item-expanded"><a name="L2269"></a><tt class="py-lineno">2269</tt> <tt class="py-line"> <tt class="py-comment"># If the RHS starts with a paragraph, then move the</tt> </tt>
<a name="L2270"></a><tt class="py-lineno">2270</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># paragraph-start tag to the beginning of the lhs instead (so</tt> </tt>
<a name="L2271"></a><tt class="py-lineno">2271</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># there won't be a line break after the '-').</tt> </tt>
<a name="L2272"></a><tt class="py-lineno">2272</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">m</tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-string">r'^<p( [^>]+)?>'</tt><tt class="py-op">,</tt> <tt class="py-name">rhs</tt><tt class="py-op">)</tt> </tt>
<a name="L2273"></a><tt class="py-lineno">2273</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">m</tt><tt class="py-op">:</tt> </tt>
<a name="L2274"></a><tt class="py-lineno">2274</tt> <tt class="py-line"> <tt class="py-name">lhs</tt> <tt class="py-op">=</tt> <tt class="py-name">m</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-name">lhs</tt> </tt>
<a name="L2275"></a><tt class="py-lineno">2275</tt> <tt class="py-line"> <tt class="py-name">rhs</tt> <tt class="py-op">=</tt> <tt class="py-name">rhs</tt><tt class="py-op">[</tt><tt class="py-name">m</tt><tt class="py-op">.</tt><tt class="py-name">end</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L2276"></a><tt class="py-lineno">2276</tt> <tt class="py-line"> </tt>
<a name="L2277"></a><tt class="py-lineno">2277</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">rhs</tt><tt class="py-op">:</tt> </tt>
<a name="L2278"></a><tt class="py-lineno">2278</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'<li>%s - %s</li>'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">lhs</tt><tt class="py-op">,</tt> <tt class="py-name">rhs</tt><tt class="py-op">)</tt> </tt>
<a name="L2279"></a><tt class="py-lineno">2279</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2280"></a><tt class="py-lineno">2280</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'<li>%s</li>'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">lhs</tt><tt class="py-op">,</tt><tt class="py-op">)</tt> </tt>
</div><a name="L2281"></a><tt class="py-lineno">2281</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.property_accessor_to_html"></a><div id="HTMLWriter.property_accessor_to_html-def"><a name="L2282"></a><tt class="py-lineno">2282</tt> <a class="py-toggle" href="#" id="HTMLWriter.property_accessor_to_html-toggle" onclick="return toggle('HTMLWriter.property_accessor_to_html');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#property_accessor_to_html">property_accessor_to_html</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">val_doc</tt><tt class="py-op">,</tt> <tt class="py-param">context</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.property_accessor_to_html-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.property_accessor_to_html-expanded"><a name="L2283"></a><tt class="py-lineno">2283</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">val_doc</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-707" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-707', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2284"></a><tt class="py-lineno">2284</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt id="link-708" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-708', 'RoutineDoc', 'link-57');">RoutineDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2285"></a><tt class="py-lineno">2285</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-709" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.function_signature
epydoc.docwriter.latex.LatexWriter.function_signature" class="py-name" href="#" onclick="return doclink('link-709', 'function_signature', 'link-621');">function_signature</a></tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt class="py-name">is_summary</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> </tt>
<a name="L2286"></a><tt class="py-lineno">2286</tt> <tt class="py-line"> <tt class="py-name">link_name</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">=</tt><tt class="py-name">context</tt><tt class="py-op">)</tt> </tt>
<a name="L2287"></a><tt class="py-lineno">2287</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt id="link-710" class="py-name"><a title="epydoc.apidoc.GenericValueDoc" class="py-name" href="#" onclick="return doclink('link-710', 'GenericValueDoc', 'link-58');">GenericValueDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2288"></a><tt class="py-lineno">2288</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-711" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.pprint_value()=epydoc.docwriter.html.HTMLWriter-class.html#pprint_value"><a title="epydoc.docwriter.html.HTMLWriter.pprint_value" class="py-name" href="#" onclick="return doclink('link-711', 'pprint_value', 'link-711');">pprint_value</a></tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L2289"></a><tt class="py-lineno">2289</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2290"></a><tt class="py-lineno">2290</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-712" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.href" class="py-name" href="#" onclick="return doclink('link-712', 'href', 'link-254');">href</a></tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">=</tt><tt class="py-name">context</tt><tt class="py-op">)</tt> </tt>
<a name="L2291"></a><tt class="py-lineno">2291</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2292"></a><tt class="py-lineno">2292</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'??'</tt> </tt>
</div><a name="L2293"></a><tt class="py-lineno">2293</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.arg_name_to_html"></a><div id="HTMLWriter.arg_name_to_html-def"><a name="L2294"></a><tt class="py-lineno">2294</tt> <a class="py-toggle" href="#" id="HTMLWriter.arg_name_to_html-toggle" onclick="return toggle('HTMLWriter.arg_name_to_html');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#arg_name_to_html">arg_name_to_html</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">func_doc</tt><tt class="py-op">,</tt> <tt class="py-param">arg_name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.arg_name_to_html-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.arg_name_to_html-expanded"><a name="L2295"></a><tt class="py-lineno">2295</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L2296"></a><tt class="py-lineno">2296</tt> <tt class="py-line"><tt class="py-docstring"> A helper function used to format an argument name, for use in</tt> </tt>
<a name="L2297"></a><tt class="py-lineno">2297</tt> <tt class="py-line"><tt class="py-docstring"> the argument description list under a routine's details entry.</tt> </tt>
<a name="L2298"></a><tt class="py-lineno">2298</tt> <tt class="py-line"><tt class="py-docstring"> This just wraps strong & code tags around the arg name; and if</tt> </tt>
<a name="L2299"></a><tt class="py-lineno">2299</tt> <tt class="py-line"><tt class="py-docstring"> the arg name is associated with a type, then adds it</tt> </tt>
<a name="L2300"></a><tt class="py-lineno">2300</tt> <tt class="py-line"><tt class="py-docstring"> parenthetically after the name.</tt> </tt>
<a name="L2301"></a><tt class="py-lineno">2301</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L2302"></a><tt class="py-lineno">2302</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">=</tt> <tt class="py-string">'<strong class="pname"><code>%s</code></strong>'</tt> <tt class="py-op">%</tt> <tt class="py-name">arg_name</tt> </tt>
<a name="L2303"></a><tt class="py-lineno">2303</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">arg_name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-713" class="py-name"><a title="epydoc.apidoc.RoutineDoc.arg_types" class="py-name" href="#" onclick="return doclink('link-713', 'arg_types', 'link-680');">arg_types</a></tt><tt class="py-op">:</tt> </tt>
<a name="L2304"></a><tt class="py-lineno">2304</tt> <tt class="py-line"> <tt class="py-name">typ</tt> <tt class="py-op">=</tt> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-714" class="py-name"><a title="epydoc.apidoc.RoutineDoc.arg_types" class="py-name" href="#" onclick="return doclink('link-714', 'arg_types', 'link-680');">arg_types</a></tt><tt class="py-op">[</tt><tt class="py-name">arg_name</tt><tt class="py-op">]</tt> </tt>
<a name="L2305"></a><tt class="py-lineno">2305</tt> <tt class="py-line"> <tt class="py-name">typ_html</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-715" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.docstring_to_html" class="py-name" href="#" onclick="return doclink('link-715', 'docstring_to_html', 'link-383');">docstring_to_html</a></tt><tt class="py-op">(</tt><tt class="py-name">typ</tt><tt class="py-op">,</tt> <tt class="py-name">func_doc</tt><tt class="py-op">,</tt> <tt class="py-number">10</tt><tt class="py-op">)</tt> </tt>
<a name="L2306"></a><tt class="py-lineno">2306</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">+=</tt> <tt class="py-string">" (%s)"</tt> <tt class="py-op">%</tt> <tt class="py-name">typ_html</tt> </tt>
<a name="L2307"></a><tt class="py-lineno">2307</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">s</tt> </tt>
</div><a name="L2308"></a><tt class="py-lineno">2308</tt> <tt class="py-line"> </tt>
<a name="L2309"></a><tt class="py-lineno">2309</tt> <tt class="py-line"> <tt id="link-716" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_function_details_entry" class="py-name" href="#" onclick="return doclink('link-716', 'write_function_details_entry', 'link-686');">write_function_details_entry</a></tt> <tt class="py-op">=</tt> <tt id="link-717" class="py-name"><a title="epydoc.docwriter.html.compile_template" class="py-name" href="#" onclick="return doclink('link-717', 'compile_template', 'link-427');">compile_template</a></tt><tt class="py-op">(</tt> </tt>
<a name="L2310"></a><tt class="py-lineno">2310</tt> <tt class="py-line"> <tt class="py-string">'''</tt> </tt>
<a name="L2311"></a><tt class="py-lineno">2311</tt> <tt class="py-line"><tt class="py-string"> write_function_details_entry(self, out, var_doc, descr, callgraph, \</tt> </tt>
<a name="L2312"></a><tt class="py-lineno">2312</tt> <tt class="py-line"><tt class="py-string"> rtype, rdescr, arg_descrs, div_class)</tt> </tt>
<a name="L2313"></a><tt class="py-lineno">2313</tt> <tt class="py-line"><tt class="py-string"> '''</tt><tt class="py-op">,</tt> </tt>
<a name="L2314"></a><tt class="py-lineno">2314</tt> <tt class="py-line"> <tt class="py-comment"># /------------------------- Template -------------------------\</tt> </tt>
<a name="L2315"></a><tt class="py-lineno">2315</tt> <tt class="py-line"> <tt class="py-string">'''</tt> </tt>
<a name="L2316"></a><tt class="py-lineno">2316</tt> <tt class="py-line"><tt class="py-string"> >>> func_doc = var_doc.value</tt> </tt>
<a name="L2317"></a><tt class="py-lineno">2317</tt> <tt class="py-line"><tt class="py-string"> <a name="$var_doc.name$"></a></tt> </tt>
<a name="L2318"></a><tt class="py-lineno">2318</tt> <tt class="py-line"><tt class="py-string"> <div$div_class$></tt> </tt>
<a name="L2319"></a><tt class="py-lineno">2319</tt> <tt class="py-line"><tt class="py-string"> >>> self.write_table_header(out, "details")</tt> </tt>
<a name="L2320"></a><tt class="py-lineno">2320</tt> <tt class="py-line"><tt class="py-string"> <tr><td></tt> </tt>
<a name="L2321"></a><tt class="py-lineno">2321</tt> <tt class="py-line"><tt class="py-string"> <table width="100%" cellpadding="0" cellspacing="0" border="0"></tt> </tt>
<a name="L2322"></a><tt class="py-lineno">2322</tt> <tt class="py-line"><tt class="py-string"> <tr valign="top"><td></tt> </tt>
<a name="L2323"></a><tt class="py-lineno">2323</tt> <tt class="py-line"><tt class="py-string"> <h3 class="epydoc">$self.function_signature(var_doc)$</tt> </tt>
<a name="L2324"></a><tt class="py-lineno">2324</tt> <tt class="py-line"><tt class="py-string"> >>> if var_doc.name in self.SPECIAL_METHODS:</tt> </tt>
<a name="L2325"></a><tt class="py-lineno">2325</tt> <tt class="py-line"><tt class="py-string"> <br /><em class="fname">($self.SPECIAL_METHODS[var_doc.name]$)</em></tt> </tt>
<a name="L2326"></a><tt class="py-lineno">2326</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L2327"></a><tt class="py-lineno">2327</tt> <tt class="py-line"><tt class="py-string"> >>> if isinstance(func_doc, ClassMethodDoc):</tt> </tt>
<a name="L2328"></a><tt class="py-lineno">2328</tt> <tt class="py-line"><tt class="py-string"> <br /><em class="fname">Class Method</em></tt> </tt>
<a name="L2329"></a><tt class="py-lineno">2329</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L2330"></a><tt class="py-lineno">2330</tt> <tt class="py-line"><tt class="py-string"> >>> if isinstance(func_doc, StaticMethodDoc):</tt> </tt>
<a name="L2331"></a><tt class="py-lineno">2331</tt> <tt class="py-line"><tt class="py-string"> <br /><em class="fname">Static Method</em></tt> </tt>
<a name="L2332"></a><tt class="py-lineno">2332</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L2333"></a><tt class="py-lineno">2333</tt> <tt class="py-line"><tt class="py-string"> </h3></tt> </tt>
<a name="L2334"></a><tt class="py-lineno">2334</tt> <tt class="py-line"><tt class="py-string"> </td><td align="right" valign="top"</tt> </tt>
<a name="L2335"></a><tt class="py-lineno">2335</tt> <tt class="py-line"><tt class="py-string"> >$self.pysrc_link(func_doc)$&nbsp;</tt> </tt>
<a name="L2336"></a><tt class="py-lineno">2336</tt> <tt class="py-line"><tt class="py-string"> $self.callgraph_link(callgraph)$</td></tt> </tt>
<a name="L2337"></a><tt class="py-lineno">2337</tt> <tt class="py-line"><tt class="py-string"> </tr></table></tt> </tt>
<a name="L2338"></a><tt class="py-lineno">2338</tt> <tt class="py-line"><tt class="py-string"> $self.render_callgraph(callgraph)$</tt> </tt>
<a name="L2339"></a><tt class="py-lineno">2339</tt> <tt class="py-line"><tt class="py-string"> $descr$</tt> </tt>
<a name="L2340"></a><tt class="py-lineno">2340</tt> <tt class="py-line"><tt class="py-string"> <dl class="fields"></tt> </tt>
<a name="L2341"></a><tt class="py-lineno">2341</tt> <tt class="py-line"><tt class="py-string"> >>> # === parameters ===</tt> </tt>
<a name="L2342"></a><tt class="py-lineno">2342</tt> <tt class="py-line"><tt class="py-string"> >>> if arg_descrs:</tt> </tt>
<a name="L2343"></a><tt class="py-lineno">2343</tt> <tt class="py-line"><tt class="py-string"> <dt>Parameters:</dt></tt> </tt>
<a name="L2344"></a><tt class="py-lineno">2344</tt> <tt class="py-line"><tt class="py-string"> <dd><ul class="nomargin-top"></tt> </tt>
<a name="L2345"></a><tt class="py-lineno">2345</tt> <tt class="py-line"><tt class="py-string"> >>> for lhs, rhs in arg_descrs:</tt> </tt>
<a name="L2346"></a><tt class="py-lineno">2346</tt> <tt class="py-line"><tt class="py-string"> $self.labelled_list_item(lhs, rhs)$</tt> </tt>
<a name="L2347"></a><tt class="py-lineno">2347</tt> <tt class="py-line"><tt class="py-string"> >>> #endfor</tt> </tt>
<a name="L2348"></a><tt class="py-lineno">2348</tt> <tt class="py-line"><tt class="py-string"> </ul></dd></tt> </tt>
<a name="L2349"></a><tt class="py-lineno">2349</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L2350"></a><tt class="py-lineno">2350</tt> <tt class="py-line"><tt class="py-string"> >>> # === return type ===</tt> </tt>
<a name="L2351"></a><tt class="py-lineno">2351</tt> <tt class="py-line"><tt class="py-string"> >>> if rdescr and rtype:</tt> </tt>
<a name="L2352"></a><tt class="py-lineno">2352</tt> <tt class="py-line"><tt class="py-string"> <dt>Returns: $rtype$</dt></tt> </tt>
<a name="L2353"></a><tt class="py-lineno">2353</tt> <tt class="py-line"><tt class="py-string"> <dd>$rdescr$</dd></tt> </tt>
<a name="L2354"></a><tt class="py-lineno">2354</tt> <tt class="py-line"><tt class="py-string"> >>> elif rdescr:</tt> </tt>
<a name="L2355"></a><tt class="py-lineno">2355</tt> <tt class="py-line"><tt class="py-string"> <dt>Returns:</dt></tt> </tt>
<a name="L2356"></a><tt class="py-lineno">2356</tt> <tt class="py-line"><tt class="py-string"> <dd>$rdescr$</dd></tt> </tt>
<a name="L2357"></a><tt class="py-lineno">2357</tt> <tt class="py-line"><tt class="py-string"> >>> elif rtype:</tt> </tt>
<a name="L2358"></a><tt class="py-lineno">2358</tt> <tt class="py-line"><tt class="py-string"> <dt>Returns: $rtype$</dt></tt> </tt>
<a name="L2359"></a><tt class="py-lineno">2359</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L2360"></a><tt class="py-lineno">2360</tt> <tt class="py-line"><tt class="py-string"> >>> # === decorators ===</tt> </tt>
<a name="L2361"></a><tt class="py-lineno">2361</tt> <tt class="py-line"><tt class="py-string"> >>> if func_doc.decorators not in (None, UNKNOWN):</tt> </tt>
<a name="L2362"></a><tt class="py-lineno">2362</tt> <tt class="py-line"><tt class="py-string"> >>> # (staticmethod & classmethod are already shown, above)</tt> </tt>
<a name="L2363"></a><tt class="py-lineno">2363</tt> <tt class="py-line"><tt class="py-string"> >>> decos = filter(lambda deco:</tt> </tt>
<a name="L2364"></a><tt class="py-lineno">2364</tt> <tt class="py-line"><tt class="py-string"> >>> not ((deco=="staticmethod" and</tt> </tt>
<a name="L2365"></a><tt class="py-lineno">2365</tt> <tt class="py-line"><tt class="py-string"> >>> isinstance(func_doc, StaticMethodDoc)) or</tt> </tt>
<a name="L2366"></a><tt class="py-lineno">2366</tt> <tt class="py-line"><tt class="py-string"> >>> (deco=="classmethod" and</tt> </tt>
<a name="L2367"></a><tt class="py-lineno">2367</tt> <tt class="py-line"><tt class="py-string"> >>> isinstance(func_doc, ClassMethodDoc))),</tt> </tt>
<a name="L2368"></a><tt class="py-lineno">2368</tt> <tt class="py-line"><tt class="py-string"> >>> func_doc.decorators)</tt> </tt>
<a name="L2369"></a><tt class="py-lineno">2369</tt> <tt class="py-line"><tt class="py-string"> >>> else:</tt> </tt>
<a name="L2370"></a><tt class="py-lineno">2370</tt> <tt class="py-line"><tt class="py-string"> >>> decos = None</tt> </tt>
<a name="L2371"></a><tt class="py-lineno">2371</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L2372"></a><tt class="py-lineno">2372</tt> <tt class="py-line"><tt class="py-string"> >>> if decos:</tt> </tt>
<a name="L2373"></a><tt class="py-lineno">2373</tt> <tt class="py-line"><tt class="py-string"> <dt>Decorators:</dt></tt> </tt>
<a name="L2374"></a><tt class="py-lineno">2374</tt> <tt class="py-line"><tt class="py-string"> <dd><ul class="nomargin-top"></tt> </tt>
<a name="L2375"></a><tt class="py-lineno">2375</tt> <tt class="py-line"><tt class="py-string"> >>> for deco in decos:</tt> </tt>
<a name="L2376"></a><tt class="py-lineno">2376</tt> <tt class="py-line"><tt class="py-string"> <li><code>@$deco$</code></li></tt> </tt>
<a name="L2377"></a><tt class="py-lineno">2377</tt> <tt class="py-line"><tt class="py-string"> >>> #endfor</tt> </tt>
<a name="L2378"></a><tt class="py-lineno">2378</tt> <tt class="py-line"><tt class="py-string"> </ul></dd></tt> </tt>
<a name="L2379"></a><tt class="py-lineno">2379</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L2380"></a><tt class="py-lineno">2380</tt> <tt class="py-line"><tt class="py-string"> >>> # === exceptions ===</tt> </tt>
<a name="L2381"></a><tt class="py-lineno">2381</tt> <tt class="py-line"><tt class="py-string"> >>> if func_doc.exception_descrs not in (None, UNKNOWN, (), []):</tt> </tt>
<a name="L2382"></a><tt class="py-lineno">2382</tt> <tt class="py-line"><tt class="py-string"> <dt>Raises:</dt></tt> </tt>
<a name="L2383"></a><tt class="py-lineno">2383</tt> <tt class="py-line"><tt class="py-string"> <dd><ul class="nomargin-top"></tt> </tt>
<a name="L2384"></a><tt class="py-lineno">2384</tt> <tt class="py-line"><tt class="py-string"> >>> for name, descr in func_doc.exception_descrs:</tt> </tt>
<a name="L2385"></a><tt class="py-lineno">2385</tt> <tt class="py-line"><tt class="py-string"> >>> exc_name = self.docindex.find(name, func_doc)</tt> </tt>
<a name="L2386"></a><tt class="py-lineno">2386</tt> <tt class="py-line"><tt class="py-string"> >>> if exc_name is not None:</tt> </tt>
<a name="L2387"></a><tt class="py-lineno">2387</tt> <tt class="py-line"><tt class="py-string"> >>> name = self.href(exc_name, label=str(name))</tt> </tt>
<a name="L2388"></a><tt class="py-lineno">2388</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L2389"></a><tt class="py-lineno">2389</tt> <tt class="py-line"><tt class="py-string"> $self.labelled_list_item(</tt> </tt>
<a name="L2390"></a><tt class="py-lineno">2390</tt> <tt class="py-line"><tt class="py-string"> "<code><strong class=\'fraise\'>" +</tt> </tt>
<a name="L2391"></a><tt class="py-lineno">2391</tt> <tt class="py-line"><tt class="py-string"> str(name) + "</strong></code>",</tt> </tt>
<a name="L2392"></a><tt class="py-lineno">2392</tt> <tt class="py-line"><tt class="py-string"> self.docstring_to_html(descr, func_doc, 8))$</tt> </tt>
<a name="L2393"></a><tt class="py-lineno">2393</tt> <tt class="py-line"><tt class="py-string"> >>> #endfor</tt> </tt>
<a name="L2394"></a><tt class="py-lineno">2394</tt> <tt class="py-line"><tt class="py-string"> </ul></dd></tt> </tt>
<a name="L2395"></a><tt class="py-lineno">2395</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L2396"></a><tt class="py-lineno">2396</tt> <tt class="py-line"><tt class="py-string"> >>> # === overrides ===</tt> </tt>
<a name="L2397"></a><tt class="py-lineno">2397</tt> <tt class="py-line"><tt class="py-string"> >>> if var_doc.overrides not in (None, UNKNOWN):</tt> </tt>
<a name="L2398"></a><tt class="py-lineno">2398</tt> <tt class="py-line"><tt class="py-string"> <dt>Overrides:</tt> </tt>
<a name="L2399"></a><tt class="py-lineno">2399</tt> <tt class="py-line"><tt class="py-string"> >>> # Avoid passing GenericValueDoc to href()</tt> </tt>
<a name="L2400"></a><tt class="py-lineno">2400</tt> <tt class="py-line"><tt class="py-string"> >>> if isinstance(var_doc.overrides.value, RoutineDoc):</tt> </tt>
<a name="L2401"></a><tt class="py-lineno">2401</tt> <tt class="py-line"><tt class="py-string"> $self.href(var_doc.overrides.value, context=var_doc)$</tt> </tt>
<a name="L2402"></a><tt class="py-lineno">2402</tt> <tt class="py-line"><tt class="py-string"> >>> else:</tt> </tt>
<a name="L2403"></a><tt class="py-lineno">2403</tt> <tt class="py-line"><tt class="py-string"> >>> # In this case, a less interesting label is generated.</tt> </tt>
<a name="L2404"></a><tt class="py-lineno">2404</tt> <tt class="py-line"><tt class="py-string"> $self.href(var_doc.overrides, context=var_doc)$</tt> </tt>
<a name="L2405"></a><tt class="py-lineno">2405</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L2406"></a><tt class="py-lineno">2406</tt> <tt class="py-line"><tt class="py-string"> >>> if (func_doc.docstring in (None, UNKNOWN) and</tt> </tt>
<a name="L2407"></a><tt class="py-lineno">2407</tt> <tt class="py-line"><tt class="py-string"> >>> var_doc.overrides.value.docstring not in (None, UNKNOWN)):</tt> </tt>
<a name="L2408"></a><tt class="py-lineno">2408</tt> <tt class="py-line"><tt class="py-string"> <dd><em class="note">(inherited documentation)</em></dd></tt> </tt>
<a name="L2409"></a><tt class="py-lineno">2409</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L2410"></a><tt class="py-lineno">2410</tt> <tt class="py-line"><tt class="py-string"> </dt></tt> </tt>
<a name="L2411"></a><tt class="py-lineno">2411</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L2412"></a><tt class="py-lineno">2412</tt> <tt class="py-line"><tt class="py-string"> </dl></tt> </tt>
<a name="L2413"></a><tt class="py-lineno">2413</tt> <tt class="py-line"><tt class="py-string"> >>> # === metadata ===</tt> </tt>
<a name="L2414"></a><tt class="py-lineno">2414</tt> <tt class="py-line"><tt class="py-string"> >>> self.write_standard_fields(out, func_doc)</tt> </tt>
<a name="L2415"></a><tt class="py-lineno">2415</tt> <tt class="py-line"><tt class="py-string"> </td></tr></table></tt> </tt>
<a name="L2416"></a><tt class="py-lineno">2416</tt> <tt class="py-line"><tt class="py-string"> </div></tt> </tt>
<a name="L2417"></a><tt class="py-lineno">2417</tt> <tt class="py-line"><tt class="py-string"> '''</tt><tt class="py-op">)</tt> </tt>
<a name="L2418"></a><tt class="py-lineno">2418</tt> <tt class="py-line"> <tt class="py-comment"># \------------------------------------------------------------/</tt> </tt>
<a name="L2419"></a><tt class="py-lineno">2419</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L2420"></a><tt class="py-lineno">2420</tt> <tt class="py-line"> <tt class="py-comment"># Names for the __special__ methods.</tt> </tt>
<a name="L2421"></a><tt class="py-lineno">2421</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-718" class="py-name" targets="Variable epydoc.docwriter.html.HTMLWriter.SPECIAL_METHODS=epydoc.docwriter.html.HTMLWriter-class.html#SPECIAL_METHODS"><a title="epydoc.docwriter.html.HTMLWriter.SPECIAL_METHODS" class="py-name" href="#" onclick="return doclink('link-718', 'SPECIAL_METHODS', 'link-718');">SPECIAL_METHODS</a></tt> <tt class="py-op">=</tt><tt class="py-op">{</tt> </tt>
<a name="L2422"></a><tt class="py-lineno">2422</tt> <tt class="py-line"> <tt class="py-string">'__init__'</tt><tt class="py-op">:</tt> <tt class="py-string">'Constructor'</tt><tt class="py-op">,</tt> </tt>
<a name="L2423"></a><tt class="py-lineno">2423</tt> <tt class="py-line"> <tt class="py-string">'__del__'</tt><tt class="py-op">:</tt> <tt class="py-string">'Destructor'</tt><tt class="py-op">,</tt> </tt>
<a name="L2424"></a><tt class="py-lineno">2424</tt> <tt class="py-line"> <tt class="py-string">'__add__'</tt><tt class="py-op">:</tt> <tt class="py-string">'Addition operator'</tt><tt class="py-op">,</tt> </tt>
<a name="L2425"></a><tt class="py-lineno">2425</tt> <tt class="py-line"> <tt class="py-string">'__sub__'</tt><tt class="py-op">:</tt> <tt class="py-string">'Subtraction operator'</tt><tt class="py-op">,</tt> </tt>
<a name="L2426"></a><tt class="py-lineno">2426</tt> <tt class="py-line"> <tt class="py-string">'__and__'</tt><tt class="py-op">:</tt> <tt class="py-string">'And operator'</tt><tt class="py-op">,</tt> </tt>
<a name="L2427"></a><tt class="py-lineno">2427</tt> <tt class="py-line"> <tt class="py-string">'__or__'</tt><tt class="py-op">:</tt> <tt class="py-string">'Or operator'</tt><tt class="py-op">,</tt> </tt>
<a name="L2428"></a><tt class="py-lineno">2428</tt> <tt class="py-line"> <tt class="py-string">'__xor__'</tt><tt class="py-op">:</tt> <tt class="py-string">'Exclusive-Or operator'</tt><tt class="py-op">,</tt> </tt>
<a name="L2429"></a><tt class="py-lineno">2429</tt> <tt class="py-line"> <tt class="py-string">'__repr__'</tt><tt class="py-op">:</tt> <tt class="py-string">'Representation operator'</tt><tt class="py-op">,</tt> </tt>
<a name="L2430"></a><tt class="py-lineno">2430</tt> <tt class="py-line"> <tt class="py-string">'__call__'</tt><tt class="py-op">:</tt> <tt class="py-string">'Call operator'</tt><tt class="py-op">,</tt> </tt>
<a name="L2431"></a><tt class="py-lineno">2431</tt> <tt class="py-line"> <tt class="py-string">'__getattr__'</tt><tt class="py-op">:</tt> <tt class="py-string">'Qualification operator'</tt><tt class="py-op">,</tt> </tt>
<a name="L2432"></a><tt class="py-lineno">2432</tt> <tt class="py-line"> <tt class="py-string">'__getitem__'</tt><tt class="py-op">:</tt> <tt class="py-string">'Indexing operator'</tt><tt class="py-op">,</tt> </tt>
<a name="L2433"></a><tt class="py-lineno">2433</tt> <tt class="py-line"> <tt class="py-string">'__setitem__'</tt><tt class="py-op">:</tt> <tt class="py-string">'Index assignment operator'</tt><tt class="py-op">,</tt> </tt>
<a name="L2434"></a><tt class="py-lineno">2434</tt> <tt class="py-line"> <tt class="py-string">'__delitem__'</tt><tt class="py-op">:</tt> <tt class="py-string">'Index deletion operator'</tt><tt class="py-op">,</tt> </tt>
<a name="L2435"></a><tt class="py-lineno">2435</tt> <tt class="py-line"> <tt class="py-string">'__delslice__'</tt><tt class="py-op">:</tt> <tt class="py-string">'Slice deletion operator'</tt><tt class="py-op">,</tt> </tt>
<a name="L2436"></a><tt class="py-lineno">2436</tt> <tt class="py-line"> <tt class="py-string">'__setslice__'</tt><tt class="py-op">:</tt> <tt class="py-string">'Slice assignment operator'</tt><tt class="py-op">,</tt> </tt>
<a name="L2437"></a><tt class="py-lineno">2437</tt> <tt class="py-line"> <tt class="py-string">'__getslice__'</tt><tt class="py-op">:</tt> <tt class="py-string">'Slicling operator'</tt><tt class="py-op">,</tt> </tt>
<a name="L2438"></a><tt class="py-lineno">2438</tt> <tt class="py-line"> <tt class="py-string">'__len__'</tt><tt class="py-op">:</tt> <tt class="py-string">'Length operator'</tt><tt class="py-op">,</tt> </tt>
<a name="L2439"></a><tt class="py-lineno">2439</tt> <tt class="py-line"> <tt class="py-string">'__cmp__'</tt><tt class="py-op">:</tt> <tt class="py-string">'Comparison operator'</tt><tt class="py-op">,</tt> </tt>
<a name="L2440"></a><tt class="py-lineno">2440</tt> <tt class="py-line"> <tt class="py-string">'__eq__'</tt><tt class="py-op">:</tt> <tt class="py-string">'Equality operator'</tt><tt class="py-op">,</tt> </tt>
<a name="L2441"></a><tt class="py-lineno">2441</tt> <tt class="py-line"> <tt class="py-string">'__in__'</tt><tt class="py-op">:</tt> <tt class="py-string">'Containership operator'</tt><tt class="py-op">,</tt> </tt>
<a name="L2442"></a><tt class="py-lineno">2442</tt> <tt class="py-line"> <tt class="py-string">'__gt__'</tt><tt class="py-op">:</tt> <tt class="py-string">'Greater-than operator'</tt><tt class="py-op">,</tt> </tt>
<a name="L2443"></a><tt class="py-lineno">2443</tt> <tt class="py-line"> <tt class="py-string">'__lt__'</tt><tt class="py-op">:</tt> <tt class="py-string">'Less-than operator'</tt><tt class="py-op">,</tt> </tt>
<a name="L2444"></a><tt class="py-lineno">2444</tt> <tt class="py-line"> <tt class="py-string">'__ge__'</tt><tt class="py-op">:</tt> <tt class="py-string">'Greater-than-or-equals operator'</tt><tt class="py-op">,</tt> </tt>
<a name="L2445"></a><tt class="py-lineno">2445</tt> <tt class="py-line"> <tt class="py-string">'__le__'</tt><tt class="py-op">:</tt> <tt class="py-string">'Less-than-or-equals operator'</tt><tt class="py-op">,</tt> </tt>
<a name="L2446"></a><tt class="py-lineno">2446</tt> <tt class="py-line"> <tt class="py-string">'__radd__'</tt><tt class="py-op">:</tt> <tt class="py-string">'Right-side addition operator'</tt><tt class="py-op">,</tt> </tt>
<a name="L2447"></a><tt class="py-lineno">2447</tt> <tt class="py-line"> <tt class="py-string">'__hash__'</tt><tt class="py-op">:</tt> <tt class="py-string">'Hashing function'</tt><tt class="py-op">,</tt> </tt>
<a name="L2448"></a><tt class="py-lineno">2448</tt> <tt class="py-line"> <tt class="py-string">'__contains__'</tt><tt class="py-op">:</tt> <tt class="py-string">'In operator'</tt><tt class="py-op">,</tt> </tt>
<a name="L2449"></a><tt class="py-lineno">2449</tt> <tt class="py-line"> <tt class="py-string">'__nonzero__'</tt><tt class="py-op">:</tt> <tt class="py-string">'Boolean test operator'</tt><tt class="py-op">,</tt> </tt>
<a name="L2450"></a><tt class="py-lineno">2450</tt> <tt class="py-line"> <tt class="py-string">'__str__'</tt><tt class="py-op">:</tt> <tt class="py-string">'Informal representation operator'</tt><tt class="py-op">,</tt> </tt>
<a name="L2451"></a><tt class="py-lineno">2451</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt>
<a name="L2452"></a><tt class="py-lineno">2452</tt> <tt class="py-line"> </tt>
<a name="L2453"></a><tt class="py-lineno">2453</tt> <tt class="py-line"> <tt id="link-719" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_property_details_entry" class="py-name" href="#" onclick="return doclink('link-719', 'write_property_details_entry', 'link-703');">write_property_details_entry</a></tt> <tt class="py-op">=</tt> <tt id="link-720" class="py-name"><a title="epydoc.docwriter.html.compile_template" class="py-name" href="#" onclick="return doclink('link-720', 'compile_template', 'link-427');">compile_template</a></tt><tt class="py-op">(</tt> </tt>
<a name="L2454"></a><tt class="py-lineno">2454</tt> <tt class="py-line"> <tt class="py-string">'''</tt> </tt>
<a name="L2455"></a><tt class="py-lineno">2455</tt> <tt class="py-line"><tt class="py-string"> write_property_details_entry(self, out, var_doc, descr, \</tt> </tt>
<a name="L2456"></a><tt class="py-lineno">2456</tt> <tt class="py-line"><tt class="py-string"> accessors, div_class)</tt> </tt>
<a name="L2457"></a><tt class="py-lineno">2457</tt> <tt class="py-line"><tt class="py-string"> '''</tt><tt class="py-op">,</tt> </tt>
<a name="L2458"></a><tt class="py-lineno">2458</tt> <tt class="py-line"> <tt class="py-comment"># /------------------------- Template -------------------------\</tt> </tt>
<a name="L2459"></a><tt class="py-lineno">2459</tt> <tt class="py-line"> <tt class="py-string">'''</tt> </tt>
<a name="L2460"></a><tt class="py-lineno">2460</tt> <tt class="py-line"><tt class="py-string"> >>> prop_doc = var_doc.value</tt> </tt>
<a name="L2461"></a><tt class="py-lineno">2461</tt> <tt class="py-line"><tt class="py-string"> <a name="$var_doc.name$"></a></tt> </tt>
<a name="L2462"></a><tt class="py-lineno">2462</tt> <tt class="py-line"><tt class="py-string"> <div$div_class$></tt> </tt>
<a name="L2463"></a><tt class="py-lineno">2463</tt> <tt class="py-line"><tt class="py-string"> >>> self.write_table_header(out, "details")</tt> </tt>
<a name="L2464"></a><tt class="py-lineno">2464</tt> <tt class="py-line"><tt class="py-string"> <tr><td></tt> </tt>
<a name="L2465"></a><tt class="py-lineno">2465</tt> <tt class="py-line"><tt class="py-string"> <h3 class="epydoc">$var_doc.name$</h3></tt> </tt>
<a name="L2466"></a><tt class="py-lineno">2466</tt> <tt class="py-line"><tt class="py-string"> $descr$</tt> </tt>
<a name="L2467"></a><tt class="py-lineno">2467</tt> <tt class="py-line"><tt class="py-string"> <dl class="fields"></tt> </tt>
<a name="L2468"></a><tt class="py-lineno">2468</tt> <tt class="py-line"><tt class="py-string"> >>> for (name, val, summary) in accessors:</tt> </tt>
<a name="L2469"></a><tt class="py-lineno">2469</tt> <tt class="py-line"><tt class="py-string"> <dt>$name$ Method:</dt></tt> </tt>
<a name="L2470"></a><tt class="py-lineno">2470</tt> <tt class="py-line"><tt class="py-string"> <dd class="value">$val$</tt> </tt>
<a name="L2471"></a><tt class="py-lineno">2471</tt> <tt class="py-line"><tt class="py-string"> >>> if summary:</tt> </tt>
<a name="L2472"></a><tt class="py-lineno">2472</tt> <tt class="py-line"><tt class="py-string"> - $summary$</tt> </tt>
<a name="L2473"></a><tt class="py-lineno">2473</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L2474"></a><tt class="py-lineno">2474</tt> <tt class="py-line"><tt class="py-string"> </dd></tt> </tt>
<a name="L2475"></a><tt class="py-lineno">2475</tt> <tt class="py-line"><tt class="py-string"> >>> #endfor</tt> </tt>
<a name="L2476"></a><tt class="py-lineno">2476</tt> <tt class="py-line"><tt class="py-string"> >>> if prop_doc.type_descr not in (None, UNKNOWN):</tt> </tt>
<a name="L2477"></a><tt class="py-lineno">2477</tt> <tt class="py-line"><tt class="py-string"> <dt>Type:</dt></tt> </tt>
<a name="L2478"></a><tt class="py-lineno">2478</tt> <tt class="py-line"><tt class="py-string"> <dd>$self.type_descr(var_doc, indent=6)$</dd></tt> </tt>
<a name="L2479"></a><tt class="py-lineno">2479</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L2480"></a><tt class="py-lineno">2480</tt> <tt class="py-line"><tt class="py-string"> </dl></tt> </tt>
<a name="L2481"></a><tt class="py-lineno">2481</tt> <tt class="py-line"><tt class="py-string"> >>> self.write_standard_fields(out, prop_doc)</tt> </tt>
<a name="L2482"></a><tt class="py-lineno">2482</tt> <tt class="py-line"><tt class="py-string"> </td></tr></table></tt> </tt>
<a name="L2483"></a><tt class="py-lineno">2483</tt> <tt class="py-line"><tt class="py-string"> </div></tt> </tt>
<a name="L2484"></a><tt class="py-lineno">2484</tt> <tt class="py-line"><tt class="py-string"> '''</tt><tt class="py-op">)</tt> </tt>
<a name="L2485"></a><tt class="py-lineno">2485</tt> <tt class="py-line"> <tt class="py-comment"># \------------------------------------------------------------/</tt> </tt>
<a name="L2486"></a><tt class="py-lineno">2486</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L2487"></a><tt class="py-lineno">2487</tt> <tt class="py-line"> <tt id="link-721" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_variable_details_entry" class="py-name" href="#" onclick="return doclink('link-721', 'write_variable_details_entry', 'link-705');">write_variable_details_entry</a></tt> <tt class="py-op">=</tt> <tt id="link-722" class="py-name"><a title="epydoc.docwriter.html.compile_template" class="py-name" href="#" onclick="return doclink('link-722', 'compile_template', 'link-427');">compile_template</a></tt><tt class="py-op">(</tt> </tt>
<a name="L2488"></a><tt class="py-lineno">2488</tt> <tt class="py-line"> <tt class="py-string">'''</tt> </tt>
<a name="L2489"></a><tt class="py-lineno">2489</tt> <tt class="py-line"><tt class="py-string"> write_variable_details_entry(self, out, var_doc, descr, div_class)</tt> </tt>
<a name="L2490"></a><tt class="py-lineno">2490</tt> <tt class="py-line"><tt class="py-string"> '''</tt><tt class="py-op">,</tt> </tt>
<a name="L2491"></a><tt class="py-lineno">2491</tt> <tt class="py-line"> <tt class="py-comment"># /------------------------- Template -------------------------\</tt> </tt>
<a name="L2492"></a><tt class="py-lineno">2492</tt> <tt class="py-line"> <tt class="py-string">'''</tt> </tt>
<a name="L2493"></a><tt class="py-lineno">2493</tt> <tt class="py-line"><tt class="py-string"> <a name="$var_doc.name$"></a></tt> </tt>
<a name="L2494"></a><tt class="py-lineno">2494</tt> <tt class="py-line"><tt class="py-string"> <div$div_class$></tt> </tt>
<a name="L2495"></a><tt class="py-lineno">2495</tt> <tt class="py-line"><tt class="py-string"> >>> self.write_table_header(out, "details")</tt> </tt>
<a name="L2496"></a><tt class="py-lineno">2496</tt> <tt class="py-line"><tt class="py-string"> <tr><td></tt> </tt>
<a name="L2497"></a><tt class="py-lineno">2497</tt> <tt class="py-line"><tt class="py-string"> <h3 class="epydoc">$var_doc.name$</h3></tt> </tt>
<a name="L2498"></a><tt class="py-lineno">2498</tt> <tt class="py-line"><tt class="py-string"> $descr$</tt> </tt>
<a name="L2499"></a><tt class="py-lineno">2499</tt> <tt class="py-line"><tt class="py-string"> <dl class="fields"></tt> </tt>
<a name="L2500"></a><tt class="py-lineno">2500</tt> <tt class="py-line"><tt class="py-string"> >>> if var_doc.type_descr not in (None, UNKNOWN):</tt> </tt>
<a name="L2501"></a><tt class="py-lineno">2501</tt> <tt class="py-line"><tt class="py-string"> <dt>Type:</dt></tt> </tt>
<a name="L2502"></a><tt class="py-lineno">2502</tt> <tt class="py-line"><tt class="py-string"> <dd>$self.type_descr(var_doc, indent=6)$</dd></tt> </tt>
<a name="L2503"></a><tt class="py-lineno">2503</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L2504"></a><tt class="py-lineno">2504</tt> <tt class="py-line"><tt class="py-string"> </dl></tt> </tt>
<a name="L2505"></a><tt class="py-lineno">2505</tt> <tt class="py-line"><tt class="py-string"> >>> self.write_standard_fields(out, var_doc)</tt> </tt>
<a name="L2506"></a><tt class="py-lineno">2506</tt> <tt class="py-line"><tt class="py-string"> >>> if var_doc.value is not UNKNOWN:</tt> </tt>
<a name="L2507"></a><tt class="py-lineno">2507</tt> <tt class="py-line"><tt class="py-string"> <dl class="fields"></tt> </tt>
<a name="L2508"></a><tt class="py-lineno">2508</tt> <tt class="py-line"><tt class="py-string"> <dt>Value:</dt></tt> </tt>
<a name="L2509"></a><tt class="py-lineno">2509</tt> <tt class="py-line"><tt class="py-string"> <dd>$self.pprint_value(var_doc.value)$</dd></tt> </tt>
<a name="L2510"></a><tt class="py-lineno">2510</tt> <tt class="py-line"><tt class="py-string"> </dl></tt> </tt>
<a name="L2511"></a><tt class="py-lineno">2511</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L2512"></a><tt class="py-lineno">2512</tt> <tt class="py-line"><tt class="py-string"> </td></tr></table></tt> </tt>
<a name="L2513"></a><tt class="py-lineno">2513</tt> <tt class="py-line"><tt class="py-string"> </div></tt> </tt>
<a name="L2514"></a><tt class="py-lineno">2514</tt> <tt class="py-line"><tt class="py-string"> '''</tt><tt class="py-op">)</tt> </tt>
<a name="L2515"></a><tt class="py-lineno">2515</tt> <tt class="py-line"> <tt class="py-comment"># \------------------------------------------------------------/</tt> </tt>
<a name="L2516"></a><tt class="py-lineno">2516</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="HTMLWriter.variable_tooltip"></a><div id="HTMLWriter.variable_tooltip-def"><a name="L2517"></a><tt class="py-lineno">2517</tt> <a class="py-toggle" href="#" id="HTMLWriter.variable_tooltip-toggle" onclick="return toggle('HTMLWriter.variable_tooltip');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#variable_tooltip">variable_tooltip</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">var_doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.variable_tooltip-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.variable_tooltip-expanded"><a name="L2518"></a><tt class="py-lineno">2518</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-723" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-723', 'value', 'link-61');">value</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-724" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-724', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2519"></a><tt class="py-lineno">2519</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">''</tt> </tt>
<a name="L2520"></a><tt class="py-lineno">2520</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">=</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-725" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-725', 'value', 'link-61');">value</a></tt><tt class="py-op">.</tt><tt id="link-726" class="py-name" targets="Method epydoc.apidoc.ValueDoc.pyval_repr()=epydoc.apidoc.ValueDoc-class.html#pyval_repr,Module epydoc.markup.pyval_repr=epydoc.markup.pyval_repr-module.html"><a title="epydoc.apidoc.ValueDoc.pyval_repr
epydoc.markup.pyval_repr" class="py-name" href="#" onclick="return doclink('link-726', 'pyval_repr', 'link-726');">pyval_repr</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-727" class="py-name" targets="Method epydoc.markup.ConcatenatedDocstring.to_plaintext()=epydoc.markup.ConcatenatedDocstring-class.html#to_plaintext,Method epydoc.markup.ParsedDocstring.to_plaintext()=epydoc.markup.ParsedDocstring-class.html#to_plaintext,Method epydoc.markup.epytext.ParsedEpytextDocstring.to_plaintext()=epydoc.markup.epytext.ParsedEpytextDocstring-class.html#to_plaintext,Function epydoc.markup.epytext.to_plaintext()=epydoc.markup.epytext-module.html#to_plaintext,Method epydoc.markup.javadoc.ParsedJavadocDocstring.to_plaintext()=epydoc.markup.javadoc.ParsedJavadocDocstring-class.html#to_plaintext,Method epydoc.markup.plaintext.ParsedPlaintextDocstring.to_plaintext()=epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#to_plaintext,Method epydoc.markup.restructuredtext.ParsedRstDocstring.to_plaintext()=epydoc.markup.restructuredtext.ParsedRstDocstring-class.html#to_plaintext"><a title="epydoc.markup.ConcatenatedDocstring.to_plaintext
epydoc.markup.ParsedDocstring.to_plaintext
epydoc.markup.epytext.ParsedEpytextDocstring.to_plaintext
epydoc.markup.epytext.to_plaintext
epydoc.markup.javadoc.ParsedJavadocDocstring.to_plaintext
epydoc.markup.plaintext.ParsedPlaintextDocstring.to_plaintext
epydoc.markup.restructuredtext.ParsedRstDocstring.to_plaintext" class="py-name" href="#" onclick="return doclink('link-727', 'to_plaintext', 'link-727');">to_plaintext</a></tt><tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
<a name="L2521"></a><tt class="py-lineno">2521</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">s</tt><tt class="py-op">)</tt> <tt class="py-op">></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_variable_tooltip_linelen</tt><tt class="py-op">:</tt> </tt>
<a name="L2522"></a><tt class="py-lineno">2522</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">=</tt> <tt class="py-name">s</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_variable_tooltip_linelen</tt><tt class="py-op">-</tt><tt class="py-number">3</tt><tt class="py-op">]</tt><tt class="py-op">+</tt><tt class="py-string">'...'</tt> </tt>
<a name="L2523"></a><tt class="py-lineno">2523</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">' title="%s"'</tt> <tt class="py-op">%</tt> <tt id="link-728" class="py-name"><a title="epydoc.util.plaintext_to_html" class="py-name" href="#" onclick="return doclink('link-728', 'plaintext_to_html', 'link-32');">plaintext_to_html</a></tt><tt class="py-op">(</tt><tt class="py-name">s</tt><tt class="py-op">)</tt> </tt>
</div><a name="L2524"></a><tt class="py-lineno">2524</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.pprint_value"></a><div id="HTMLWriter.pprint_value-def"><a name="L2525"></a><tt class="py-lineno">2525</tt> <a class="py-toggle" href="#" id="HTMLWriter.pprint_value-toggle" onclick="return toggle('HTMLWriter.pprint_value');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#pprint_value">pprint_value</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">val_doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.pprint_value-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.pprint_value-expanded"><a name="L2526"></a><tt class="py-lineno">2526</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">val_doc</tt> <tt class="py-keyword">is</tt> <tt id="link-729" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-729', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L2527"></a><tt class="py-lineno">2527</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'??'</tt> </tt>
<a name="L2528"></a><tt class="py-lineno">2528</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt id="link-730" class="py-name"><a title="epydoc.apidoc.GenericValueDoc" class="py-name" href="#" onclick="return doclink('link-730', 'GenericValueDoc', 'link-58');">GenericValueDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2529"></a><tt class="py-lineno">2529</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-string">'<table><tr><td><pre class="variable">\n'</tt> <tt class="py-op">+</tt> </tt>
<a name="L2530"></a><tt class="py-lineno">2530</tt> <tt class="py-line"> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-731" class="py-name"><a title="epydoc.apidoc.ValueDoc.pyval_repr
epydoc.markup.pyval_repr" class="py-name" href="#" onclick="return doclink('link-731', 'pyval_repr', 'link-726');">pyval_repr</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-732" class="py-name"><a title="epydoc.docwriter.dotgraph.DotGraph.to_html
epydoc.markup.ConcatenatedDocstring.to_html
epydoc.markup.ParsedDocstring.to_html
epydoc.markup.epytext.ParsedEpytextDocstring.to_html
epydoc.markup.javadoc.ParsedJavadocDocstring.to_html
epydoc.markup.plaintext.ParsedPlaintextDocstring.to_html
epydoc.markup.restructuredtext.ParsedRstDocstring.to_html" class="py-name" href="#" onclick="return doclink('link-732', 'to_html', 'link-522');">to_html</a></tt><tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> </tt>
<a name="L2531"></a><tt class="py-lineno">2531</tt> <tt class="py-line"> <tt class="py-string">'\n</pre></td></tr></table>\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L2532"></a><tt class="py-lineno">2532</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2533"></a><tt class="py-lineno">2533</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-733" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.href" class="py-name" href="#" onclick="return doclink('link-733', 'href', 'link-254');">href</a></tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">)</tt> </tt>
</div><a name="L2534"></a><tt class="py-lineno">2534</tt> <tt class="py-line"> </tt>
<a name="L2535"></a><tt class="py-lineno">2535</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L2536"></a><tt class="py-lineno">2536</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ Base Tree</tt> </tt>
<a name="L2537"></a><tt class="py-lineno">2537</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L2538"></a><tt class="py-lineno">2538</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="HTMLWriter.base_tree"></a><div id="HTMLWriter.base_tree-def"><a name="L2539"></a><tt class="py-lineno">2539</tt> <a class="py-toggle" href="#" id="HTMLWriter.base_tree-toggle" onclick="return toggle('HTMLWriter.base_tree');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#base_tree">base_tree</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">,</tt> <tt class="py-param">width</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">postfix</tt><tt class="py-op">=</tt><tt class="py-string">''</tt><tt class="py-op">,</tt> <tt class="py-param">context</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.base_tree-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.base_tree-expanded"><a name="L2540"></a><tt class="py-lineno">2540</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L2541"></a><tt class="py-lineno">2541</tt> <tt class="py-line"><tt class="py-docstring"> @return: The HTML code for a class's base tree. The tree is</tt> </tt>
<a name="L2542"></a><tt class="py-lineno">2542</tt> <tt class="py-line"><tt class="py-docstring"> drawn 'upside-down' and right justified, to allow for</tt> </tt>
<a name="L2543"></a><tt class="py-lineno">2543</tt> <tt class="py-line"><tt class="py-docstring"> multiple inheritance.</tt> </tt>
<a name="L2544"></a><tt class="py-lineno">2544</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{string}</tt> </tt>
<a name="L2545"></a><tt class="py-lineno">2545</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L2546"></a><tt class="py-lineno">2546</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">context</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L2547"></a><tt class="py-lineno">2547</tt> <tt class="py-line"> <tt class="py-name">context</tt> <tt class="py-op">=</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-734" class="py-name" targets="Variable epydoc.apidoc.ValueDoc.defining_module=epydoc.apidoc.ValueDoc-class.html#defining_module,Variable epydoc.apidoc.VariableDoc.defining_module=epydoc.apidoc.VariableDoc-class.html#defining_module"><a title="epydoc.apidoc.ValueDoc.defining_module
epydoc.apidoc.VariableDoc.defining_module" class="py-name" href="#" onclick="return doclink('link-734', 'defining_module', 'link-734');">defining_module</a></tt> </tt>
<a name="L2548"></a><tt class="py-lineno">2548</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">width</tt> <tt class="py-op">==</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-name">width</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-735" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.find_tree_width()=epydoc.docwriter.html.HTMLWriter-class.html#find_tree_width"><a title="epydoc.docwriter.html.HTMLWriter.find_tree_width" class="py-name" href="#" onclick="return doclink('link-735', 'find_tree_width', 'link-735');">find_tree_width</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">)</tt> </tt>
<a name="L2549"></a><tt class="py-lineno">2549</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-736" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-736', 'ClassDoc', 'link-56');">ClassDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-737" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-737', 'bases', 'link-52');">bases</a></tt> <tt class="py-op">!=</tt> <tt id="link-738" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-738', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L2550"></a><tt class="py-lineno">2550</tt> <tt class="py-line"> <tt id="link-739" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-739', 'bases', 'link-52');">bases</a></tt> <tt class="py-op">=</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-740" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-740', 'bases', 'link-52');">bases</a></tt> </tt>
<a name="L2551"></a><tt class="py-lineno">2551</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2552"></a><tt class="py-lineno">2552</tt> <tt class="py-line"> <tt id="link-741" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-741', 'bases', 'link-52');">bases</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L2553"></a><tt class="py-lineno">2553</tt> <tt class="py-line"> </tt>
<a name="L2554"></a><tt class="py-lineno">2554</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">postfix</tt> <tt class="py-op">==</tt> <tt class="py-string">''</tt><tt class="py-op">:</tt> </tt>
<a name="L2555"></a><tt class="py-lineno">2555</tt> <tt class="py-line"> <tt class="py-comment"># [XX] use var name instead of canonical name?</tt> </tt>
<a name="L2556"></a><tt class="py-lineno">2556</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">s</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">*</tt><tt class="py-op">(</tt><tt class="py-name">width</tt><tt class="py-op">-</tt><tt class="py-number">2</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-string">'<strong class="uidshort">'</tt><tt class="py-op">+</tt> </tt>
<a name="L2557"></a><tt class="py-lineno">2557</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-742" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.contextual_label()=epydoc.docwriter.html.HTMLWriter-class.html#contextual_label"><a title="epydoc.docwriter.html.HTMLWriter.contextual_label" class="py-name" href="#" onclick="return doclink('link-742', 'contextual_label', 'link-742');">contextual_label</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">)</tt><tt class="py-op">+</tt><tt class="py-string">'</strong>\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L2558"></a><tt class="py-lineno">2558</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-name">s</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
<a name="L2559"></a><tt class="py-lineno">2559</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">i</tt> <tt class="py-keyword">in</tt> <tt class="py-name">range</tt><tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-743" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-743', 'bases', 'link-52');">bases</a></tt><tt class="py-op">)</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2560"></a><tt class="py-lineno">2560</tt> <tt class="py-line"> <tt class="py-name">base</tt> <tt class="py-op">=</tt> <tt id="link-744" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-744', 'bases', 'link-52');">bases</a></tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">]</tt> </tt>
<a name="L2561"></a><tt class="py-lineno">2561</tt> <tt class="py-line"> <tt id="link-745" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-745', 'label', 'link-118');">label</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-746" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.contextual_label" class="py-name" href="#" onclick="return doclink('link-746', 'contextual_label', 'link-742');">contextual_label</a></tt><tt class="py-op">(</tt><tt class="py-name">base</tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">)</tt> </tt>
<a name="L2562"></a><tt class="py-lineno">2562</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">*</tt><tt class="py-op">(</tt><tt class="py-name">width</tt><tt class="py-op">-</tt><tt class="py-number">4</tt><tt class="py-op">-</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-747" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-747', 'label', 'link-118');">label</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-748" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.href" class="py-name" href="#" onclick="return doclink('link-748', 'href', 'link-254');">href</a></tt><tt class="py-op">(</tt><tt class="py-name">base</tt><tt class="py-op">,</tt> <tt id="link-749" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-749', 'label', 'link-118');">label</a></tt><tt class="py-op">)</tt> </tt>
<a name="L2563"></a><tt class="py-lineno">2563</tt> <tt class="py-line"> <tt class="py-op">+</tt><tt class="py-string">' --+'</tt><tt class="py-op">+</tt><tt class="py-name">postfix</tt><tt class="py-op">+</tt><tt class="py-string">'\n'</tt> <tt class="py-op">+</tt> </tt>
<a name="L2564"></a><tt class="py-lineno">2564</tt> <tt class="py-line"> <tt class="py-string">' '</tt><tt class="py-op">*</tt><tt class="py-op">(</tt><tt class="py-name">width</tt><tt class="py-op">-</tt><tt class="py-number">4</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> </tt>
<a name="L2565"></a><tt class="py-lineno">2565</tt> <tt class="py-line"> <tt class="py-string">' |'</tt><tt class="py-op">+</tt><tt class="py-name">postfix</tt><tt class="py-op">+</tt><tt class="py-string">'\n'</tt> <tt class="py-op">+</tt> </tt>
<a name="L2566"></a><tt class="py-lineno">2566</tt> <tt class="py-line"> <tt class="py-name">s</tt><tt class="py-op">)</tt> </tt>
<a name="L2567"></a><tt class="py-lineno">2567</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">i</tt> <tt class="py-op">!=</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L2568"></a><tt class="py-lineno">2568</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-750" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.base_tree
epydoc.docwriter.latex.LatexWriter.base_tree" class="py-name" href="#" onclick="return doclink('link-750', 'base_tree', 'link-287');">base_tree</a></tt><tt class="py-op">(</tt><tt class="py-name">base</tt><tt class="py-op">,</tt> <tt class="py-name">width</tt><tt class="py-op">-</tt><tt class="py-number">4</tt><tt class="py-op">,</tt> <tt class="py-string">' |'</tt><tt class="py-op">+</tt><tt class="py-name">postfix</tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">)</tt><tt class="py-op">+</tt><tt class="py-name">s</tt><tt class="py-op">)</tt> </tt>
<a name="L2569"></a><tt class="py-lineno">2569</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2570"></a><tt class="py-lineno">2570</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-751" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.base_tree
epydoc.docwriter.latex.LatexWriter.base_tree" class="py-name" href="#" onclick="return doclink('link-751', 'base_tree', 'link-287');">base_tree</a></tt><tt class="py-op">(</tt><tt class="py-name">base</tt><tt class="py-op">,</tt> <tt class="py-name">width</tt><tt class="py-op">-</tt><tt class="py-number">4</tt><tt class="py-op">,</tt> <tt class="py-string">' '</tt><tt class="py-op">+</tt><tt class="py-name">postfix</tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">)</tt><tt class="py-op">+</tt><tt class="py-name">s</tt><tt class="py-op">)</tt> </tt>
<a name="L2571"></a><tt class="py-lineno">2571</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">s</tt> </tt>
</div><a name="L2572"></a><tt class="py-lineno">2572</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.find_tree_width"></a><div id="HTMLWriter.find_tree_width-def"><a name="L2573"></a><tt class="py-lineno">2573</tt> <a class="py-toggle" href="#" id="HTMLWriter.find_tree_width-toggle" onclick="return toggle('HTMLWriter.find_tree_width');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#find_tree_width">find_tree_width</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">,</tt> <tt class="py-param">context</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.find_tree_width-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.find_tree_width-expanded"><a name="L2574"></a><tt class="py-lineno">2574</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L2575"></a><tt class="py-lineno">2575</tt> <tt class="py-line"><tt class="py-docstring"> Helper function for L{base_tree}.</tt> </tt>
<a name="L2576"></a><tt class="py-lineno">2576</tt> <tt class="py-line"><tt class="py-docstring"> @return: The width of a base tree, when drawn</tt> </tt>
<a name="L2577"></a><tt class="py-lineno">2577</tt> <tt class="py-line"><tt class="py-docstring"> right-justified. This is used by L{base_tree} to</tt> </tt>
<a name="L2578"></a><tt class="py-lineno">2578</tt> <tt class="py-line"><tt class="py-docstring"> determine how far to indent lines of the base tree.</tt> </tt>
<a name="L2579"></a><tt class="py-lineno">2579</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{int}</tt> </tt>
<a name="L2580"></a><tt class="py-lineno">2580</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L2581"></a><tt class="py-lineno">2581</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-752" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-752', 'ClassDoc', 'link-56');">ClassDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-number">2</tt> </tt>
<a name="L2582"></a><tt class="py-lineno">2582</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-753" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-753', 'bases', 'link-52');">bases</a></tt> <tt class="py-op">==</tt> <tt id="link-754" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-754', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-number">2</tt> </tt>
<a name="L2583"></a><tt class="py-lineno">2583</tt> <tt class="py-line"> <tt class="py-name">width</tt> <tt class="py-op">=</tt> <tt class="py-number">2</tt> </tt>
<a name="L2584"></a><tt class="py-lineno">2584</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">base</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-755" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-755', 'bases', 'link-52');">bases</a></tt><tt class="py-op">:</tt> </tt>
<a name="L2585"></a><tt class="py-lineno">2585</tt> <tt class="py-line"> <tt class="py-name">width</tt> <tt class="py-op">=</tt> <tt class="py-name">max</tt><tt class="py-op">(</tt><tt class="py-name">width</tt><tt class="py-op">,</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-756" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.contextual_label" class="py-name" href="#" onclick="return doclink('link-756', 'contextual_label', 'link-742');">contextual_label</a></tt><tt class="py-op">(</tt><tt class="py-name">base</tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">+</tt><tt class="py-number">4</tt><tt class="py-op">,</tt> </tt>
<a name="L2586"></a><tt class="py-lineno">2586</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-757" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.find_tree_width" class="py-name" href="#" onclick="return doclink('link-757', 'find_tree_width', 'link-735');">find_tree_width</a></tt><tt class="py-op">(</tt><tt class="py-name">base</tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">)</tt><tt class="py-op">+</tt><tt class="py-number">4</tt><tt class="py-op">)</tt> </tt>
<a name="L2587"></a><tt class="py-lineno">2587</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">width</tt> </tt>
</div><a name="L2588"></a><tt class="py-lineno">2588</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.contextual_label"></a><div id="HTMLWriter.contextual_label-def"><a name="L2589"></a><tt class="py-lineno">2589</tt> <a class="py-toggle" href="#" id="HTMLWriter.contextual_label-toggle" onclick="return toggle('HTMLWriter.contextual_label');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#contextual_label">contextual_label</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">,</tt> <tt class="py-param">context</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.contextual_label-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.contextual_label-expanded"><a name="L2590"></a><tt class="py-lineno">2590</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L2591"></a><tt class="py-lineno">2591</tt> <tt class="py-line"><tt class="py-docstring"> Return the label for C{doc} to be shown in C{context}.</tt> </tt>
<a name="L2592"></a><tt class="py-lineno">2592</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L2593"></a><tt class="py-lineno">2593</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-758" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-758', 'canonical_name', 'link-82');">canonical_name</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L2594"></a><tt class="py-lineno">2594</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-759" class="py-name" targets="Variable epydoc.apidoc.ValueDoc.parse_repr=epydoc.apidoc.ValueDoc-class.html#parse_repr"><a title="epydoc.apidoc.ValueDoc.parse_repr" class="py-name" href="#" onclick="return doclink('link-759', 'parse_repr', 'link-759');">parse_repr</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L2595"></a><tt class="py-lineno">2595</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-760" class="py-name"><a title="epydoc.apidoc.ValueDoc.parse_repr" class="py-name" href="#" onclick="return doclink('link-760', 'parse_repr', 'link-759');">parse_repr</a></tt> </tt>
<a name="L2596"></a><tt class="py-lineno">2596</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2597"></a><tt class="py-lineno">2597</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'??'</tt> </tt>
<a name="L2598"></a><tt class="py-lineno">2598</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2599"></a><tt class="py-lineno">2599</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">context</tt> <tt class="py-keyword">is</tt> <tt id="link-761" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-761', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L2600"></a><tt class="py-lineno">2600</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-762" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-762', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L2601"></a><tt class="py-lineno">2601</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2602"></a><tt class="py-lineno">2602</tt> <tt class="py-line"> <tt id="link-763" class="py-name" targets="Method epydoc.docwriter.html_colorize.PythonSourceColorizer.context_name()=epydoc.docwriter.html_colorize.PythonSourceColorizer-class.html#context_name"><a title="epydoc.docwriter.html_colorize.PythonSourceColorizer.context_name" class="py-name" href="#" onclick="return doclink('link-763', 'context_name', 'link-763');">context_name</a></tt> <tt class="py-op">=</tt> <tt class="py-name">context</tt><tt class="py-op">.</tt><tt id="link-764" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-764', 'canonical_name', 'link-82');">canonical_name</a></tt> </tt>
<a name="L2603"></a><tt class="py-lineno">2603</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-765" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-765', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">.</tt><tt id="link-766" class="py-name" targets="Method epydoc.apidoc.DottedName.contextualize()=epydoc.apidoc.DottedName-class.html#contextualize"><a title="epydoc.apidoc.DottedName.contextualize" class="py-name" href="#" onclick="return doclink('link-766', 'contextualize', 'link-766');">contextualize</a></tt><tt class="py-op">(</tt><tt id="link-767" class="py-name"><a title="epydoc.docwriter.html_colorize.PythonSourceColorizer.context_name" class="py-name" href="#" onclick="return doclink('link-767', 'context_name', 'link-763');">context_name</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L2604"></a><tt class="py-lineno">2604</tt> <tt class="py-line"> </tt>
<a name="L2605"></a><tt class="py-lineno">2605</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L2606"></a><tt class="py-lineno">2606</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ Function Signatures</tt> </tt>
<a name="L2607"></a><tt class="py-lineno">2607</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L2608"></a><tt class="py-lineno">2608</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="HTMLWriter.function_signature"></a><div id="HTMLWriter.function_signature-def"><a name="L2609"></a><tt class="py-lineno">2609</tt> <a class="py-toggle" href="#" id="HTMLWriter.function_signature-toggle" onclick="return toggle('HTMLWriter.function_signature');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#function_signature">function_signature</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">is_summary</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L2610"></a><tt class="py-lineno">2610</tt> <tt class="py-line"> <tt class="py-param">link_name</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-param">anchor</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-param">context</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.function_signature-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.function_signature-expanded"><a name="L2611"></a><tt class="py-lineno">2611</tt> <tt class="py-line"> <tt class="py-docstring">"""Render a function signature in HTML.</tt> </tt>
<a name="L2612"></a><tt class="py-lineno">2612</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L2613"></a><tt class="py-lineno">2613</tt> <tt class="py-line"><tt class="py-docstring"> @param api_doc: The object whose name is to be rendered. If a</tt> </tt>
<a name="L2614"></a><tt class="py-lineno">2614</tt> <tt class="py-line"><tt class="py-docstring"> C{VariableDoc}, its C{value} should be a C{RoutineDoc}</tt> </tt>
<a name="L2615"></a><tt class="py-lineno">2615</tt> <tt class="py-line"><tt class="py-docstring"> @type api_doc: L{VariableDoc} or L{RoutineDoc}</tt> </tt>
<a name="L2616"></a><tt class="py-lineno">2616</tt> <tt class="py-line"><tt class="py-docstring"> @param is_summary: True if the fuction is to be rendered in the summary.</tt> </tt>
<a name="L2617"></a><tt class="py-lineno">2617</tt> <tt class="py-line"><tt class="py-docstring"> type css_class: C{bool}</tt> </tt>
<a name="L2618"></a><tt class="py-lineno">2618</tt> <tt class="py-line"><tt class="py-docstring"> @param link_name: If True, the name is a link to the object anchor.</tt> </tt>
<a name="L2619"></a><tt class="py-lineno">2619</tt> <tt class="py-line"><tt class="py-docstring"> @type link_name: C{bool}</tt> </tt>
<a name="L2620"></a><tt class="py-lineno">2620</tt> <tt class="py-line"><tt class="py-docstring"> @param anchor: If True, the name is the object anchor.</tt> </tt>
<a name="L2621"></a><tt class="py-lineno">2621</tt> <tt class="py-line"><tt class="py-docstring"> @type anchor: C{bool}</tt> </tt>
<a name="L2622"></a><tt class="py-lineno">2622</tt> <tt class="py-line"><tt class="py-docstring"> @param context: If set, represent the function name from this context.</tt> </tt>
<a name="L2623"></a><tt class="py-lineno">2623</tt> <tt class="py-line"><tt class="py-docstring"> Only useful when C{api_doc} is a L{RoutineDoc}.</tt> </tt>
<a name="L2624"></a><tt class="py-lineno">2624</tt> <tt class="py-line"><tt class="py-docstring"> @type context: L{DottedName}</tt> </tt>
<a name="L2625"></a><tt class="py-lineno">2625</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L2626"></a><tt class="py-lineno">2626</tt> <tt class="py-line"><tt class="py-docstring"> @return: The HTML code for the object.</tt> </tt>
<a name="L2627"></a><tt class="py-lineno">2627</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{str}</tt> </tt>
<a name="L2628"></a><tt class="py-lineno">2628</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L2629"></a><tt class="py-lineno">2629</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">is_summary</tt><tt class="py-op">:</tt> <tt class="py-name">css_class</tt> <tt class="py-op">=</tt> <tt class="py-string">'summary-sig'</tt> </tt>
<a name="L2630"></a><tt class="py-lineno">2630</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-name">css_class</tt> <tt class="py-op">=</tt> <tt class="py-string">'sig'</tt> </tt>
<a name="L2631"></a><tt class="py-lineno">2631</tt> <tt class="py-line"> </tt>
<a name="L2632"></a><tt class="py-lineno">2632</tt> <tt class="py-line"> <tt class="py-comment"># [XX] clean this up!</tt> </tt>
<a name="L2633"></a><tt class="py-lineno">2633</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-768" class="py-name" targets="Class epydoc.apidoc.VariableDoc=epydoc.apidoc.VariableDoc-class.html"><a title="epydoc.apidoc.VariableDoc" class="py-name" href="#" onclick="return doclink('link-768', 'VariableDoc', 'link-768');">VariableDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2634"></a><tt class="py-lineno">2634</tt> <tt class="py-line"> <tt class="py-name">func_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-769" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-769', 'value', 'link-61');">value</a></tt> </tt>
<a name="L2635"></a><tt class="py-lineno">2635</tt> <tt class="py-line"> <tt class="py-comment"># This should never happen, but just in case:</tt> </tt>
<a name="L2636"></a><tt class="py-lineno">2636</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-770" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-770', 'value', 'link-61');">value</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-771" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-771', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2637"></a><tt class="py-lineno">2637</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-string">'<span class="%s"><span class="%s-name">%s'</tt><tt class="py-op">+</tt> </tt>
<a name="L2638"></a><tt class="py-lineno">2638</tt> <tt class="py-line"> <tt class="py-string">'</span>(...)</span>'</tt><tt class="py-op">)</tt> <tt class="py-op">%</tt> </tt>
<a name="L2639"></a><tt class="py-lineno">2639</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">css_class</tt><tt class="py-op">,</tt> <tt class="py-name">css_class</tt><tt class="py-op">,</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-772" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-772', 'name', 'link-117');">name</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L2640"></a><tt class="py-lineno">2640</tt> <tt class="py-line"> <tt class="py-comment"># Get the function's name.</tt> </tt>
<a name="L2641"></a><tt class="py-lineno">2641</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-773" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-773', 'name', 'link-117');">name</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-774" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.summary_name" class="py-name" href="#" onclick="return doclink('link-774', 'summary_name', 'link-633');">summary_name</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">css_class</tt><tt class="py-op">=</tt><tt class="py-name">css_class</tt><tt class="py-op">+</tt><tt class="py-string">'-name'</tt><tt class="py-op">,</tt> </tt>
<a name="L2642"></a><tt class="py-lineno">2642</tt> <tt class="py-line"> <tt class="py-name">link_name</tt><tt class="py-op">=</tt><tt class="py-name">link_name</tt><tt class="py-op">,</tt> <tt class="py-name">anchor</tt><tt class="py-op">=</tt><tt class="py-name">anchor</tt><tt class="py-op">)</tt> </tt>
<a name="L2643"></a><tt class="py-lineno">2643</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2644"></a><tt class="py-lineno">2644</tt> <tt class="py-line"> <tt class="py-name">func_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">api_doc</tt> </tt>
<a name="L2645"></a><tt class="py-lineno">2645</tt> <tt class="py-line"> <tt id="link-775" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-775', 'name', 'link-117');">name</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-776" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.href" class="py-name" href="#" onclick="return doclink('link-776', 'href', 'link-254');">href</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">css_class</tt><tt class="py-op">=</tt><tt class="py-name">css_class</tt><tt class="py-op">+</tt><tt class="py-string">'-name'</tt><tt class="py-op">,</tt> </tt>
<a name="L2646"></a><tt class="py-lineno">2646</tt> <tt class="py-line"> <tt class="py-name">context</tt><tt class="py-op">=</tt><tt class="py-name">context</tt><tt class="py-op">)</tt> </tt>
<a name="L2647"></a><tt class="py-lineno">2647</tt> <tt class="py-line"> </tt>
<a name="L2648"></a><tt class="py-lineno">2648</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-777" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.posargs=epydoc.apidoc.RoutineDoc-class.html#posargs"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-777', 'posargs', 'link-777');">posargs</a></tt> <tt class="py-op">==</tt> <tt id="link-778" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-778', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L2649"></a><tt class="py-lineno">2649</tt> <tt class="py-line"> <tt class="py-name">args</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">'...'</tt><tt class="py-op">]</tt> </tt>
<a name="L2650"></a><tt class="py-lineno">2650</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2651"></a><tt class="py-lineno">2651</tt> <tt class="py-line"> <tt class="py-name">args</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-779" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.func_arg()=epydoc.docwriter.html.HTMLWriter-class.html#func_arg,Method epydoc.docwriter.latex.LatexWriter.func_arg()=epydoc.docwriter.latex.LatexWriter-class.html#func_arg"><a title="epydoc.docwriter.html.HTMLWriter.func_arg
epydoc.docwriter.latex.LatexWriter.func_arg" class="py-name" href="#" onclick="return doclink('link-779', 'func_arg', 'link-779');">func_arg</a></tt><tt class="py-op">(</tt><tt class="py-name">n</tt><tt class="py-op">,</tt> <tt class="py-name">d</tt><tt class="py-op">,</tt> <tt class="py-name">css_class</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt class="py-name">n</tt><tt class="py-op">,</tt> <tt class="py-name">d</tt><tt class="py-op">)</tt> </tt>
<a name="L2652"></a><tt class="py-lineno">2652</tt> <tt class="py-line"> <tt class="py-keyword">in</tt> <tt class="py-name">zip</tt><tt class="py-op">(</tt><tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-780" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-780', 'posargs', 'link-777');">posargs</a></tt><tt class="py-op">,</tt> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-781" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.posarg_defaults=epydoc.apidoc.RoutineDoc-class.html#posarg_defaults"><a title="epydoc.apidoc.RoutineDoc.posarg_defaults" class="py-name" href="#" onclick="return doclink('link-781', 'posarg_defaults', 'link-781');">posarg_defaults</a></tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L2653"></a><tt class="py-lineno">2653</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-782" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.vararg=epydoc.apidoc.RoutineDoc-class.html#vararg"><a title="epydoc.apidoc.RoutineDoc.vararg" class="py-name" href="#" onclick="return doclink('link-782', 'vararg', 'link-782');">vararg</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-783" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-783', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2654"></a><tt class="py-lineno">2654</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-784" class="py-name"><a title="epydoc.apidoc.RoutineDoc.vararg" class="py-name" href="#" onclick="return doclink('link-784', 'vararg', 'link-782');">vararg</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'...'</tt><tt class="py-op">:</tt> </tt>
<a name="L2655"></a><tt class="py-lineno">2655</tt> <tt class="py-line"> <tt class="py-name">args</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">'<span class="%s-arg">...</span>'</tt> <tt class="py-op">%</tt> <tt class="py-name">css_class</tt><tt class="py-op">)</tt> </tt>
<a name="L2656"></a><tt class="py-lineno">2656</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2657"></a><tt class="py-lineno">2657</tt> <tt class="py-line"> <tt class="py-name">args</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">'<span class="%s-arg">*%s</span>'</tt> <tt class="py-op">%</tt> </tt>
<a name="L2658"></a><tt class="py-lineno">2658</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">css_class</tt><tt class="py-op">,</tt> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-785" class="py-name"><a title="epydoc.apidoc.RoutineDoc.vararg" class="py-name" href="#" onclick="return doclink('link-785', 'vararg', 'link-782');">vararg</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L2659"></a><tt class="py-lineno">2659</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-786" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.kwarg=epydoc.apidoc.RoutineDoc-class.html#kwarg"><a title="epydoc.apidoc.RoutineDoc.kwarg" class="py-name" href="#" onclick="return doclink('link-786', 'kwarg', 'link-786');">kwarg</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-787" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-787', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2660"></a><tt class="py-lineno">2660</tt> <tt class="py-line"> <tt class="py-name">args</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">'<span class="%s-arg">**%s</span>'</tt> <tt class="py-op">%</tt> </tt>
<a name="L2661"></a><tt class="py-lineno">2661</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">css_class</tt><tt class="py-op">,</tt> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-788" class="py-name"><a title="epydoc.apidoc.RoutineDoc.kwarg" class="py-name" href="#" onclick="return doclink('link-788', 'kwarg', 'link-786');">kwarg</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L2662"></a><tt class="py-lineno">2662</tt> <tt class="py-line"> </tt>
<a name="L2663"></a><tt class="py-lineno">2663</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-string">'<span class="%s">%s(%s)</span>'</tt> <tt class="py-op">%</tt> </tt>
<a name="L2664"></a><tt class="py-lineno">2664</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">css_class</tt><tt class="py-op">,</tt> <tt id="link-789" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-789', 'name', 'link-117');">name</a></tt><tt class="py-op">,</tt> <tt class="py-string">',\n '</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">args</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L2665"></a><tt class="py-lineno">2665</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.summary_name"></a><div id="HTMLWriter.summary_name-def"><a name="L2666"></a><tt class="py-lineno">2666</tt> <a class="py-toggle" href="#" id="HTMLWriter.summary_name-toggle" onclick="return toggle('HTMLWriter.summary_name');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#summary_name">summary_name</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">css_class</tt><tt class="py-op">=</tt><tt class="py-string">'summary-name'</tt><tt class="py-op">,</tt> </tt>
<a name="L2667"></a><tt class="py-lineno">2667</tt> <tt class="py-line"> <tt class="py-param">link_name</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-param">anchor</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.summary_name-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.summary_name-expanded"><a name="L2668"></a><tt class="py-lineno">2668</tt> <tt class="py-line"> <tt class="py-docstring">"""Render an object name in HTML.</tt> </tt>
<a name="L2669"></a><tt class="py-lineno">2669</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L2670"></a><tt class="py-lineno">2670</tt> <tt class="py-line"><tt class="py-docstring"> @param api_doc: The object whose name is to be rendered</tt> </tt>
<a name="L2671"></a><tt class="py-lineno">2671</tt> <tt class="py-line"><tt class="py-docstring"> @type api_doc: L{APIDoc}</tt> </tt>
<a name="L2672"></a><tt class="py-lineno">2672</tt> <tt class="py-line"><tt class="py-docstring"> @param css_class: The CSS class to assign to the rendered name</tt> </tt>
<a name="L2673"></a><tt class="py-lineno">2673</tt> <tt class="py-line"><tt class="py-docstring"> type css_class: C{str}</tt> </tt>
<a name="L2674"></a><tt class="py-lineno">2674</tt> <tt class="py-line"><tt class="py-docstring"> @param link_name: If True, the name is a link to the object anchor.</tt> </tt>
<a name="L2675"></a><tt class="py-lineno">2675</tt> <tt class="py-line"><tt class="py-docstring"> @type link_name: C{bool}</tt> </tt>
<a name="L2676"></a><tt class="py-lineno">2676</tt> <tt class="py-line"><tt class="py-docstring"> @param anchor: If True, the name is the object anchor.</tt> </tt>
<a name="L2677"></a><tt class="py-lineno">2677</tt> <tt class="py-line"><tt class="py-docstring"> @type anchor: C{bool}</tt> </tt>
<a name="L2678"></a><tt class="py-lineno">2678</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L2679"></a><tt class="py-lineno">2679</tt> <tt class="py-line"><tt class="py-docstring"> @return: The HTML code for the object.</tt> </tt>
<a name="L2680"></a><tt class="py-lineno">2680</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{str}</tt> </tt>
<a name="L2681"></a><tt class="py-lineno">2681</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L2682"></a><tt class="py-lineno">2682</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">anchor</tt><tt class="py-op">:</tt> </tt>
<a name="L2683"></a><tt class="py-lineno">2683</tt> <tt class="py-line"> <tt class="py-name">rv</tt> <tt class="py-op">=</tt> <tt class="py-string">'<a name="%s"></a>'</tt> <tt class="py-op">%</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-790" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-790', 'name', 'link-117');">name</a></tt> </tt>
<a name="L2684"></a><tt class="py-lineno">2684</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2685"></a><tt class="py-lineno">2685</tt> <tt class="py-line"> <tt class="py-name">rv</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
<a name="L2686"></a><tt class="py-lineno">2686</tt> <tt class="py-line"> </tt>
<a name="L2687"></a><tt class="py-lineno">2687</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">link_name</tt><tt class="py-op">:</tt> </tt>
<a name="L2688"></a><tt class="py-lineno">2688</tt> <tt class="py-line"> <tt class="py-name">rv</tt> <tt class="py-op">+=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-791" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.href" class="py-name" href="#" onclick="return doclink('link-791', 'href', 'link-254');">href</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">css_class</tt><tt class="py-op">=</tt><tt class="py-name">css_class</tt><tt class="py-op">)</tt> </tt>
<a name="L2689"></a><tt class="py-lineno">2689</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2690"></a><tt class="py-lineno">2690</tt> <tt class="py-line"> <tt class="py-name">rv</tt> <tt class="py-op">+=</tt> <tt class="py-string">'<span class="%s">%s</span>'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">css_class</tt><tt class="py-op">,</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-792" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-792', 'name', 'link-117');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L2691"></a><tt class="py-lineno">2691</tt> <tt class="py-line"> </tt>
<a name="L2692"></a><tt class="py-lineno">2692</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">rv</tt> </tt>
</div><a name="L2693"></a><tt class="py-lineno">2693</tt> <tt class="py-line"> </tt>
<a name="L2694"></a><tt class="py-lineno">2694</tt> <tt class="py-line"> <tt class="py-comment"># [xx] tuple args???</tt> </tt>
<a name="HTMLWriter.func_arg"></a><div id="HTMLWriter.func_arg-def"><a name="L2695"></a><tt class="py-lineno">2695</tt> <a class="py-toggle" href="#" id="HTMLWriter.func_arg-toggle" onclick="return toggle('HTMLWriter.func_arg');">-</a><tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#func_arg">func_arg</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">default</tt><tt class="py-op">,</tt> <tt class="py-param">css_class</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.func_arg-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.func_arg-expanded"><a name="L2696"></a><tt class="py-lineno">2696</tt> <tt class="py-line"> <tt id="link-793" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-793', 'name', 'link-117');">name</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-794" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter._arg_name()=epydoc.docwriter.html.HTMLWriter-class.html#_arg_name,Method epydoc.docwriter.latex.LatexWriter._arg_name()=epydoc.docwriter.latex.LatexWriter-class.html#_arg_name"><a title="epydoc.docwriter.html.HTMLWriter._arg_name
epydoc.docwriter.latex.LatexWriter._arg_name" class="py-name" href="#" onclick="return doclink('link-794', '_arg_name', 'link-794');">_arg_name</a></tt><tt class="py-op">(</tt><tt id="link-795" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-795', 'name', 'link-117');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L2697"></a><tt class="py-lineno">2697</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">=</tt> <tt class="py-string">'<span class="%s-arg">%s</span>'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">css_class</tt><tt class="py-op">,</tt> <tt id="link-796" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-796', 'name', 'link-117');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L2698"></a><tt class="py-lineno">2698</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">default</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L2699"></a><tt class="py-lineno">2699</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">+=</tt> <tt class="py-op">(</tt><tt class="py-string">'=<span class="%s-default">%s</span>'</tt> <tt class="py-op">%</tt> </tt>
<a name="L2700"></a><tt class="py-lineno">2700</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">css_class</tt><tt class="py-op">,</tt> <tt class="py-name">default</tt><tt class="py-op">.</tt><tt id="link-797" class="py-name"><a title="epydoc.apidoc.ValueDoc.summary_pyval_repr" class="py-name" href="#" onclick="return doclink('link-797', 'summary_pyval_repr', 'link-638');">summary_pyval_repr</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-798" class="py-name"><a title="epydoc.docwriter.dotgraph.DotGraph.to_html
epydoc.markup.ConcatenatedDocstring.to_html
epydoc.markup.ParsedDocstring.to_html
epydoc.markup.epytext.ParsedEpytextDocstring.to_html
epydoc.markup.javadoc.ParsedJavadocDocstring.to_html
epydoc.markup.plaintext.ParsedPlaintextDocstring.to_html
epydoc.markup.restructuredtext.ParsedRstDocstring.to_html" class="py-name" href="#" onclick="return doclink('link-798', 'to_html', 'link-522');">to_html</a></tt><tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L2701"></a><tt class="py-lineno">2701</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">s</tt> </tt>
</div><a name="L2702"></a><tt class="py-lineno">2702</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter._arg_name"></a><div id="HTMLWriter._arg_name-def"><a name="L2703"></a><tt class="py-lineno">2703</tt> <a class="py-toggle" href="#" id="HTMLWriter._arg_name-toggle" onclick="return toggle('HTMLWriter._arg_name');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#_arg_name">_arg_name</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">arg</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter._arg_name-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter._arg_name-expanded"><a name="L2704"></a><tt class="py-lineno">2704</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt id="link-799" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-799', 'arg', 'link-370');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-name">basestring</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2705"></a><tt class="py-lineno">2705</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-800" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-800', 'arg', 'link-370');">arg</a></tt> </tt>
<a name="L2706"></a><tt class="py-lineno">2706</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-801" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-801', 'arg', 'link-370');">arg</a></tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">1</tt><tt class="py-op">:</tt> </tt>
<a name="L2707"></a><tt class="py-lineno">2707</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'(%s,)'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-802" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._arg_name
epydoc.docwriter.latex.LatexWriter._arg_name" class="py-name" href="#" onclick="return doclink('link-802', '_arg_name', 'link-794');">_arg_name</a></tt><tt class="py-op">(</tt><tt id="link-803" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-803', 'arg', 'link-370');">arg</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L2708"></a><tt class="py-lineno">2708</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2709"></a><tt class="py-lineno">2709</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'(%s)'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-string">', '</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-804" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._arg_name
epydoc.docwriter.latex.LatexWriter._arg_name" class="py-name" href="#" onclick="return doclink('link-804', '_arg_name', 'link-794');">_arg_name</a></tt><tt class="py-op">(</tt><tt class="py-name">a</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">a</tt> <tt class="py-keyword">in</tt> <tt id="link-805" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-805', 'arg', 'link-370');">arg</a></tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L2710"></a><tt class="py-lineno">2710</tt> <tt class="py-line"> </tt>
<a name="L2711"></a><tt class="py-lineno">2711</tt> <tt class="py-line"> </tt>
<a name="L2712"></a><tt class="py-lineno">2712</tt> <tt class="py-line"> </tt>
<a name="L2713"></a><tt class="py-lineno">2713</tt> <tt class="py-line"> </tt>
<a name="L2714"></a><tt class="py-lineno">2714</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L2715"></a><tt class="py-lineno">2715</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ Import Lists</tt> </tt>
<a name="L2716"></a><tt class="py-lineno">2716</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L2717"></a><tt class="py-lineno">2717</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="HTMLWriter.write_imports"></a><div id="HTMLWriter.write_imports-def"><a name="L2718"></a><tt class="py-lineno">2718</tt> <a class="py-toggle" href="#" id="HTMLWriter.write_imports-toggle" onclick="return toggle('HTMLWriter.write_imports');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write_imports">write_imports</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write_imports-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write_imports-expanded"><a name="L2719"></a><tt class="py-lineno">2719</tt> <tt class="py-line"> <tt class="py-keyword">assert</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-806" class="py-name"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-806', 'NamespaceDoc', 'link-59');">NamespaceDoc</a></tt><tt class="py-op">)</tt> </tt>
<a name="L2720"></a><tt class="py-lineno">2720</tt> <tt class="py-line"> <tt id="link-807" class="py-name"><a title="epydoc.apidoc.ModuleDoc.imports" class="py-name" href="#" onclick="return doclink('link-807', 'imports', 'link-51');">imports</a></tt> <tt class="py-op">=</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-808" class="py-name"><a title="epydoc.apidoc.ClassDoc.select_variables
epydoc.apidoc.ModuleDoc.select_variables" class="py-name" href="#" onclick="return doclink('link-808', 'select_variables', 'link-444');">select_variables</a></tt><tt class="py-op">(</tt><tt class="py-name">imported</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> </tt>
<a name="L2721"></a><tt class="py-lineno">2721</tt> <tt class="py-line"> <tt class="py-name">public</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_public_filter</tt><tt class="py-op">)</tt> </tt>
<a name="L2722"></a><tt class="py-lineno">2722</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt id="link-809" class="py-name"><a title="epydoc.apidoc.ModuleDoc.imports" class="py-name" href="#" onclick="return doclink('link-809', 'imports', 'link-51');">imports</a></tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> </tt>
<a name="L2723"></a><tt class="py-lineno">2723</tt> <tt class="py-line"> </tt>
<a name="L2724"></a><tt class="py-lineno">2724</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<p class="indent-wrapped-lines">'</tt><tt class="py-op">)</tt> </tt>
<a name="L2725"></a><tt class="py-lineno">2725</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<b>Imports:</b>\n '</tt><tt class="py-op">)</tt> </tt>
<a name="L2726"></a><tt class="py-lineno">2726</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">',\n '</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-810" class="py-name" targets="Function epydoc.docintrospecter._import()=epydoc.docintrospecter-module.html#_import,Method epydoc.docwriter.html.HTMLWriter._import()=epydoc.docwriter.html.HTMLWriter-class.html#_import"><a title="epydoc.docintrospecter._import
epydoc.docwriter.html.HTMLWriter._import" class="py-name" href="#" onclick="return doclink('link-810', '_import', 'link-810');">_import</a></tt><tt class="py-op">(</tt><tt id="link-811" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-811', 'v', 'link-80');">v</a></tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt id="link-812" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-812', 'v', 'link-80');">v</a></tt> <tt class="py-keyword">in</tt> <tt id="link-813" class="py-name"><a title="epydoc.apidoc.ModuleDoc.imports" class="py-name" href="#" onclick="return doclink('link-813', 'imports', 'link-51');">imports</a></tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L2727"></a><tt class="py-lineno">2727</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\n</p><br />\n'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L2728"></a><tt class="py-lineno">2728</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter._import"></a><div id="HTMLWriter._import-def"><a name="L2729"></a><tt class="py-lineno">2729</tt> <a class="py-toggle" href="#" id="HTMLWriter._import-toggle" onclick="return toggle('HTMLWriter._import');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#_import">_import</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">var_doc</tt><tt class="py-op">,</tt> <tt class="py-param">context</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter._import-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter._import-expanded"><a name="L2730"></a><tt class="py-lineno">2730</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-814" class="py-name" targets="Variable epydoc.apidoc.VariableDoc.imported_from=epydoc.apidoc.VariableDoc-class.html#imported_from"><a title="epydoc.apidoc.VariableDoc.imported_from" class="py-name" href="#" onclick="return doclink('link-814', 'imported_from', 'link-814');">imported_from</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-815" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-815', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2731"></a><tt class="py-lineno">2731</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-816" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.href" class="py-name" href="#" onclick="return doclink('link-816', 'href', 'link-254');">href</a></tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-817" class="py-name"><a title="epydoc.apidoc.VariableDoc.imported_from" class="py-name" href="#" onclick="return doclink('link-817', 'imported_from', 'link-814');">imported_from</a></tt><tt class="py-op">,</tt> </tt>
<a name="L2732"></a><tt class="py-lineno">2732</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-818" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-818', 'name', 'link-117');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">=</tt><tt class="py-name">context</tt><tt class="py-op">,</tt> </tt>
<a name="L2733"></a><tt class="py-lineno">2733</tt> <tt class="py-line"> <tt class="py-name">tooltip</tt><tt class="py-op">=</tt><tt class="py-string">'%s'</tt> <tt class="py-op">%</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-819" class="py-name"><a title="epydoc.apidoc.VariableDoc.imported_from" class="py-name" href="#" onclick="return doclink('link-819', 'imported_from', 'link-814');">imported_from</a></tt><tt class="py-op">)</tt> </tt>
<a name="L2734"></a><tt class="py-lineno">2734</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-820" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-820', 'value', 'link-61');">value</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-821" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-821', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> </tt>
<a name="L2735"></a><tt class="py-lineno">2735</tt> <tt class="py-line"> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-822" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-822', 'value', 'link-61');">value</a></tt><tt class="py-op">,</tt> <tt id="link-823" class="py-name"><a title="epydoc.apidoc.GenericValueDoc" class="py-name" href="#" onclick="return doclink('link-823', 'GenericValueDoc', 'link-58');">GenericValueDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2736"></a><tt class="py-lineno">2736</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-824" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.href" class="py-name" href="#" onclick="return doclink('link-824', 'href', 'link-254');">href</a></tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-825" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-825', 'value', 'link-61');">value</a></tt><tt class="py-op">,</tt> </tt>
<a name="L2737"></a><tt class="py-lineno">2737</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-826" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-826', 'name', 'link-117');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">=</tt><tt class="py-name">context</tt><tt class="py-op">,</tt> </tt>
<a name="L2738"></a><tt class="py-lineno">2738</tt> <tt class="py-line"> <tt class="py-name">tooltip</tt><tt class="py-op">=</tt><tt class="py-string">'%s'</tt> <tt class="py-op">%</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-827" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-827', 'value', 'link-61');">value</a></tt><tt class="py-op">.</tt><tt id="link-828" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-828', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L2739"></a><tt class="py-lineno">2739</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2740"></a><tt class="py-lineno">2740</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-829" class="py-name"><a title="epydoc.util.plaintext_to_html" class="py-name" href="#" onclick="return doclink('link-829', 'plaintext_to_html', 'link-32');">plaintext_to_html</a></tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-830" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-830', 'name', 'link-117');">name</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L2741"></a><tt class="py-lineno">2741</tt> <tt class="py-line"> </tt>
<a name="L2742"></a><tt class="py-lineno">2742</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L2743"></a><tt class="py-lineno">2743</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ Function Attributes</tt> </tt>
<a name="L2744"></a><tt class="py-lineno">2744</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L2745"></a><tt class="py-lineno">2745</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L2746"></a><tt class="py-lineno">2746</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L2747"></a><tt class="py-lineno">2747</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ Module Trees</tt> </tt>
<a name="L2748"></a><tt class="py-lineno">2748</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L2749"></a><tt class="py-lineno">2749</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="HTMLWriter.write_module_list"></a><div id="HTMLWriter.write_module_list-def"><a name="L2750"></a><tt class="py-lineno">2750</tt> <a class="py-toggle" href="#" id="HTMLWriter.write_module_list-toggle" onclick="return toggle('HTMLWriter.write_module_list');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module_list">write_module_list</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write_module_list-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write_module_list-expanded"><a name="L2751"></a><tt class="py-lineno">2751</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-831" class="py-name"><a title="epydoc.apidoc.ModuleDoc.submodules" class="py-name" href="#" onclick="return doclink('link-831', 'submodules', 'link-53');">submodules</a></tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> </tt>
<a name="L2752"></a><tt class="py-lineno">2752</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-832" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_table_header" class="py-name" href="#" onclick="return doclink('link-832', 'write_table_header', 'link-375');">write_table_header</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-string">"summary"</tt><tt class="py-op">,</tt> <tt class="py-string">"Submodules"</tt><tt class="py-op">)</tt> </tt>
<a name="L2753"></a><tt class="py-lineno">2753</tt> <tt class="py-line"> </tt>
<a name="L2754"></a><tt class="py-lineno">2754</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">group_name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-833" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.group_names" class="py-name" href="#" onclick="return doclink('link-833', 'group_names', 'link-568');">group_names</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2755"></a><tt class="py-lineno">2755</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-834" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.submodule_groups=epydoc.apidoc.ModuleDoc-class.html#submodule_groups"><a title="epydoc.apidoc.ModuleDoc.submodule_groups" class="py-name" href="#" onclick="return doclink('link-834', 'submodule_groups', 'link-834');">submodule_groups</a></tt><tt class="py-op">[</tt><tt class="py-name">group_name</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> <tt class="py-keyword">continue</tt> </tt>
<a name="L2756"></a><tt class="py-lineno">2756</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">group_name</tt><tt class="py-op">:</tt> </tt>
<a name="L2757"></a><tt class="py-lineno">2757</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-835" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_group_header" class="py-name" href="#" onclick="return doclink('link-835', 'write_group_header', 'link-579');">write_group_header</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">group_name</tt><tt class="py-op">)</tt> </tt>
<a name="L2758"></a><tt class="py-lineno">2758</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' <tr><td class="summary">\n'</tt> </tt>
<a name="L2759"></a><tt class="py-lineno">2759</tt> <tt class="py-line"> <tt class="py-string">' <ul class="nomargin">\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L2760"></a><tt class="py-lineno">2760</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">submodule</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-836" class="py-name"><a title="epydoc.apidoc.ModuleDoc.submodule_groups" class="py-name" href="#" onclick="return doclink('link-836', 'submodule_groups', 'link-834');">submodule_groups</a></tt><tt class="py-op">[</tt><tt class="py-name">group_name</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L2761"></a><tt class="py-lineno">2761</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-837" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_module_tree_item
epydoc.docwriter.latex.LatexWriter.write_module_tree_item" class="py-name" href="#" onclick="return doclink('link-837', 'write_module_tree_item', 'link-328');">write_module_tree_item</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">submodule</tt><tt class="py-op">,</tt> <tt id="link-838" class="py-name"><a title="epydoc.apidoc.ModuleDoc.package" class="py-name" href="#" onclick="return doclink('link-838', 'package', 'link-325');">package</a></tt><tt class="py-op">=</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L2762"></a><tt class="py-lineno">2762</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' </ul></td></tr>\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L2763"></a><tt class="py-lineno">2763</tt> <tt class="py-line"> </tt>
<a name="L2764"></a><tt class="py-lineno">2764</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-839" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.TABLE_FOOTER" class="py-name" href="#" onclick="return doclink('link-839', 'TABLE_FOOTER', 'link-581');">TABLE_FOOTER</a></tt><tt class="py-op">+</tt><tt class="py-string">'\n<br />\n'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L2765"></a><tt class="py-lineno">2765</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.write_module_tree_item"></a><div id="HTMLWriter.write_module_tree_item-def"><a name="L2766"></a><tt class="py-lineno">2766</tt> <a class="py-toggle" href="#" id="HTMLWriter.write_module_tree_item-toggle" onclick="return toggle('HTMLWriter.write_module_tree_item');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module_tree_item">write_module_tree_item</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">,</tt> <tt class="py-param">package</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write_module_tree_item-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write_module_tree_item-expanded"><a name="L2767"></a><tt class="py-lineno">2767</tt> <tt class="py-line"> <tt class="py-comment"># If it's a private variable, then mark its <li>.</tt> </tt>
<a name="L2768"></a><tt class="py-lineno">2768</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">var</tt> <tt class="py-op">=</tt> <tt id="link-840" class="py-name"><a title="epydoc.apidoc.ModuleDoc.package" class="py-name" href="#" onclick="return doclink('link-840', 'package', 'link-325');">package</a></tt> <tt class="py-keyword">and</tt> <tt id="link-841" class="py-name"><a title="epydoc.apidoc.ModuleDoc.package" class="py-name" href="#" onclick="return doclink('link-841', 'package', 'link-325');">package</a></tt><tt class="py-op">.</tt><tt id="link-842" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-842', 'variables', 'link-60');">variables</a></tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-843" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-843', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L2769"></a><tt class="py-lineno">2769</tt> <tt class="py-line"> <tt class="py-name">priv</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-name">var</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt class="py-name">var</tt><tt class="py-op">.</tt><tt id="link-844" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_public" class="py-name" href="#" onclick="return doclink('link-844', 'is_public', 'link-578');">is_public</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">False</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L2770"></a><tt class="py-lineno">2770</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">var</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-845" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-845', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">'_'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L2771"></a><tt class="py-lineno">2771</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' <li%s> <strong class="uidlink">%s</strong>'</tt> </tt>
<a name="L2772"></a><tt class="py-lineno">2772</tt> <tt class="py-line"> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">priv</tt> <tt class="py-keyword">and</tt> <tt class="py-string">' class="private"'</tt> <tt class="py-keyword">or</tt> <tt class="py-string">''</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-846" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.href" class="py-name" href="#" onclick="return doclink('link-846', 'href', 'link-254');">href</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L2773"></a><tt class="py-lineno">2773</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-847" class="py-name"><a title="epydoc.apidoc.APIDoc.summary
epydoc.docwriter.html.HTMLWriter.summary
epydoc.markup.ConcatenatedDocstring.summary
epydoc.markup.ParsedDocstring.summary
epydoc.markup.epytext.ParsedEpytextDocstring.summary
epydoc.markup.javadoc.ParsedJavadocDocstring.summary
epydoc.markup.plaintext.ParsedPlaintextDocstring.summary
epydoc.markup.restructuredtext.ParsedRstDocstring.summary" class="py-name" href="#" onclick="return doclink('link-847', 'summary', 'link-642');">summary</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-848" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-848', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2774"></a><tt class="py-lineno">2774</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">': <em class="summary">'</tt><tt class="py-op">+</tt> </tt>
<a name="L2775"></a><tt class="py-lineno">2775</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-849" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.description" class="py-name" href="#" onclick="return doclink('link-849', 'description', 'link-620');">description</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-850" class="py-name"><a title="epydoc.apidoc.APIDoc.summary
epydoc.docwriter.html.HTMLWriter.summary
epydoc.markup.ConcatenatedDocstring.summary
epydoc.markup.ParsedDocstring.summary
epydoc.markup.epytext.ParsedEpytextDocstring.summary
epydoc.markup.javadoc.ParsedJavadocDocstring.summary
epydoc.markup.plaintext.ParsedPlaintextDocstring.summary
epydoc.markup.restructuredtext.ParsedRstDocstring.summary" class="py-name" href="#" onclick="return doclink('link-850', 'summary', 'link-642');">summary</a></tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-number">8</tt><tt class="py-op">)</tt><tt class="py-op">+</tt><tt class="py-string">'</em>'</tt><tt class="py-op">)</tt> </tt>
<a name="L2776"></a><tt class="py-lineno">2776</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-851" class="py-name"><a title="epydoc.apidoc.ModuleDoc.submodules" class="py-name" href="#" onclick="return doclink('link-851', 'submodules', 'link-53');">submodules</a></tt> <tt class="py-op">!=</tt> <tt id="link-852" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-852', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt> <tt class="py-keyword">and</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-853" class="py-name"><a title="epydoc.apidoc.ModuleDoc.submodules" class="py-name" href="#" onclick="return doclink('link-853', 'submodules', 'link-53');">submodules</a></tt><tt class="py-op">:</tt> </tt>
<a name="L2777"></a><tt class="py-lineno">2777</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">priv</tt><tt class="py-op">:</tt> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\n <ul class="private">\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L2778"></a><tt class="py-lineno">2778</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'\n <ul>\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L2779"></a><tt class="py-lineno">2779</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">submodule</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-854" class="py-name"><a title="epydoc.apidoc.ModuleDoc.submodules" class="py-name" href="#" onclick="return doclink('link-854', 'submodules', 'link-53');">submodules</a></tt><tt class="py-op">:</tt> </tt>
<a name="L2780"></a><tt class="py-lineno">2780</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-855" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_module_tree_item
epydoc.docwriter.latex.LatexWriter.write_module_tree_item" class="py-name" href="#" onclick="return doclink('link-855', 'write_module_tree_item', 'link-328');">write_module_tree_item</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">submodule</tt><tt class="py-op">,</tt> <tt id="link-856" class="py-name"><a title="epydoc.apidoc.ModuleDoc.package" class="py-name" href="#" onclick="return doclink('link-856', 'package', 'link-325');">package</a></tt><tt class="py-op">=</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L2781"></a><tt class="py-lineno">2781</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' </ul>\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L2782"></a><tt class="py-lineno">2782</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">' </li>\n'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L2783"></a><tt class="py-lineno">2783</tt> <tt class="py-line"> </tt>
<a name="L2784"></a><tt class="py-lineno">2784</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L2785"></a><tt class="py-lineno">2785</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ Class trees</tt> </tt>
<a name="L2786"></a><tt class="py-lineno">2786</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L2787"></a><tt class="py-lineno">2787</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L2788"></a><tt class="py-lineno">2788</tt> <tt class="py-line"> <tt id="link-857" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_class_tree_item" class="py-name" href="#" onclick="return doclink('link-857', 'write_class_tree_item', 'link-343');">write_class_tree_item</a></tt> <tt class="py-op">=</tt> <tt id="link-858" class="py-name"><a title="epydoc.docwriter.html.compile_template" class="py-name" href="#" onclick="return doclink('link-858', 'compile_template', 'link-427');">compile_template</a></tt><tt class="py-op">(</tt> </tt>
<a name="L2789"></a><tt class="py-lineno">2789</tt> <tt class="py-line"> <tt class="py-string">'''</tt> </tt>
<a name="L2790"></a><tt class="py-lineno">2790</tt> <tt class="py-line"><tt class="py-string"> write_class_tree_item(self, out, doc, class_set)</tt> </tt>
<a name="L2791"></a><tt class="py-lineno">2791</tt> <tt class="py-line"><tt class="py-string"> '''</tt><tt class="py-op">,</tt> </tt>
<a name="L2792"></a><tt class="py-lineno">2792</tt> <tt class="py-line"> <tt class="py-comment"># /------------------------- Template -------------------------\</tt> </tt>
<a name="L2793"></a><tt class="py-lineno">2793</tt> <tt class="py-line"> <tt class="py-string">'''</tt> </tt>
<a name="L2794"></a><tt class="py-lineno">2794</tt> <tt class="py-line"><tt class="py-string"> >>> if doc.summary in (None, UNKNOWN):</tt> </tt>
<a name="L2795"></a><tt class="py-lineno">2795</tt> <tt class="py-line"><tt class="py-string"> <li> <strong class="uidlink">$self.href(doc)$</strong></tt> </tt>
<a name="L2796"></a><tt class="py-lineno">2796</tt> <tt class="py-line"><tt class="py-string"> >>> else:</tt> </tt>
<a name="L2797"></a><tt class="py-lineno">2797</tt> <tt class="py-line"><tt class="py-string"> <li> <strong class="uidlink">$self.href(doc)$</strong>:</tt> </tt>
<a name="L2798"></a><tt class="py-lineno">2798</tt> <tt class="py-line"><tt class="py-string"> <em class="summary">$self.description(doc.summary, doc, 8)$</em></tt> </tt>
<a name="L2799"></a><tt class="py-lineno">2799</tt> <tt class="py-line"><tt class="py-string"> >>> # endif</tt> </tt>
<a name="L2800"></a><tt class="py-lineno">2800</tt> <tt class="py-line"><tt class="py-string"> >>> if doc.subclasses:</tt> </tt>
<a name="L2801"></a><tt class="py-lineno">2801</tt> <tt class="py-line"><tt class="py-string"> <ul></tt> </tt>
<a name="L2802"></a><tt class="py-lineno">2802</tt> <tt class="py-line"><tt class="py-string"> >>> for subclass in sorted(set(doc.subclasses), key=lambda c:c.canonical_name[-1]):</tt> </tt>
<a name="L2803"></a><tt class="py-lineno">2803</tt> <tt class="py-line"><tt class="py-string"> >>> if subclass in class_set:</tt> </tt>
<a name="L2804"></a><tt class="py-lineno">2804</tt> <tt class="py-line"><tt class="py-string"> >>> self.write_class_tree_item(out, subclass, class_set)</tt> </tt>
<a name="L2805"></a><tt class="py-lineno">2805</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L2806"></a><tt class="py-lineno">2806</tt> <tt class="py-line"><tt class="py-string"> >>> #endfor</tt> </tt>
<a name="L2807"></a><tt class="py-lineno">2807</tt> <tt class="py-line"><tt class="py-string"> </ul></tt> </tt>
<a name="L2808"></a><tt class="py-lineno">2808</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L2809"></a><tt class="py-lineno">2809</tt> <tt class="py-line"><tt class="py-string"> </li></tt> </tt>
<a name="L2810"></a><tt class="py-lineno">2810</tt> <tt class="py-line"><tt class="py-string"> '''</tt><tt class="py-op">)</tt> </tt>
<a name="L2811"></a><tt class="py-lineno">2811</tt> <tt class="py-line"> <tt class="py-comment"># \------------------------------------------------------------/</tt> </tt>
<a name="L2812"></a><tt class="py-lineno">2812</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L2813"></a><tt class="py-lineno">2813</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L2814"></a><tt class="py-lineno">2814</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ Standard Fields</tt> </tt>
<a name="L2815"></a><tt class="py-lineno">2815</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L2816"></a><tt class="py-lineno">2816</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="HTMLWriter.write_standard_fields"></a><div id="HTMLWriter.write_standard_fields-def"><a name="L2817"></a><tt class="py-lineno">2817</tt> <a class="py-toggle" href="#" id="HTMLWriter.write_standard_fields-toggle" onclick="return toggle('HTMLWriter.write_standard_fields');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write_standard_fields">write_standard_fields</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write_standard_fields-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write_standard_fields-expanded"><a name="L2818"></a><tt class="py-lineno">2818</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L2819"></a><tt class="py-lineno">2819</tt> <tt class="py-line"><tt class="py-docstring"> Write HTML code containing descriptions of any standard markup</tt> </tt>
<a name="L2820"></a><tt class="py-lineno">2820</tt> <tt class="py-line"><tt class="py-docstring"> fields that are defined by the given L{APIDoc} object (such as</tt> </tt>
<a name="L2821"></a><tt class="py-lineno">2821</tt> <tt class="py-line"><tt class="py-docstring"> C{@author} and C{@todo} fields).</tt> </tt>
<a name="L2822"></a><tt class="py-lineno">2822</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L2823"></a><tt class="py-lineno">2823</tt> <tt class="py-line"><tt class="py-docstring"> @param doc: The L{APIDoc} object containing the API documentation</tt> </tt>
<a name="L2824"></a><tt class="py-lineno">2824</tt> <tt class="py-line"><tt class="py-docstring"> for the object whose standard markup fields should be</tt> </tt>
<a name="L2825"></a><tt class="py-lineno">2825</tt> <tt class="py-line"><tt class="py-docstring"> described.</tt> </tt>
<a name="L2826"></a><tt class="py-lineno">2826</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L2827"></a><tt class="py-lineno">2827</tt> <tt class="py-line"> <tt class="py-name">fields</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L2828"></a><tt class="py-lineno">2828</tt> <tt class="py-line"> <tt class="py-name">field_values</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L2829"></a><tt class="py-lineno">2829</tt> <tt class="py-line"> </tt>
<a name="L2830"></a><tt class="py-lineno">2830</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt class="py-name">field</tt><tt class="py-op">,</tt> <tt id="link-859" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-859', 'arg', 'link-370');">arg</a></tt><tt class="py-op">,</tt> <tt id="link-860" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-860', 'descr', 'link-228');">descr</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-861" class="py-name"><a title="epydoc.apidoc.APIDoc.metadata" class="py-name" href="#" onclick="return doclink('link-861', 'metadata', 'link-231');">metadata</a></tt><tt class="py-op">:</tt> </tt>
<a name="L2831"></a><tt class="py-lineno">2831</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">field</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">field_values</tt><tt class="py-op">:</tt> </tt>
<a name="L2832"></a><tt class="py-lineno">2832</tt> <tt class="py-line"> <tt class="py-name">fields</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">field</tt><tt class="py-op">)</tt> </tt>
<a name="L2833"></a><tt class="py-lineno">2833</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">field</tt><tt class="py-op">.</tt><tt class="py-name">takes_arg</tt><tt class="py-op">:</tt> </tt>
<a name="L2834"></a><tt class="py-lineno">2834</tt> <tt class="py-line"> <tt class="py-name">subfields</tt> <tt class="py-op">=</tt> <tt class="py-name">field_values</tt><tt class="py-op">.</tt><tt class="py-name">setdefault</tt><tt class="py-op">(</tt><tt class="py-name">field</tt><tt class="py-op">,</tt><tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">)</tt> </tt>
<a name="L2835"></a><tt class="py-lineno">2835</tt> <tt class="py-line"> <tt class="py-name">subfields</tt><tt class="py-op">.</tt><tt class="py-name">setdefault</tt><tt class="py-op">(</tt><tt id="link-862" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-862', 'arg', 'link-370');">arg</a></tt><tt class="py-op">,</tt><tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-863" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-863', 'descr', 'link-228');">descr</a></tt><tt class="py-op">)</tt> </tt>
<a name="L2836"></a><tt class="py-lineno">2836</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2837"></a><tt class="py-lineno">2837</tt> <tt class="py-line"> <tt class="py-name">field_values</tt><tt class="py-op">.</tt><tt class="py-name">setdefault</tt><tt class="py-op">(</tt><tt class="py-name">field</tt><tt class="py-op">,</tt><tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-864" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-864', 'descr', 'link-228');">descr</a></tt><tt class="py-op">)</tt> </tt>
<a name="L2838"></a><tt class="py-lineno">2838</tt> <tt class="py-line"> </tt>
<a name="L2839"></a><tt class="py-lineno">2839</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">fields</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> </tt>
<a name="L2840"></a><tt class="py-lineno">2840</tt> <tt class="py-line"> </tt>
<a name="L2841"></a><tt class="py-lineno">2841</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'<div class="fields">'</tt><tt class="py-op">)</tt> </tt>
<a name="L2842"></a><tt class="py-lineno">2842</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">field</tt> <tt class="py-keyword">in</tt> <tt class="py-name">fields</tt><tt class="py-op">:</tt> </tt>
<a name="L2843"></a><tt class="py-lineno">2843</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">field</tt><tt class="py-op">.</tt><tt class="py-name">takes_arg</tt><tt class="py-op">:</tt> </tt>
<a name="L2844"></a><tt class="py-lineno">2844</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-865" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-865', 'arg', 'link-370');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-name">descrs</tt> <tt class="py-keyword">in</tt> <tt class="py-name">field_values</tt><tt class="py-op">[</tt><tt class="py-name">field</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">items</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2845"></a><tt class="py-lineno">2845</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-866" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_standard_field()=epydoc.docwriter.html.HTMLWriter-class.html#write_standard_field,Method epydoc.docwriter.latex.LatexWriter.write_standard_field()=epydoc.docwriter.latex.LatexWriter-class.html#write_standard_field"><a title="epydoc.docwriter.html.HTMLWriter.write_standard_field
epydoc.docwriter.latex.LatexWriter.write_standard_field" class="py-name" href="#" onclick="return doclink('link-866', 'write_standard_field', 'link-866');">write_standard_field</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-name">field</tt><tt class="py-op">,</tt> <tt class="py-name">descrs</tt><tt class="py-op">,</tt> <tt id="link-867" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-867', 'arg', 'link-370');">arg</a></tt><tt class="py-op">)</tt> </tt>
<a name="L2846"></a><tt class="py-lineno">2846</tt> <tt class="py-line"> </tt>
<a name="L2847"></a><tt class="py-lineno">2847</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2848"></a><tt class="py-lineno">2848</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-868" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_standard_field
epydoc.docwriter.latex.LatexWriter.write_standard_field" class="py-name" href="#" onclick="return doclink('link-868', 'write_standard_field', 'link-866');">write_standard_field</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-name">field</tt><tt class="py-op">,</tt> <tt class="py-name">field_values</tt><tt class="py-op">[</tt><tt class="py-name">field</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L2849"></a><tt class="py-lineno">2849</tt> <tt class="py-line"> </tt>
<a name="L2850"></a><tt class="py-lineno">2850</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">'</div>'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L2851"></a><tt class="py-lineno">2851</tt> <tt class="py-line"> </tt>
<a name="L2852"></a><tt class="py-lineno">2852</tt> <tt class="py-line"> <tt id="link-869" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_standard_field
epydoc.docwriter.latex.LatexWriter.write_standard_field" class="py-name" href="#" onclick="return doclink('link-869', 'write_standard_field', 'link-866');">write_standard_field</a></tt> <tt class="py-op">=</tt> <tt id="link-870" class="py-name"><a title="epydoc.docwriter.html.compile_template" class="py-name" href="#" onclick="return doclink('link-870', 'compile_template', 'link-427');">compile_template</a></tt><tt class="py-op">(</tt> </tt>
<a name="L2853"></a><tt class="py-lineno">2853</tt> <tt class="py-line"> <tt class="py-string">"""</tt> </tt>
<a name="L2854"></a><tt class="py-lineno">2854</tt> <tt class="py-line"><tt class="py-string"> write_standard_field(self, out, doc, field, descrs, arg='')</tt> </tt>
<a name="L2855"></a><tt class="py-lineno">2855</tt> <tt class="py-line"><tt class="py-string"> </tt> </tt>
<a name="L2856"></a><tt class="py-lineno">2856</tt> <tt class="py-line"><tt class="py-string"> """</tt><tt class="py-op">,</tt> </tt>
<a name="L2857"></a><tt class="py-lineno">2857</tt> <tt class="py-line"> <tt class="py-comment"># /------------------------- Template -------------------------\</tt> </tt>
<a name="L2858"></a><tt class="py-lineno">2858</tt> <tt class="py-line"> <tt class="py-string">'''</tt> </tt>
<a name="L2859"></a><tt class="py-lineno">2859</tt> <tt class="py-line"><tt class="py-string"> >>> if arg: arglabel = " (%s)" % arg</tt> </tt>
<a name="L2860"></a><tt class="py-lineno">2860</tt> <tt class="py-line"><tt class="py-string"> >>> else: arglabel = ""</tt> </tt>
<a name="L2861"></a><tt class="py-lineno">2861</tt> <tt class="py-line"><tt class="py-string"> >>> if len(descrs) == 1:</tt> </tt>
<a name="L2862"></a><tt class="py-lineno">2862</tt> <tt class="py-line"><tt class="py-string"> <p><strong>$field.singular+arglabel$:</strong></tt> </tt>
<a name="L2863"></a><tt class="py-lineno">2863</tt> <tt class="py-line"><tt class="py-string"> $self.description(descrs[0], doc, 8)$</tt> </tt>
<a name="L2864"></a><tt class="py-lineno">2864</tt> <tt class="py-line"><tt class="py-string"> </p></tt> </tt>
<a name="L2865"></a><tt class="py-lineno">2865</tt> <tt class="py-line"><tt class="py-string"> >>> elif field.short:</tt> </tt>
<a name="L2866"></a><tt class="py-lineno">2866</tt> <tt class="py-line"><tt class="py-string"> <dl><dt>$field.plural+arglabel$:</dt></tt> </tt>
<a name="L2867"></a><tt class="py-lineno">2867</tt> <tt class="py-line"><tt class="py-string"> <dd></tt> </tt>
<a name="L2868"></a><tt class="py-lineno">2868</tt> <tt class="py-line"><tt class="py-string"> >>> for descr in descrs[:-1]:</tt> </tt>
<a name="L2869"></a><tt class="py-lineno">2869</tt> <tt class="py-line"><tt class="py-string"> $self.description(descr, doc, 10)$,</tt> </tt>
<a name="L2870"></a><tt class="py-lineno">2870</tt> <tt class="py-line"><tt class="py-string"> >>> # end for</tt> </tt>
<a name="L2871"></a><tt class="py-lineno">2871</tt> <tt class="py-line"><tt class="py-string"> $self.description(descrs[-1], doc, 10)$</tt> </tt>
<a name="L2872"></a><tt class="py-lineno">2872</tt> <tt class="py-line"><tt class="py-string"> </dd></tt> </tt>
<a name="L2873"></a><tt class="py-lineno">2873</tt> <tt class="py-line"><tt class="py-string"> </dl></tt> </tt>
<a name="L2874"></a><tt class="py-lineno">2874</tt> <tt class="py-line"><tt class="py-string"> >>> else:</tt> </tt>
<a name="L2875"></a><tt class="py-lineno">2875</tt> <tt class="py-line"><tt class="py-string"> <strong>$field.plural+arglabel$:</strong></tt> </tt>
<a name="L2876"></a><tt class="py-lineno">2876</tt> <tt class="py-line"><tt class="py-string"> <ul class="nomargin-top"></tt> </tt>
<a name="L2877"></a><tt class="py-lineno">2877</tt> <tt class="py-line"><tt class="py-string"> >>> for descr in descrs:</tt> </tt>
<a name="L2878"></a><tt class="py-lineno">2878</tt> <tt class="py-line"><tt class="py-string"> <li></tt> </tt>
<a name="L2879"></a><tt class="py-lineno">2879</tt> <tt class="py-line"><tt class="py-string"> $self.description(descr, doc, 8)$</tt> </tt>
<a name="L2880"></a><tt class="py-lineno">2880</tt> <tt class="py-line"><tt class="py-string"> </li></tt> </tt>
<a name="L2881"></a><tt class="py-lineno">2881</tt> <tt class="py-line"><tt class="py-string"> >>> # end for</tt> </tt>
<a name="L2882"></a><tt class="py-lineno">2882</tt> <tt class="py-line"><tt class="py-string"> </ul></tt> </tt>
<a name="L2883"></a><tt class="py-lineno">2883</tt> <tt class="py-line"><tt class="py-string"> >>> # end else</tt> </tt>
<a name="L2884"></a><tt class="py-lineno">2884</tt> <tt class="py-line"><tt class="py-string"> >>> # end for</tt> </tt>
<a name="L2885"></a><tt class="py-lineno">2885</tt> <tt class="py-line"><tt class="py-string"> '''</tt><tt class="py-op">)</tt> </tt>
<a name="L2886"></a><tt class="py-lineno">2886</tt> <tt class="py-line"> <tt class="py-comment"># \------------------------------------------------------------/</tt> </tt>
<a name="L2887"></a><tt class="py-lineno">2887</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L2888"></a><tt class="py-lineno">2888</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L2889"></a><tt class="py-lineno">2889</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ Index generation</tt> </tt>
<a name="L2890"></a><tt class="py-lineno">2890</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L2891"></a><tt class="py-lineno">2891</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L2892"></a><tt class="py-lineno">2892</tt> <tt class="py-line"> <tt class="py-comment">#: A list of metadata indices that should be generated. Each</tt> </tt>
<a name="L2893"></a><tt class="py-lineno">2893</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: entry in this list is a tuple C{(tag, label, short_label)},</tt> </tt>
<a name="L2894"></a><tt class="py-lineno">2894</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: where C{tag} is the cannonical tag of a metadata field;</tt> </tt>
<a name="L2895"></a><tt class="py-lineno">2895</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: C{label} is a label for the index page; and C{short_label}</tt> </tt>
<a name="L2896"></a><tt class="py-lineno">2896</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: is a shorter label, used in the index selector.</tt> </tt>
<a name="L2897"></a><tt class="py-lineno">2897</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-871" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.METADATA_INDICES" class="py-name" href="#" onclick="return doclink('link-871', 'METADATA_INDICES', 'link-69');">METADATA_INDICES</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">(</tt><tt class="py-string">'bug'</tt><tt class="py-op">,</tt> <tt class="py-string">'Bug List'</tt><tt class="py-op">,</tt> <tt class="py-string">'Bugs'</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L2898"></a><tt class="py-lineno">2898</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'todo'</tt><tt class="py-op">,</tt> <tt class="py-string">'To Do List'</tt><tt class="py-op">,</tt> <tt class="py-string">'To Do'</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L2899"></a><tt class="py-lineno">2899</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'change'</tt><tt class="py-op">,</tt> <tt class="py-string">'Change Log'</tt><tt class="py-op">,</tt> <tt class="py-string">'Changes'</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L2900"></a><tt class="py-lineno">2900</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'deprecated'</tt><tt class="py-op">,</tt> <tt class="py-string">'Deprecation List'</tt><tt class="py-op">,</tt> <tt class="py-string">'Deprecations'</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L2901"></a><tt class="py-lineno">2901</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'since'</tt><tt class="py-op">,</tt> <tt class="py-string">'Introductions List'</tt><tt class="py-op">,</tt> <tt class="py-string">'Introductions'</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L2902"></a><tt class="py-lineno">2902</tt> <tt class="py-line"> <tt class="py-op">]</tt> </tt>
<a name="L2903"></a><tt class="py-lineno">2903</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.build_identifier_index"></a><div id="HTMLWriter.build_identifier_index-def"><a name="L2904"></a><tt class="py-lineno">2904</tt> <a class="py-toggle" href="#" id="HTMLWriter.build_identifier_index-toggle" onclick="return toggle('HTMLWriter.build_identifier_index');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#build_identifier_index">build_identifier_index</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.build_identifier_index-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.build_identifier_index-expanded"><a name="L2905"></a><tt class="py-lineno">2905</tt> <tt class="py-line"> <tt class="py-name">items</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L2906"></a><tt class="py-lineno">2906</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">indexed_docs</tt><tt class="py-op">:</tt> </tt>
<a name="L2907"></a><tt class="py-lineno">2907</tt> <tt class="py-line"> <tt id="link-872" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-872', 'name', 'link-117');">name</a></tt> <tt class="py-op">=</tt> <tt id="link-873" class="py-name"><a title="epydoc.util.plaintext_to_html" class="py-name" href="#" onclick="return doclink('link-873', 'plaintext_to_html', 'link-32');">plaintext_to_html</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-874" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-874', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L2908"></a><tt class="py-lineno">2908</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-875" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-875', 'RoutineDoc', 'link-57');">RoutineDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt id="link-876" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-876', 'name', 'link-117');">name</a></tt> <tt class="py-op">+=</tt> <tt class="py-string">'()'</tt> </tt>
<a name="L2909"></a><tt class="py-lineno">2909</tt> <tt class="py-line"> <tt id="link-877" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-877', 'url', 'link-72');">url</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-878" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-878', 'url', 'link-72');">url</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L2910"></a><tt class="py-lineno">2910</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt id="link-879" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-879', 'url', 'link-72');">url</a></tt><tt class="py-op">:</tt> <tt class="py-keyword">continue</tt> </tt>
<a name="L2911"></a><tt class="py-lineno">2911</tt> <tt class="py-line"> <tt id="link-880" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-880', 'container', 'link-63');">container</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt id="link-881" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-881', 'container', 'link-63');">container</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L2912"></a><tt class="py-lineno">2912</tt> <tt class="py-line"> <tt class="py-name">items</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt> <tt class="py-op">(</tt><tt id="link-882" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-882', 'name', 'link-117');">name</a></tt><tt class="py-op">,</tt> <tt id="link-883" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-883', 'url', 'link-72');">url</a></tt><tt class="py-op">,</tt> <tt id="link-884" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-884', 'container', 'link-63');">container</a></tt><tt class="py-op">)</tt> <tt class="py-op">)</tt> </tt>
<a name="L2913"></a><tt class="py-lineno">2913</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-885" class="py-name"><a title="epydoc.compat.sorted" class="py-name" href="#" onclick="return doclink('link-885', 'sorted', 'link-49');">sorted</a></tt><tt class="py-op">(</tt><tt class="py-name">items</tt><tt class="py-op">,</tt> <tt id="link-886" class="py-name"><a title="epydoc.cli.key" class="py-name" href="#" onclick="return doclink('link-886', 'key', 'link-79');">key</a></tt><tt class="py-op">=</tt><tt class="py-keyword">lambda</tt> <tt id="link-887" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-887', 'v', 'link-80');">v</a></tt><tt class="py-op">:</tt><tt id="link-888" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-888', 'v', 'link-80');">v</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">lower</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L2914"></a><tt class="py-lineno">2914</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter._group_by_letter"></a><div id="HTMLWriter._group_by_letter-def"><a name="L2915"></a><tt class="py-lineno">2915</tt> <a class="py-toggle" href="#" id="HTMLWriter._group_by_letter-toggle" onclick="return toggle('HTMLWriter._group_by_letter');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#_group_by_letter">_group_by_letter</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">items</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter._group_by_letter-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter._group_by_letter-expanded"><a name="L2916"></a><tt class="py-lineno">2916</tt> <tt class="py-line"> <tt class="py-docstring">"""Preserves sort order of the input."""</tt> </tt>
<a name="L2917"></a><tt class="py-lineno">2917</tt> <tt class="py-line"> <tt class="py-name">index</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L2918"></a><tt class="py-lineno">2918</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">item</tt> <tt class="py-keyword">in</tt> <tt class="py-name">items</tt><tt class="py-op">:</tt> </tt>
<a name="L2919"></a><tt class="py-lineno">2919</tt> <tt class="py-line"> <tt class="py-name">first_letter</tt> <tt class="py-op">=</tt> <tt class="py-name">item</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">upper</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L2920"></a><tt class="py-lineno">2920</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-op">(</tt><tt class="py-string">"A"</tt> <tt class="py-op"><=</tt> <tt class="py-name">first_letter</tt> <tt class="py-op"><=</tt> <tt class="py-string">"Z"</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2921"></a><tt class="py-lineno">2921</tt> <tt class="py-line"> <tt class="py-name">first_letter</tt> <tt class="py-op">=</tt> <tt class="py-string">'_'</tt> </tt>
<a name="L2922"></a><tt class="py-lineno">2922</tt> <tt class="py-line"> <tt class="py-name">index</tt><tt class="py-op">.</tt><tt class="py-name">setdefault</tt><tt class="py-op">(</tt><tt class="py-name">first_letter</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">item</tt><tt class="py-op">)</tt> </tt>
<a name="L2923"></a><tt class="py-lineno">2923</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">index</tt> </tt>
</div><a name="L2924"></a><tt class="py-lineno">2924</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.build_term_index"></a><div id="HTMLWriter.build_term_index-def"><a name="L2925"></a><tt class="py-lineno">2925</tt> <a class="py-toggle" href="#" id="HTMLWriter.build_term_index-toggle" onclick="return toggle('HTMLWriter.build_term_index');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#build_term_index">build_term_index</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.build_term_index-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.build_term_index-expanded"><a name="L2926"></a><tt class="py-lineno">2926</tt> <tt class="py-line"> <tt class="py-name">items</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L2927"></a><tt class="py-lineno">2927</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">indexed_docs</tt><tt class="py-op">:</tt> </tt>
<a name="L2928"></a><tt class="py-lineno">2928</tt> <tt class="py-line"> <tt id="link-889" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-889', 'url', 'link-72');">url</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-890" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-890', 'url', 'link-72');">url</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L2929"></a><tt class="py-lineno">2929</tt> <tt class="py-line"> <tt class="py-name">items</tt> <tt class="py-op">+=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-891" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter._terms_from_docstring()=epydoc.docwriter.html.HTMLWriter-class.html#_terms_from_docstring"><a title="epydoc.docwriter.html.HTMLWriter._terms_from_docstring" class="py-name" href="#" onclick="return doclink('link-891', '_terms_from_docstring', 'link-891');">_terms_from_docstring</a></tt><tt class="py-op">(</tt><tt id="link-892" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-892', 'url', 'link-72');">url</a></tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-893" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-893', 'descr', 'link-228');">descr</a></tt><tt class="py-op">)</tt> </tt>
<a name="L2930"></a><tt class="py-lineno">2930</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt class="py-name">field</tt><tt class="py-op">,</tt> <tt id="link-894" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-894', 'arg', 'link-370');">arg</a></tt><tt class="py-op">,</tt> <tt id="link-895" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-895', 'descr', 'link-228');">descr</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-896" class="py-name"><a title="epydoc.apidoc.APIDoc.metadata" class="py-name" href="#" onclick="return doclink('link-896', 'metadata', 'link-231');">metadata</a></tt><tt class="py-op">:</tt> </tt>
<a name="L2931"></a><tt class="py-lineno">2931</tt> <tt class="py-line"> <tt class="py-name">items</tt> <tt class="py-op">+=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-897" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._terms_from_docstring" class="py-name" href="#" onclick="return doclink('link-897', '_terms_from_docstring', 'link-891');">_terms_from_docstring</a></tt><tt class="py-op">(</tt><tt id="link-898" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-898', 'url', 'link-72');">url</a></tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-899" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-899', 'descr', 'link-228');">descr</a></tt><tt class="py-op">)</tt> </tt>
<a name="L2932"></a><tt class="py-lineno">2932</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-string">'type_descr'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2933"></a><tt class="py-lineno">2933</tt> <tt class="py-line"> <tt class="py-name">items</tt> <tt class="py-op">+=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-900" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._terms_from_docstring" class="py-name" href="#" onclick="return doclink('link-900', '_terms_from_docstring', 'link-891');">_terms_from_docstring</a></tt><tt class="py-op">(</tt><tt id="link-901" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-901', 'url', 'link-72');">url</a></tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> </tt>
<a name="L2934"></a><tt class="py-lineno">2934</tt> <tt class="py-line"> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-902" class="py-name"><a title="epydoc.apidoc.PropertyDoc.type_descr
epydoc.apidoc.VariableDoc.type_descr
epydoc.docwriter.html.HTMLWriter.type_descr" class="py-name" href="#" onclick="return doclink('link-902', 'type_descr', 'link-631');">type_descr</a></tt><tt class="py-op">)</tt> </tt>
<a name="L2935"></a><tt class="py-lineno">2935</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-string">'return_descr'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2936"></a><tt class="py-lineno">2936</tt> <tt class="py-line"> <tt class="py-name">items</tt> <tt class="py-op">+=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-903" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._terms_from_docstring" class="py-name" href="#" onclick="return doclink('link-903', '_terms_from_docstring', 'link-891');">_terms_from_docstring</a></tt><tt class="py-op">(</tt><tt id="link-904" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-904', 'url', 'link-72');">url</a></tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> </tt>
<a name="L2937"></a><tt class="py-lineno">2937</tt> <tt class="py-line"> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-905" class="py-name"><a title="epydoc.apidoc.RoutineDoc.return_descr
epydoc.docwriter.html.HTMLWriter.return_descr" class="py-name" href="#" onclick="return doclink('link-905', 'return_descr', 'link-669');">return_descr</a></tt><tt class="py-op">)</tt> </tt>
<a name="L2938"></a><tt class="py-lineno">2938</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-string">'return_type'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2939"></a><tt class="py-lineno">2939</tt> <tt class="py-line"> <tt class="py-name">items</tt> <tt class="py-op">+=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-906" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._terms_from_docstring" class="py-name" href="#" onclick="return doclink('link-906', '_terms_from_docstring', 'link-891');">_terms_from_docstring</a></tt><tt class="py-op">(</tt><tt id="link-907" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-907', 'url', 'link-72');">url</a></tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> </tt>
<a name="L2940"></a><tt class="py-lineno">2940</tt> <tt class="py-line"> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-908" class="py-name"><a title="epydoc.apidoc.RoutineDoc.return_type
epydoc.docwriter.html.HTMLWriter.return_type" class="py-name" href="#" onclick="return doclink('link-908', 'return_type', 'link-619');">return_type</a></tt><tt class="py-op">)</tt> </tt>
<a name="L2941"></a><tt class="py-lineno">2941</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-909" class="py-name"><a title="epydoc.compat.sorted" class="py-name" href="#" onclick="return doclink('link-909', 'sorted', 'link-49');">sorted</a></tt><tt class="py-op">(</tt><tt class="py-name">items</tt><tt class="py-op">,</tt> <tt id="link-910" class="py-name"><a title="epydoc.cli.key" class="py-name" href="#" onclick="return doclink('link-910', 'key', 'link-79');">key</a></tt><tt class="py-op">=</tt><tt class="py-keyword">lambda</tt> <tt id="link-911" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-911', 'v', 'link-80');">v</a></tt><tt class="py-op">:</tt><tt id="link-912" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-912', 'v', 'link-80');">v</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">lower</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L2942"></a><tt class="py-lineno">2942</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter._terms_from_docstring"></a><div id="HTMLWriter._terms_from_docstring-def"><a name="L2943"></a><tt class="py-lineno">2943</tt> <a class="py-toggle" href="#" id="HTMLWriter._terms_from_docstring-toggle" onclick="return toggle('HTMLWriter._terms_from_docstring');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#_terms_from_docstring">_terms_from_docstring</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">base_url</tt><tt class="py-op">,</tt> <tt class="py-param">container</tt><tt class="py-op">,</tt> <tt class="py-param">parsed_docstring</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter._terms_from_docstring-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter._terms_from_docstring-expanded"><a name="L2944"></a><tt class="py-lineno">2944</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">parsed_docstring</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-913" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-913', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L2945"></a><tt class="py-lineno">2945</tt> <tt class="py-line"> <tt class="py-name">terms</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L2946"></a><tt class="py-lineno">2946</tt> <tt class="py-line"> <tt class="py-comment"># Strip any existing anchor off:</tt> </tt>
<a name="L2947"></a><tt class="py-lineno">2947</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">base_url</tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">sub</tt><tt class="py-op">(</tt><tt class="py-string">'#.*'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">,</tt> <tt class="py-string">'%s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">base_url</tt><tt class="py-op">,</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L2948"></a><tt class="py-lineno">2948</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">term</tt> <tt class="py-keyword">in</tt> <tt class="py-name">parsed_docstring</tt><tt class="py-op">.</tt><tt id="link-914" class="py-name" targets="Method epydoc.markup.ConcatenatedDocstring.index_terms()=epydoc.markup.ConcatenatedDocstring-class.html#index_terms,Method epydoc.markup.ParsedDocstring.index_terms()=epydoc.markup.ParsedDocstring-class.html#index_terms,Method epydoc.markup.epytext.ParsedEpytextDocstring.index_terms()=epydoc.markup.epytext.ParsedEpytextDocstring-class.html#index_terms,Method epydoc.markup.restructuredtext.ParsedRstDocstring.index_terms()=epydoc.markup.restructuredtext.ParsedRstDocstring-class.html#index_terms"><a title="epydoc.markup.ConcatenatedDocstring.index_terms
epydoc.markup.ParsedDocstring.index_terms
epydoc.markup.epytext.ParsedEpytextDocstring.index_terms
epydoc.markup.restructuredtext.ParsedRstDocstring.index_terms" class="py-name" href="#" onclick="return doclink('link-914', 'index_terms', 'link-914');">index_terms</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2949"></a><tt class="py-lineno">2949</tt> <tt class="py-line"> <tt class="py-name">anchor</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-915" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter._term_index_to_anchor()=epydoc.docwriter.html.HTMLWriter-class.html#_term_index_to_anchor"><a title="epydoc.docwriter.html.HTMLWriter._term_index_to_anchor" class="py-name" href="#" onclick="return doclink('link-915', '_term_index_to_anchor', 'link-915');">_term_index_to_anchor</a></tt><tt class="py-op">(</tt><tt class="py-name">term</tt><tt class="py-op">)</tt> </tt>
<a name="L2950"></a><tt class="py-lineno">2950</tt> <tt class="py-line"> <tt id="link-916" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-916', 'url', 'link-72');">url</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'%s#%s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">base_url</tt><tt class="py-op">,</tt> <tt class="py-name">anchor</tt><tt class="py-op">)</tt> </tt>
<a name="L2951"></a><tt class="py-lineno">2951</tt> <tt class="py-line"> <tt class="py-name">terms</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt> <tt class="py-op">(</tt><tt class="py-name">term</tt><tt class="py-op">.</tt><tt id="link-917" class="py-name"><a title="epydoc.markup.ConcatenatedDocstring.to_plaintext
epydoc.markup.ParsedDocstring.to_plaintext
epydoc.markup.epytext.ParsedEpytextDocstring.to_plaintext
epydoc.markup.epytext.to_plaintext
epydoc.markup.javadoc.ParsedJavadocDocstring.to_plaintext
epydoc.markup.plaintext.ParsedPlaintextDocstring.to_plaintext
epydoc.markup.restructuredtext.ParsedRstDocstring.to_plaintext" class="py-name" href="#" onclick="return doclink('link-917', 'to_plaintext', 'link-727');">to_plaintext</a></tt><tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt id="link-918" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-918', 'url', 'link-72');">url</a></tt><tt class="py-op">,</tt> <tt id="link-919" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-919', 'container', 'link-63');">container</a></tt><tt class="py-op">)</tt> <tt class="py-op">)</tt> </tt>
<a name="L2952"></a><tt class="py-lineno">2952</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">terms</tt> </tt>
</div><a name="L2953"></a><tt class="py-lineno">2953</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.build_metadata_index"></a><div id="HTMLWriter.build_metadata_index-def"><a name="L2954"></a><tt class="py-lineno">2954</tt> <a class="py-toggle" href="#" id="HTMLWriter.build_metadata_index-toggle" onclick="return toggle('HTMLWriter.build_metadata_index');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#build_metadata_index">build_metadata_index</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">field_name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.build_metadata_index-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.build_metadata_index-expanded"><a name="L2955"></a><tt class="py-lineno">2955</tt> <tt class="py-line"> <tt class="py-comment"># Build the index.</tt> </tt>
<a name="L2956"></a><tt class="py-lineno">2956</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">index</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L2957"></a><tt class="py-lineno">2957</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">indexed_docs</tt><tt class="py-op">:</tt> </tt>
<a name="L2958"></a><tt class="py-lineno">2958</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_show_private</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L2959"></a><tt class="py-lineno">2959</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-920" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._doc_or_ancestor_is_private" class="py-name" href="#" onclick="return doclink('link-920', '_doc_or_ancestor_is_private', 'link-374');">_doc_or_ancestor_is_private</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2960"></a><tt class="py-lineno">2960</tt> <tt class="py-line"> <tt class="py-keyword">continue</tt> </tt>
<a name="L2961"></a><tt class="py-lineno">2961</tt> <tt class="py-line"> <tt class="py-name">descrs</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L2962"></a><tt class="py-lineno">2962</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-921" class="py-name"><a title="epydoc.apidoc.APIDoc.metadata" class="py-name" href="#" onclick="return doclink('link-921', 'metadata', 'link-231');">metadata</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-922" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-922', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L2963"></a><tt class="py-lineno">2963</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt class="py-name">field</tt><tt class="py-op">,</tt> <tt id="link-923" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-923', 'arg', 'link-370');">arg</a></tt><tt class="py-op">,</tt> <tt id="link-924" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-924', 'descr', 'link-228');">descr</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-925" class="py-name"><a title="epydoc.apidoc.APIDoc.metadata" class="py-name" href="#" onclick="return doclink('link-925', 'metadata', 'link-231');">metadata</a></tt><tt class="py-op">:</tt> </tt>
<a name="L2964"></a><tt class="py-lineno">2964</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">field</tt><tt class="py-op">.</tt><tt class="py-name">tags</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-name">field_name</tt><tt class="py-op">:</tt> </tt>
<a name="L2965"></a><tt class="py-lineno">2965</tt> <tt class="py-line"> <tt class="py-name">descrs</tt><tt class="py-op">.</tt><tt class="py-name">setdefault</tt><tt class="py-op">(</tt><tt id="link-926" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-926', 'arg', 'link-370');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-927" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-927', 'descr', 'link-228');">descr</a></tt><tt class="py-op">)</tt> </tt>
<a name="L2966"></a><tt class="py-lineno">2966</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt id="link-928" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-928', 'arg', 'link-370');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-name">descr_list</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">descrs</tt><tt class="py-op">.</tt><tt class="py-name">iteritems</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2967"></a><tt class="py-lineno">2967</tt> <tt class="py-line"> <tt class="py-name">index</tt><tt class="py-op">.</tt><tt class="py-name">setdefault</tt><tt class="py-op">(</tt><tt id="link-929" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-929', 'arg', 'link-370');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt> <tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-name">descr_list</tt><tt class="py-op">)</tt> <tt class="py-op">)</tt> </tt>
<a name="L2968"></a><tt class="py-lineno">2968</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">index</tt> </tt>
</div><a name="L2969"></a><tt class="py-lineno">2969</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter._term_index_to_anchor"></a><div id="HTMLWriter._term_index_to_anchor-def"><a name="L2970"></a><tt class="py-lineno">2970</tt> <a class="py-toggle" href="#" id="HTMLWriter._term_index_to_anchor-toggle" onclick="return toggle('HTMLWriter._term_index_to_anchor');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#_term_index_to_anchor">_term_index_to_anchor</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">term</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter._term_index_to_anchor-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter._term_index_to_anchor-expanded"><a name="L2971"></a><tt class="py-lineno">2971</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L2972"></a><tt class="py-lineno">2972</tt> <tt class="py-line"><tt class="py-docstring"> Given the name of an inline index item, construct a URI anchor.</tt> </tt>
<a name="L2973"></a><tt class="py-lineno">2973</tt> <tt class="py-line"><tt class="py-docstring"> These anchors are used to create links from the index page to each</tt> </tt>
<a name="L2974"></a><tt class="py-lineno">2974</tt> <tt class="py-line"><tt class="py-docstring"> index item.</tt> </tt>
<a name="L2975"></a><tt class="py-lineno">2975</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L2976"></a><tt class="py-lineno">2976</tt> <tt class="py-line"> <tt class="py-comment"># Include "-" so we don't accidentally collide with the name</tt> </tt>
<a name="L2977"></a><tt class="py-lineno">2977</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># of a python identifier.</tt> </tt>
<a name="L2978"></a><tt class="py-lineno">2978</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">s</tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">sub</tt><tt class="py-op">(</tt><tt class="py-string">r'\s\s+'</tt><tt class="py-op">,</tt> <tt class="py-string">'-'</tt><tt class="py-op">,</tt> <tt class="py-name">term</tt><tt class="py-op">.</tt><tt id="link-930" class="py-name"><a title="epydoc.markup.ConcatenatedDocstring.to_plaintext
epydoc.markup.ParsedDocstring.to_plaintext
epydoc.markup.epytext.ParsedEpytextDocstring.to_plaintext
epydoc.markup.epytext.to_plaintext
epydoc.markup.javadoc.ParsedJavadocDocstring.to_plaintext
epydoc.markup.plaintext.ParsedPlaintextDocstring.to_plaintext
epydoc.markup.restructuredtext.ParsedRstDocstring.to_plaintext" class="py-name" href="#" onclick="return doclink('link-930', 'to_plaintext', 'link-727');">to_plaintext</a></tt><tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L2979"></a><tt class="py-lineno">2979</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">"index-"</tt><tt class="py-op">+</tt><tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">sub</tt><tt class="py-op">(</tt><tt class="py-string">"[^a-zA-Z0-9]"</tt><tt class="py-op">,</tt> <tt class="py-string">"_"</tt><tt class="py-op">,</tt> <tt class="py-name">s</tt><tt class="py-op">)</tt> </tt>
</div><a name="L2980"></a><tt class="py-lineno">2980</tt> <tt class="py-line"> </tt>
<a name="L2981"></a><tt class="py-lineno">2981</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L2982"></a><tt class="py-lineno">2982</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ Redirect page</tt> </tt>
<a name="L2983"></a><tt class="py-lineno">2983</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L2984"></a><tt class="py-lineno">2984</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="HTMLWriter.write_redirect_page"></a><div id="HTMLWriter.write_redirect_page-def"><a name="L2985"></a><tt class="py-lineno">2985</tt> <a class="py-toggle" href="#" id="HTMLWriter.write_redirect_page-toggle" onclick="return toggle('HTMLWriter.write_redirect_page');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write_redirect_page">write_redirect_page</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write_redirect_page-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write_redirect_page-expanded"><a name="L2986"></a><tt class="py-lineno">2986</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L2987"></a><tt class="py-lineno">2987</tt> <tt class="py-line"><tt class="py-docstring"> Build the auto-redirect page, which translates dotted names to</tt> </tt>
<a name="L2988"></a><tt class="py-lineno">2988</tt> <tt class="py-line"><tt class="py-docstring"> URLs using javascript. When the user visits</tt> </tt>
<a name="L2989"></a><tt class="py-lineno">2989</tt> <tt class="py-line"><tt class="py-docstring"> <redirect.html#dotted.name>, they will automatically get</tt> </tt>
<a name="L2990"></a><tt class="py-lineno">2990</tt> <tt class="py-line"><tt class="py-docstring"> redirected to the page for the object with the given</tt> </tt>
<a name="L2991"></a><tt class="py-lineno">2991</tt> <tt class="py-line"><tt class="py-docstring"> fully-qualified dotted name. E.g., for epydoc,</tt> </tt>
<a name="L2992"></a><tt class="py-lineno">2992</tt> <tt class="py-line"><tt class="py-docstring"> <redirect.html#epydoc.apidoc.UNKNOWN> redirects the user to</tt> </tt>
<a name="L2993"></a><tt class="py-lineno">2993</tt> <tt class="py-line"><tt class="py-docstring"> <epydoc.apidoc-module.html#UNKNOWN>.</tt> </tt>
<a name="L2994"></a><tt class="py-lineno">2994</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L2995"></a><tt class="py-lineno">2995</tt> <tt class="py-line"> <tt class="py-comment"># Construct a list of all the module & class pages that we're</tt> </tt>
<a name="L2996"></a><tt class="py-lineno">2996</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># documenting. The redirect_url javascript will scan through</tt> </tt>
<a name="L2997"></a><tt class="py-lineno">2997</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># this list, looking for a page name that matches the</tt> </tt>
<a name="L2998"></a><tt class="py-lineno">2998</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># requested dotted name.</tt> </tt>
<a name="L2999"></a><tt class="py-lineno">2999</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">pages</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'%s-m'</tt> <tt class="py-op">%</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-931" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-931', 'canonical_name', 'link-82');">canonical_name</a></tt> </tt>
<a name="L3000"></a><tt class="py-lineno">3000</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">val_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">module_list</tt><tt class="py-op">]</tt> <tt class="py-op">+</tt> </tt>
<a name="L3001"></a><tt class="py-lineno">3001</tt> <tt class="py-line"> <tt class="py-op">[</tt><tt class="py-string">'%s-c'</tt> <tt class="py-op">%</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-932" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-932', 'canonical_name', 'link-82');">canonical_name</a></tt> </tt>
<a name="L3002"></a><tt class="py-lineno">3002</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">val_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">class_list</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L3003"></a><tt class="py-lineno">3003</tt> <tt class="py-line"> <tt class="py-comment"># Sort the pages from longest to shortest. This ensures that</tt> </tt>
<a name="L3004"></a><tt class="py-lineno">3004</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># we find e.g. "x.y.z" in the list before "x.y".</tt> </tt>
<a name="L3005"></a><tt class="py-lineno">3005</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">pages</tt> <tt class="py-op">=</tt> <tt id="link-933" class="py-name"><a title="epydoc.compat.sorted" class="py-name" href="#" onclick="return doclink('link-933', 'sorted', 'link-49');">sorted</a></tt><tt class="py-op">(</tt><tt class="py-name">pages</tt><tt class="py-op">,</tt> <tt id="link-934" class="py-name"><a title="epydoc.cli.key" class="py-name" href="#" onclick="return doclink('link-934', 'key', 'link-79');">key</a></tt><tt class="py-op">=</tt><tt class="py-keyword">lambda</tt> <tt class="py-name">p</tt><tt class="py-op">:</tt><tt class="py-op">-</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">p</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L3006"></a><tt class="py-lineno">3006</tt> <tt class="py-line"> </tt>
<a name="L3007"></a><tt class="py-lineno">3007</tt> <tt class="py-line"> <tt class="py-comment"># Write the redirect page.</tt> </tt>
<a name="L3008"></a><tt class="py-lineno">3008</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-935" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter._write_redirect_page()=epydoc.docwriter.html.HTMLWriter-class.html#_write_redirect_page"><a title="epydoc.docwriter.html.HTMLWriter._write_redirect_page" class="py-name" href="#" onclick="return doclink('link-935', '_write_redirect_page', 'link-935');">_write_redirect_page</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">pages</tt><tt class="py-op">)</tt> </tt>
</div><a name="L3009"></a><tt class="py-lineno">3009</tt> <tt class="py-line"> </tt>
<a name="L3010"></a><tt class="py-lineno">3010</tt> <tt class="py-line"> <tt id="link-936" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._write_redirect_page" class="py-name" href="#" onclick="return doclink('link-936', '_write_redirect_page', 'link-935');">_write_redirect_page</a></tt> <tt class="py-op">=</tt> <tt id="link-937" class="py-name"><a title="epydoc.docwriter.html.compile_template" class="py-name" href="#" onclick="return doclink('link-937', 'compile_template', 'link-427');">compile_template</a></tt><tt class="py-op">(</tt> </tt>
<a name="L3011"></a><tt class="py-lineno">3011</tt> <tt class="py-line"> <tt class="py-string">'''</tt> </tt>
<a name="L3012"></a><tt class="py-lineno">3012</tt> <tt class="py-line"><tt class="py-string"> _write_redirect_page(self, out, pages)</tt> </tt>
<a name="L3013"></a><tt class="py-lineno">3013</tt> <tt class="py-line"><tt class="py-string"> '''</tt><tt class="py-op">,</tt> </tt>
<a name="L3014"></a><tt class="py-lineno">3014</tt> <tt class="py-line"> <tt class="py-comment"># /------------------------- Template -------------------------\</tt> </tt>
<a name="L3015"></a><tt class="py-lineno">3015</tt> <tt class="py-line"> <tt class="py-string">'''</tt> </tt>
<a name="L3016"></a><tt class="py-lineno">3016</tt> <tt class="py-line"><tt class="py-string"> <html><head><title>Epydoc Redirect Page</title></tt> </tt>
<a name="L3017"></a><tt class="py-lineno">3017</tt> <tt class="py-line"><tt class="py-string"> <meta http-equiv="cache-control" content="no-cache" /></tt> </tt>
<a name="L3018"></a><tt class="py-lineno">3018</tt> <tt class="py-line"><tt class="py-string"> <meta http-equiv="expires" content="0" /></tt> </tt>
<a name="L3019"></a><tt class="py-lineno">3019</tt> <tt class="py-line"><tt class="py-string"> <meta http-equiv="pragma" content="no-cache" /></tt> </tt>
<a name="L3020"></a><tt class="py-lineno">3020</tt> <tt class="py-line"><tt class="py-string"> <script type="text/javascript" src="epydoc.js"></script></tt> </tt>
<a name="L3021"></a><tt class="py-lineno">3021</tt> <tt class="py-line"><tt class="py-string"> </head></tt> </tt>
<a name="L3022"></a><tt class="py-lineno">3022</tt> <tt class="py-line"><tt class="py-string"> <body></tt> </tt>
<a name="L3023"></a><tt class="py-lineno">3023</tt> <tt class="py-line"><tt class="py-string"> <script type="text/javascript"></tt> </tt>
<a name="L3024"></a><tt class="py-lineno">3024</tt> <tt class="py-line"><tt class="py-string"> <!--</tt> </tt>
<a name="L3025"></a><tt class="py-lineno">3025</tt> <tt class="py-line"><tt class="py-string"> var pages = $"[%s]" % ", ".join(['"%s"' % v for v in pages])$;</tt> </tt>
<a name="L3026"></a><tt class="py-lineno">3026</tt> <tt class="py-line"><tt class="py-string"> var dottedName = get_anchor();</tt> </tt>
<a name="L3027"></a><tt class="py-lineno">3027</tt> <tt class="py-line"><tt class="py-string"> if (dottedName) {</tt> </tt>
<a name="L3028"></a><tt class="py-lineno">3028</tt> <tt class="py-line"><tt class="py-string"> var target = redirect_url(dottedName);</tt> </tt>
<a name="L3029"></a><tt class="py-lineno">3029</tt> <tt class="py-line"><tt class="py-string"> if (target) window.location.replace(target);</tt> </tt>
<a name="L3030"></a><tt class="py-lineno">3030</tt> <tt class="py-line"><tt class="py-string"> }</tt> </tt>
<a name="L3031"></a><tt class="py-lineno">3031</tt> <tt class="py-line"><tt class="py-string"> // --></tt> </tt>
<a name="L3032"></a><tt class="py-lineno">3032</tt> <tt class="py-line"><tt class="py-string"> </script></tt> </tt>
<a name="L3033"></a><tt class="py-lineno">3033</tt> <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L3034"></a><tt class="py-lineno">3034</tt> <tt class="py-line"><tt class="py-string"> <h3>Epydoc Auto-redirect page</h3></tt> </tt>
<a name="L3035"></a><tt class="py-lineno">3035</tt> <tt class="py-line"><tt class="py-string"> </tt> </tt>
<a name="L3036"></a><tt class="py-lineno">3036</tt> <tt class="py-line"><tt class="py-string"> <p>When javascript is enabled, this page will redirect URLs of</tt> </tt>
<a name="L3037"></a><tt class="py-lineno">3037</tt> <tt class="py-line"><tt class="py-string"> the form <tt>redirect.html#<i>dotted.name</i></tt> to the</tt> </tt>
<a name="L3038"></a><tt class="py-lineno">3038</tt> <tt class="py-line"><tt class="py-string"> documentation for the object with the given fully-qualified</tt> </tt>
<a name="L3039"></a><tt class="py-lineno">3039</tt> <tt class="py-line"><tt class="py-string"> dotted name.</p></tt> </tt>
<a name="L3040"></a><tt class="py-lineno">3040</tt> <tt class="py-line"><tt class="py-string"> <p><a id="message"> &nbsp; </a></p></tt> </tt>
<a name="L3041"></a><tt class="py-lineno">3041</tt> <tt class="py-line"><tt class="py-string"> </tt> </tt>
<a name="L3042"></a><tt class="py-lineno">3042</tt> <tt class="py-line"><tt class="py-string"> <script type="text/javascript"></tt> </tt>
<a name="L3043"></a><tt class="py-lineno">3043</tt> <tt class="py-line"><tt class="py-string"> <!--</tt> </tt>
<a name="L3044"></a><tt class="py-lineno">3044</tt> <tt class="py-line"><tt class="py-string"> if (dottedName) {</tt> </tt>
<a name="L3045"></a><tt class="py-lineno">3045</tt> <tt class="py-line"><tt class="py-string"> var msg = document.getElementById("message");</tt> </tt>
<a name="L3046"></a><tt class="py-lineno">3046</tt> <tt class="py-line"><tt class="py-string"> msg.innerHTML = "No documentation found for <tt>"+</tt> </tt>
<a name="L3047"></a><tt class="py-lineno">3047</tt> <tt class="py-line"><tt class="py-string"> dottedName+"</tt>";</tt> </tt>
<a name="L3048"></a><tt class="py-lineno">3048</tt> <tt class="py-line"><tt class="py-string"> }</tt> </tt>
<a name="L3049"></a><tt class="py-lineno">3049</tt> <tt class="py-line"><tt class="py-string"> // --></tt> </tt>
<a name="L3050"></a><tt class="py-lineno">3050</tt> <tt class="py-line"><tt class="py-string"> </script></tt> </tt>
<a name="L3051"></a><tt class="py-lineno">3051</tt> <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L3052"></a><tt class="py-lineno">3052</tt> <tt class="py-line"><tt class="py-string"> </body></tt> </tt>
<a name="L3053"></a><tt class="py-lineno">3053</tt> <tt class="py-line"><tt class="py-string"> </html></tt> </tt>
<a name="L3054"></a><tt class="py-lineno">3054</tt> <tt class="py-line"><tt class="py-string"> '''</tt><tt class="py-op">)</tt> </tt>
<a name="L3055"></a><tt class="py-lineno">3055</tt> <tt class="py-line"> <tt class="py-comment"># \------------------------------------------------------------/</tt> </tt>
<a name="L3056"></a><tt class="py-lineno">3056</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L3057"></a><tt class="py-lineno">3057</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L3058"></a><tt class="py-lineno">3058</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ URLs list</tt> </tt>
<a name="L3059"></a><tt class="py-lineno">3059</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L3060"></a><tt class="py-lineno">3060</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="HTMLWriter.write_api_list"></a><div id="HTMLWriter.write_api_list-def"><a name="L3061"></a><tt class="py-lineno">3061</tt> <a class="py-toggle" href="#" id="HTMLWriter.write_api_list-toggle" onclick="return toggle('HTMLWriter.write_api_list');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write_api_list">write_api_list</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write_api_list-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write_api_list-expanded"><a name="L3062"></a><tt class="py-lineno">3062</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L3063"></a><tt class="py-lineno">3063</tt> <tt class="py-line"><tt class="py-docstring"> Write a list of mapping name->url for all the documented objects.</tt> </tt>
<a name="L3064"></a><tt class="py-lineno">3064</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L3065"></a><tt class="py-lineno">3065</tt> <tt class="py-line"> <tt class="py-comment"># Construct a list of all the module & class pages that we're</tt> </tt>
<a name="L3066"></a><tt class="py-lineno">3066</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># documenting. The redirect_url javascript will scan through</tt> </tt>
<a name="L3067"></a><tt class="py-lineno">3067</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># this list, looking for a page name that matches the</tt> </tt>
<a name="L3068"></a><tt class="py-lineno">3068</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># requested dotted name.</tt> </tt>
<a name="L3069"></a><tt class="py-lineno">3069</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">skip</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt id="link-938" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-938', 'ModuleDoc', 'link-55');">ModuleDoc</a></tt><tt class="py-op">,</tt> <tt id="link-939" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-939', 'ClassDoc', 'link-56');">ClassDoc</a></tt><tt class="py-op">,</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt id="link-940" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-940', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L3070"></a><tt class="py-lineno">3070</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">val_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">module_list</tt><tt class="py-op">:</tt> </tt>
<a name="L3071"></a><tt class="py-lineno">3071</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-941" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter.write_url_record()=epydoc.docwriter.html.HTMLWriter-class.html#write_url_record"><a title="epydoc.docwriter.html.HTMLWriter.write_url_record" class="py-name" href="#" onclick="return doclink('link-941', 'write_url_record', 'link-941');">write_url_record</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">val_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L3072"></a><tt class="py-lineno">3072</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">var</tt> <tt class="py-keyword">in</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-942" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-942', 'variables', 'link-60');">variables</a></tt><tt class="py-op">.</tt><tt class="py-name">itervalues</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3073"></a><tt class="py-lineno">3073</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">var</tt><tt class="py-op">.</tt><tt id="link-943" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-943', 'value', 'link-61');">value</a></tt><tt class="py-op">,</tt> <tt class="py-name">skip</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3074"></a><tt class="py-lineno">3074</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-944" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_url_record" class="py-name" href="#" onclick="return doclink('link-944', 'write_url_record', 'link-941');">write_url_record</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">var</tt><tt class="py-op">)</tt> </tt>
<a name="L3075"></a><tt class="py-lineno">3075</tt> <tt class="py-line"> </tt>
<a name="L3076"></a><tt class="py-lineno">3076</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">val_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">class_list</tt><tt class="py-op">:</tt> </tt>
<a name="L3077"></a><tt class="py-lineno">3077</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-945" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_url_record" class="py-name" href="#" onclick="return doclink('link-945', 'write_url_record', 'link-941');">write_url_record</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">val_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L3078"></a><tt class="py-lineno">3078</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">var</tt> <tt class="py-keyword">in</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-946" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-946', 'variables', 'link-60');">variables</a></tt><tt class="py-op">.</tt><tt class="py-name">itervalues</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3079"></a><tt class="py-lineno">3079</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-947" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_url_record" class="py-name" href="#" onclick="return doclink('link-947', 'write_url_record', 'link-941');">write_url_record</a></tt><tt class="py-op">(</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">var</tt><tt class="py-op">)</tt> </tt>
</div><a name="L3080"></a><tt class="py-lineno">3080</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.write_url_record"></a><div id="HTMLWriter.write_url_record-def"><a name="L3081"></a><tt class="py-lineno">3081</tt> <a class="py-toggle" href="#" id="HTMLWriter.write_url_record-toggle" onclick="return toggle('HTMLWriter.write_url_record');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#write_url_record">write_url_record</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">,</tt> <tt class="py-param">obj</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.write_url_record-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.write_url_record-expanded"><a name="L3082"></a><tt class="py-lineno">3082</tt> <tt class="py-line"> <tt id="link-948" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-948', 'url', 'link-72');">url</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-949" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-949', 'url', 'link-72');">url</a></tt><tt class="py-op">(</tt><tt class="py-name">obj</tt><tt class="py-op">)</tt> </tt>
<a name="L3083"></a><tt class="py-lineno">3083</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-950" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-950', 'url', 'link-72');">url</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L3084"></a><tt class="py-lineno">3084</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">(</tt><tt class="py-string">"%s\t%s\n"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">obj</tt><tt class="py-op">.</tt><tt id="link-951" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-951', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">,</tt> <tt id="link-952" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-952', 'url', 'link-72');">url</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L3085"></a><tt class="py-lineno">3085</tt> <tt class="py-line"> </tt>
<a name="L3086"></a><tt class="py-lineno">3086</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L3087"></a><tt class="py-lineno">3087</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ Helper functions</tt> </tt>
<a name="L3088"></a><tt class="py-lineno">3088</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L3089"></a><tt class="py-lineno">3089</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="HTMLWriter._val_is_public"></a><div id="HTMLWriter._val_is_public-def"><a name="L3090"></a><tt class="py-lineno">3090</tt> <a class="py-toggle" href="#" id="HTMLWriter._val_is_public-toggle" onclick="return toggle('HTMLWriter._val_is_public');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#_val_is_public">_val_is_public</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">valdoc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter._val_is_public-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter._val_is_public-expanded"><a name="L3091"></a><tt class="py-lineno">3091</tt> <tt class="py-line"> <tt class="py-docstring">"""Make a best-guess as to whether the given class is public."""</tt> </tt>
<a name="L3092"></a><tt class="py-lineno">3092</tt> <tt class="py-line"> <tt id="link-953" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-953', 'container', 'link-63');">container</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt id="link-954" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-954', 'container', 'link-63');">container</a></tt><tt class="py-op">(</tt><tt class="py-name">valdoc</tt><tt class="py-op">)</tt> </tt>
<a name="L3093"></a><tt class="py-lineno">3093</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt id="link-955" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-955', 'container', 'link-63');">container</a></tt><tt class="py-op">,</tt> <tt id="link-956" class="py-name"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-956', 'NamespaceDoc', 'link-59');">NamespaceDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3094"></a><tt class="py-lineno">3094</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">vardoc</tt> <tt class="py-keyword">in</tt> <tt id="link-957" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-957', 'container', 'link-63');">container</a></tt><tt class="py-op">.</tt><tt id="link-958" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-958', 'variables', 'link-60');">variables</a></tt><tt class="py-op">.</tt><tt class="py-name">values</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3095"></a><tt class="py-lineno">3095</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">vardoc</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt id="link-959" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-959', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">continue</tt> </tt>
<a name="L3096"></a><tt class="py-lineno">3096</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">vardoc</tt><tt class="py-op">.</tt><tt id="link-960" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-960', 'value', 'link-61');">value</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">valdoc</tt><tt class="py-op">:</tt> </tt>
<a name="L3097"></a><tt class="py-lineno">3097</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">vardoc</tt><tt class="py-op">.</tt><tt id="link-961" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_public" class="py-name" href="#" onclick="return doclink('link-961', 'is_public', 'link-578');">is_public</a></tt> </tt>
<a name="L3098"></a><tt class="py-lineno">3098</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
</div><a name="L3099"></a><tt class="py-lineno">3099</tt> <tt class="py-line"> </tt>
<a name="L3100"></a><tt class="py-lineno">3100</tt> <tt class="py-line"> <tt class="py-comment"># [XX] Is it worth-while to pull the anchor tricks that I do here?</tt> </tt>
<a name="L3101"></a><tt class="py-lineno">3101</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># Or should I just live with the fact that show/hide private moves</tt> </tt>
<a name="L3102"></a><tt class="py-lineno">3102</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># stuff around?</tt> </tt>
<a name="L3103"></a><tt class="py-lineno">3103</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-962" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_table_header" class="py-name" href="#" onclick="return doclink('link-962', 'write_table_header', 'link-375');">write_table_header</a></tt> <tt class="py-op">=</tt> <tt id="link-963" class="py-name"><a title="epydoc.docwriter.html.compile_template" class="py-name" href="#" onclick="return doclink('link-963', 'compile_template', 'link-427');">compile_template</a></tt><tt class="py-op">(</tt> </tt>
<a name="L3104"></a><tt class="py-lineno">3104</tt> <tt class="py-line"> <tt class="py-string">'''</tt> </tt>
<a name="L3105"></a><tt class="py-lineno">3105</tt> <tt class="py-line"><tt class="py-string"> write_table_header(self, out, css_class, heading=None, \</tt> </tt>
<a name="L3106"></a><tt class="py-lineno">3106</tt> <tt class="py-line"><tt class="py-string"> private_link=True, colspan=2)</tt> </tt>
<a name="L3107"></a><tt class="py-lineno">3107</tt> <tt class="py-line"><tt class="py-string"> '''</tt><tt class="py-op">,</tt> </tt>
<a name="L3108"></a><tt class="py-lineno">3108</tt> <tt class="py-line"> <tt class="py-comment"># /------------------------- Template -------------------------\</tt> </tt>
<a name="L3109"></a><tt class="py-lineno">3109</tt> <tt class="py-line"> <tt class="py-string">'''</tt> </tt>
<a name="L3110"></a><tt class="py-lineno">3110</tt> <tt class="py-line"><tt class="py-string"> >>> if heading is not None:</tt> </tt>
<a name="L3111"></a><tt class="py-lineno">3111</tt> <tt class="py-line"><tt class="py-string"> >>> anchor = "section-%s" % re.sub("\W", "", heading)</tt> </tt>
<a name="L3112"></a><tt class="py-lineno">3112</tt> <tt class="py-line"><tt class="py-string"> <!-- ==================== $heading.upper()$ ==================== --></tt> </tt>
<a name="L3113"></a><tt class="py-lineno">3113</tt> <tt class="py-line"><tt class="py-string"> <a name="$anchor$"></a></tt> </tt>
<a name="L3114"></a><tt class="py-lineno">3114</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L3115"></a><tt class="py-lineno">3115</tt> <tt class="py-line"><tt class="py-string"> <table class="$css_class$" border="1" cellpadding="3"</tt> </tt>
<a name="L3116"></a><tt class="py-lineno">3116</tt> <tt class="py-line"><tt class="py-string"> cellspacing="0" width="100%" bgcolor="white"></tt> </tt>
<a name="L3117"></a><tt class="py-lineno">3117</tt> <tt class="py-line"><tt class="py-string"> >>> if heading is not None:</tt> </tt>
<a name="L3118"></a><tt class="py-lineno">3118</tt> <tt class="py-line"><tt class="py-string"> <tr bgcolor="#70b0f0" class="table-header"></tt> </tt>
<a name="L3119"></a><tt class="py-lineno">3119</tt> <tt class="py-line"><tt class="py-string"> >>> if private_link and self._show_private:</tt> </tt>
<a name="L3120"></a><tt class="py-lineno">3120</tt> <tt class="py-line"><tt class="py-string"> <td colspan="$colspan$" class="table-header"></tt> </tt>
<a name="L3121"></a><tt class="py-lineno">3121</tt> <tt class="py-line"><tt class="py-string"> <table border="0" cellpadding="0" cellspacing="0" width="100%"></tt> </tt>
<a name="L3122"></a><tt class="py-lineno">3122</tt> <tt class="py-line"><tt class="py-string"> <tr valign="top"></tt> </tt>
<a name="L3123"></a><tt class="py-lineno">3123</tt> <tt class="py-line"><tt class="py-string"> <td align="left"><span class="table-header">$heading$</span></td></tt> </tt>
<a name="L3124"></a><tt class="py-lineno">3124</tt> <tt class="py-line"><tt class="py-string"> <td align="right" valign="top"</tt> </tt>
<a name="L3125"></a><tt class="py-lineno">3125</tt> <tt class="py-line"><tt class="py-string"> ><span class="options">[<a href="#$anchor$"</tt> </tt>
<a name="L3126"></a><tt class="py-lineno">3126</tt> <tt class="py-line"><tt class="py-string"> class="privatelink" onclick="toggle_private();"</tt> </tt>
<a name="L3127"></a><tt class="py-lineno">3127</tt> <tt class="py-line"><tt class="py-string"> >hide private</a>]</span></td></tt> </tt>
<a name="L3128"></a><tt class="py-lineno">3128</tt> <tt class="py-line"><tt class="py-string"> </tr></tt> </tt>
<a name="L3129"></a><tt class="py-lineno">3129</tt> <tt class="py-line"><tt class="py-string"> </table></tt> </tt>
<a name="L3130"></a><tt class="py-lineno">3130</tt> <tt class="py-line"><tt class="py-string"> </td></tt> </tt>
<a name="L3131"></a><tt class="py-lineno">3131</tt> <tt class="py-line"><tt class="py-string"> >>> else:</tt> </tt>
<a name="L3132"></a><tt class="py-lineno">3132</tt> <tt class="py-line"><tt class="py-string"> <td align="left" colspan="2" class="table-header"></tt> </tt>
<a name="L3133"></a><tt class="py-lineno">3133</tt> <tt class="py-line"><tt class="py-string"> <span class="table-header">$heading$</span></td></tt> </tt>
<a name="L3134"></a><tt class="py-lineno">3134</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L3135"></a><tt class="py-lineno">3135</tt> <tt class="py-line"><tt class="py-string"> </tr></tt> </tt>
<a name="L3136"></a><tt class="py-lineno">3136</tt> <tt class="py-line"><tt class="py-string"> >>> #endif</tt> </tt>
<a name="L3137"></a><tt class="py-lineno">3137</tt> <tt class="py-line"><tt class="py-string"> '''</tt><tt class="py-op">)</tt> </tt>
<a name="L3138"></a><tt class="py-lineno">3138</tt> <tt class="py-line"> <tt class="py-comment"># \------------------------------------------------------------/</tt> </tt>
<a name="L3139"></a><tt class="py-lineno">3139</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L3140"></a><tt class="py-lineno">3140</tt> <tt class="py-line"> <tt id="link-964" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.TABLE_FOOTER" class="py-name" href="#" onclick="return doclink('link-964', 'TABLE_FOOTER', 'link-581');">TABLE_FOOTER</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'</table>\n'</tt> </tt>
<a name="L3141"></a><tt class="py-lineno">3141</tt> <tt class="py-line"> </tt>
<a name="L3142"></a><tt class="py-lineno">3142</tt> <tt class="py-line"> <tt id="link-965" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.PRIVATE_LINK" class="py-name" href="#" onclick="return doclink('link-965', 'PRIVATE_LINK', 'link-446');">PRIVATE_LINK</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'''</tt> </tt>
<a name="L3143"></a><tt class="py-lineno">3143</tt> <tt class="py-line"><tt class="py-string"> <span class="options">[<a href="javascript:void(0);" class="privatelink"</tt> </tt>
<a name="L3144"></a><tt class="py-lineno">3144</tt> <tt class="py-line"><tt class="py-string"> onclick="toggle_private();">hide&nbsp;private</a>]</span></tt> </tt>
<a name="L3145"></a><tt class="py-lineno">3145</tt> <tt class="py-line"><tt class="py-string"> '''</tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L3146"></a><tt class="py-lineno">3146</tt> <tt class="py-line"> </tt>
<a name="L3147"></a><tt class="py-lineno">3147</tt> <tt class="py-line"> <tt id="link-966" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.write_group_header" class="py-name" href="#" onclick="return doclink('link-966', 'write_group_header', 'link-579');">write_group_header</a></tt> <tt class="py-op">=</tt> <tt id="link-967" class="py-name"><a title="epydoc.docwriter.html.compile_template" class="py-name" href="#" onclick="return doclink('link-967', 'compile_template', 'link-427');">compile_template</a></tt><tt class="py-op">(</tt> </tt>
<a name="L3148"></a><tt class="py-lineno">3148</tt> <tt class="py-line"> <tt class="py-string">'''</tt> </tt>
<a name="L3149"></a><tt class="py-lineno">3149</tt> <tt class="py-line"><tt class="py-string"> write_group_header(self, out, group, tr_class='')</tt> </tt>
<a name="L3150"></a><tt class="py-lineno">3150</tt> <tt class="py-line"><tt class="py-string"> '''</tt><tt class="py-op">,</tt> </tt>
<a name="L3151"></a><tt class="py-lineno">3151</tt> <tt class="py-line"> <tt class="py-comment"># /------------------------- Template -------------------------\</tt> </tt>
<a name="L3152"></a><tt class="py-lineno">3152</tt> <tt class="py-line"> <tt class="py-string">'''</tt> </tt>
<a name="L3153"></a><tt class="py-lineno">3153</tt> <tt class="py-line"><tt class="py-string"> <tr bgcolor="#e8f0f8" $tr_class$></tt> </tt>
<a name="L3154"></a><tt class="py-lineno">3154</tt> <tt class="py-line"><tt class="py-string"> <th colspan="2" class="group-header"</tt> </tt>
<a name="L3155"></a><tt class="py-lineno">3155</tt> <tt class="py-line"><tt class="py-string"> >&nbsp;&nbsp;&nbsp;&nbsp;$group$</th></tr></tt> </tt>
<a name="L3156"></a><tt class="py-lineno">3156</tt> <tt class="py-line"><tt class="py-string"> '''</tt><tt class="py-op">)</tt> </tt>
<a name="L3157"></a><tt class="py-lineno">3157</tt> <tt class="py-line"> <tt class="py-comment"># \------------------------------------------------------------/</tt> </tt>
<a name="L3158"></a><tt class="py-lineno">3158</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L3159"></a><tt class="py-lineno">3159</tt> <tt class="py-line"> <tt id="link-968" class="py-name" targets="Variable epydoc.docwriter.html.HTMLWriter._url_cache=epydoc.docwriter.html.HTMLWriter-class.html#_url_cache"><a title="epydoc.docwriter.html.HTMLWriter._url_cache" class="py-name" href="#" onclick="return doclink('link-968', '_url_cache', 'link-968');">_url_cache</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="HTMLWriter.url"></a><div id="HTMLWriter.url-def"><a name="L3160"></a><tt class="py-lineno">3160</tt> <a class="py-toggle" href="#" id="HTMLWriter.url-toggle" onclick="return toggle('HTMLWriter.url');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#url">url</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">obj</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.url-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.url-expanded"><a name="L3161"></a><tt class="py-lineno">3161</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L3162"></a><tt class="py-lineno">3162</tt> <tt class="py-line"><tt class="py-docstring"> Return the URL for the given object, which can be a</tt> </tt>
<a name="L3163"></a><tt class="py-lineno">3163</tt> <tt class="py-line"><tt class="py-docstring"> C{VariableDoc}, a C{ValueDoc}, or a C{DottedName}.</tt> </tt>
<a name="L3164"></a><tt class="py-lineno">3164</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L3165"></a><tt class="py-lineno">3165</tt> <tt class="py-line"> <tt class="py-name">cached_url</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-969" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._url_cache" class="py-name" href="#" onclick="return doclink('link-969', '_url_cache', 'link-968');">_url_cache</a></tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-name">id</tt><tt class="py-op">(</tt><tt class="py-name">obj</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L3166"></a><tt class="py-lineno">3166</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">cached_url</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L3167"></a><tt class="py-lineno">3167</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">cached_url</tt> </tt>
<a name="L3168"></a><tt class="py-lineno">3168</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L3169"></a><tt class="py-lineno">3169</tt> <tt class="py-line"> <tt id="link-970" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-970', 'url', 'link-72');">url</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-971" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._url_cache" class="py-name" href="#" onclick="return doclink('link-971', '_url_cache', 'link-968');">_url_cache</a></tt><tt class="py-op">[</tt><tt class="py-name">id</tt><tt class="py-op">(</tt><tt class="py-name">obj</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-972" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter._url()=epydoc.docwriter.html.HTMLWriter-class.html#_url"><a title="epydoc.docwriter.html.HTMLWriter._url" class="py-name" href="#" onclick="return doclink('link-972', '_url', 'link-972');">_url</a></tt><tt class="py-op">(</tt><tt class="py-name">obj</tt><tt class="py-op">)</tt> </tt>
<a name="L3170"></a><tt class="py-lineno">3170</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-973" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-973', 'url', 'link-72');">url</a></tt> </tt>
</div><a name="L3171"></a><tt class="py-lineno">3171</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter._url"></a><div id="HTMLWriter._url-def"><a name="L3172"></a><tt class="py-lineno">3172</tt> <a class="py-toggle" href="#" id="HTMLWriter._url-toggle" onclick="return toggle('HTMLWriter._url');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#_url">_url</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">obj</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter._url-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter._url-expanded"><a name="L3173"></a><tt class="py-lineno">3173</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L3174"></a><tt class="py-lineno">3174</tt> <tt class="py-line"><tt class="py-docstring"> Internal helper for L{url}.</tt> </tt>
<a name="L3175"></a><tt class="py-lineno">3175</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L3176"></a><tt class="py-lineno">3176</tt> <tt class="py-line"> <tt class="py-comment"># Module: <canonical_name>-module.html</tt> </tt>
<a name="L3177"></a><tt class="py-lineno">3177</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">obj</tt><tt class="py-op">,</tt> <tt id="link-974" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-974', 'ModuleDoc', 'link-55');">ModuleDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3178"></a><tt class="py-lineno">3178</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">obj</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">module_set</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L3179"></a><tt class="py-lineno">3179</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">urllib</tt><tt class="py-op">.</tt><tt class="py-name">quote</tt><tt class="py-op">(</tt><tt class="py-string">'%s'</tt><tt class="py-op">%</tt><tt class="py-name">obj</tt><tt class="py-op">.</tt><tt id="link-975" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-975', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-string">'-module.html'</tt> </tt>
<a name="L3180"></a><tt class="py-lineno">3180</tt> <tt class="py-line"> <tt class="py-comment"># Class: <canonical_name>-class.html</tt> </tt>
<a name="L3181"></a><tt class="py-lineno">3181</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">obj</tt><tt class="py-op">,</tt> <tt id="link-976" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-976', 'ClassDoc', 'link-56');">ClassDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3182"></a><tt class="py-lineno">3182</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">obj</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">class_set</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L3183"></a><tt class="py-lineno">3183</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">urllib</tt><tt class="py-op">.</tt><tt class="py-name">quote</tt><tt class="py-op">(</tt><tt class="py-string">'%s'</tt><tt class="py-op">%</tt><tt class="py-name">obj</tt><tt class="py-op">.</tt><tt id="link-977" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-977', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-string">'-class.html'</tt> </tt>
<a name="L3184"></a><tt class="py-lineno">3184</tt> <tt class="py-line"> <tt class="py-comment"># Variable</tt> </tt>
<a name="L3185"></a><tt class="py-lineno">3185</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">obj</tt><tt class="py-op">,</tt> <tt id="link-978" class="py-name"><a title="epydoc.apidoc.VariableDoc" class="py-name" href="#" onclick="return doclink('link-978', 'VariableDoc', 'link-768');">VariableDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3186"></a><tt class="py-lineno">3186</tt> <tt class="py-line"> <tt class="py-name">val_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">obj</tt><tt class="py-op">.</tt><tt id="link-979" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-979', 'value', 'link-61');">value</a></tt> </tt>
<a name="L3187"></a><tt class="py-lineno">3187</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt id="link-980" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-980', 'ModuleDoc', 'link-55');">ModuleDoc</a></tt><tt class="py-op">,</tt> <tt id="link-981" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-981', 'ClassDoc', 'link-56');">ClassDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3188"></a><tt class="py-lineno">3188</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-982" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-982', 'url', 'link-72');">url</a></tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L3189"></a><tt class="py-lineno">3189</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">obj</tt><tt class="py-op">.</tt><tt id="link-983" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-983', 'container', 'link-63');">container</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-984" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-984', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3190"></a><tt class="py-lineno">3190</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">val_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-985" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-985', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L3191"></a><tt class="py-lineno">3191</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-986" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-986', 'url', 'link-72');">url</a></tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L3192"></a><tt class="py-lineno">3192</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">obj</tt><tt class="py-op">.</tt><tt id="link-987" class="py-name" targets="Variable epydoc.apidoc.VariableDoc.is_imported=epydoc.apidoc.VariableDoc-class.html#is_imported"><a title="epydoc.apidoc.VariableDoc.is_imported" class="py-name" href="#" onclick="return doclink('link-987', 'is_imported', 'link-987');">is_imported</a></tt> <tt class="py-op">==</tt> <tt class="py-name">True</tt><tt class="py-op">:</tt> </tt>
<a name="L3193"></a><tt class="py-lineno">3193</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">obj</tt><tt class="py-op">.</tt><tt id="link-988" class="py-name"><a title="epydoc.apidoc.VariableDoc.imported_from" class="py-name" href="#" onclick="return doclink('link-988', 'imported_from', 'link-814');">imported_from</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-989" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-989', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L3194"></a><tt class="py-lineno">3194</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-990" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-990', 'url', 'link-72');">url</a></tt><tt class="py-op">(</tt><tt class="py-name">obj</tt><tt class="py-op">.</tt><tt id="link-991" class="py-name"><a title="epydoc.apidoc.VariableDoc.imported_from" class="py-name" href="#" onclick="return doclink('link-991', 'imported_from', 'link-814');">imported_from</a></tt><tt class="py-op">)</tt> </tt>
<a name="L3195"></a><tt class="py-lineno">3195</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L3196"></a><tt class="py-lineno">3196</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L3197"></a><tt class="py-lineno">3197</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L3198"></a><tt class="py-lineno">3198</tt> <tt class="py-line"> <tt class="py-name">container_url</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-992" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-992', 'url', 'link-72');">url</a></tt><tt class="py-op">(</tt><tt class="py-name">obj</tt><tt class="py-op">.</tt><tt id="link-993" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-993', 'container', 'link-63');">container</a></tt><tt class="py-op">)</tt> </tt>
<a name="L3199"></a><tt class="py-lineno">3199</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">container_url</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L3200"></a><tt class="py-lineno">3200</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'%s#%s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">container_url</tt><tt class="py-op">,</tt> <tt class="py-name">urllib</tt><tt class="py-op">.</tt><tt class="py-name">quote</tt><tt class="py-op">(</tt><tt class="py-string">'%s'</tt><tt class="py-op">%</tt><tt class="py-name">obj</tt><tt class="py-op">.</tt><tt id="link-994" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-994', 'name', 'link-117');">name</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L3201"></a><tt class="py-lineno">3201</tt> <tt class="py-line"> <tt class="py-comment"># Value (other than module or class)</tt> </tt>
<a name="L3202"></a><tt class="py-lineno">3202</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">obj</tt><tt class="py-op">,</tt> <tt id="link-995" class="py-name"><a title="epydoc.apidoc.ValueDoc" class="py-name" href="#" onclick="return doclink('link-995', 'ValueDoc', 'link-87');">ValueDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3203"></a><tt class="py-lineno">3203</tt> <tt class="py-line"> <tt id="link-996" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-996', 'container', 'link-63');">container</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt id="link-997" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-997', 'container', 'link-63');">container</a></tt><tt class="py-op">(</tt><tt class="py-name">obj</tt><tt class="py-op">)</tt> </tt>
<a name="L3204"></a><tt class="py-lineno">3204</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-998" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-998', 'container', 'link-63');">container</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L3205"></a><tt class="py-lineno">3205</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> <tt class="py-comment"># We couldn't find it!</tt> </tt>
<a name="L3206"></a><tt class="py-lineno">3206</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L3207"></a><tt class="py-lineno">3207</tt> <tt class="py-line"> <tt class="py-name">container_url</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-999" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-999', 'url', 'link-72');">url</a></tt><tt class="py-op">(</tt><tt id="link-1000" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-1000', 'container', 'link-63');">container</a></tt><tt class="py-op">)</tt> </tt>
<a name="L3208"></a><tt class="py-lineno">3208</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">container_url</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L3209"></a><tt class="py-lineno">3209</tt> <tt class="py-line"> <tt class="py-name">anchor</tt> <tt class="py-op">=</tt> <tt class="py-name">urllib</tt><tt class="py-op">.</tt><tt class="py-name">quote</tt><tt class="py-op">(</tt><tt class="py-string">'%s'</tt><tt class="py-op">%</tt><tt class="py-name">obj</tt><tt class="py-op">.</tt><tt id="link-1001" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-1001', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L3210"></a><tt class="py-lineno">3210</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'%s#%s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">container_url</tt><tt class="py-op">,</tt> <tt class="py-name">anchor</tt><tt class="py-op">)</tt> </tt>
<a name="L3211"></a><tt class="py-lineno">3211</tt> <tt class="py-line"> <tt class="py-comment"># Dotted name: look up the corresponding APIDoc</tt> </tt>
<a name="L3212"></a><tt class="py-lineno">3212</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">obj</tt><tt class="py-op">,</tt> <tt id="link-1002" class="py-name" targets="Class epydoc.apidoc.DottedName=epydoc.apidoc.DottedName-class.html"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-1002', 'DottedName', 'link-1002');">DottedName</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3213"></a><tt class="py-lineno">3213</tt> <tt class="py-line"> <tt class="py-name">val_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt id="link-1003" class="py-name"><a title="epydoc.apidoc.DocIndex.get_valdoc" class="py-name" href="#" onclick="return doclink('link-1003', 'get_valdoc', 'link-71');">get_valdoc</a></tt><tt class="py-op">(</tt><tt class="py-name">obj</tt><tt class="py-op">)</tt> </tt>
<a name="L3214"></a><tt class="py-lineno">3214</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">val_doc</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L3215"></a><tt class="py-lineno">3215</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-1004" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-1004', 'url', 'link-72');">url</a></tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L3216"></a><tt class="py-lineno">3216</tt> <tt class="py-line"> <tt class="py-comment"># Special pages:</tt> </tt>
<a name="L3217"></a><tt class="py-lineno">3217</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-name">obj</tt> <tt class="py-op">==</tt> <tt class="py-string">'indices'</tt><tt class="py-op">:</tt> </tt>
<a name="L3218"></a><tt class="py-lineno">3218</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'identifier-index.html'</tt> </tt>
<a name="L3219"></a><tt class="py-lineno">3219</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">obj</tt> <tt class="py-op">==</tt> <tt class="py-string">'help'</tt><tt class="py-op">:</tt> </tt>
<a name="L3220"></a><tt class="py-lineno">3220</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'help.html'</tt> </tt>
<a name="L3221"></a><tt class="py-lineno">3221</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">obj</tt> <tt class="py-op">==</tt> <tt class="py-string">'trees'</tt><tt class="py-op">:</tt> </tt>
<a name="L3222"></a><tt class="py-lineno">3222</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_trees_url</tt> </tt>
<a name="L3223"></a><tt class="py-lineno">3223</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L3224"></a><tt class="py-lineno">3224</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">,</tt> <tt class="py-string">"Don't know what to do with %r"</tt> <tt class="py-op">%</tt> <tt class="py-name">obj</tt> </tt>
</div><a name="L3225"></a><tt class="py-lineno">3225</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.pysrc_link"></a><div id="HTMLWriter.pysrc_link-def"><a name="L3226"></a><tt class="py-lineno">3226</tt> <a class="py-toggle" href="#" id="HTMLWriter.pysrc_link-toggle" onclick="return toggle('HTMLWriter.pysrc_link');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#pysrc_link">pysrc_link</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">api_doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.pysrc_link-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.pysrc_link-expanded"><a name="L3227"></a><tt class="py-lineno">3227</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_incl_sourcecode</tt><tt class="py-op">:</tt> </tt>
<a name="L3228"></a><tt class="py-lineno">3228</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">''</tt> </tt>
<a name="L3229"></a><tt class="py-lineno">3229</tt> <tt class="py-line"> <tt id="link-1005" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-1005', 'url', 'link-72');">url</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-1006" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.pysrc_url" class="py-name" href="#" onclick="return doclink('link-1006', 'pysrc_url', 'link-183');">pysrc_url</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L3230"></a><tt class="py-lineno">3230</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-1007" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-1007', 'url', 'link-72');">url</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L3231"></a><tt class="py-lineno">3231</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-string">'<span class="codelink"><a href="%s">source&nbsp;'</tt> </tt>
<a name="L3232"></a><tt class="py-lineno">3232</tt> <tt class="py-line"> <tt class="py-string">'code</a></span>'</tt> <tt class="py-op">%</tt> <tt id="link-1008" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-1008', 'url', 'link-72');">url</a></tt><tt class="py-op">)</tt> </tt>
<a name="L3233"></a><tt class="py-lineno">3233</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L3234"></a><tt class="py-lineno">3234</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">''</tt> </tt>
</div><a name="L3235"></a><tt class="py-lineno">3235</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.pysrc_url"></a><div id="HTMLWriter.pysrc_url-def"><a name="L3236"></a><tt class="py-lineno">3236</tt> <a class="py-toggle" href="#" id="HTMLWriter.pysrc_url-toggle" onclick="return toggle('HTMLWriter.pysrc_url');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#pysrc_url">pysrc_url</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">api_doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.pysrc_url-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.pysrc_url-expanded"><a name="L3237"></a><tt class="py-lineno">3237</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-1009" class="py-name"><a title="epydoc.apidoc.VariableDoc" class="py-name" href="#" onclick="return doclink('link-1009', 'VariableDoc', 'link-768');">VariableDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3238"></a><tt class="py-lineno">3238</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-1010" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-1010', 'value', 'link-61');">value</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-1011" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-1011', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3239"></a><tt class="py-lineno">3239</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-1012" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.pysrc_url" class="py-name" href="#" onclick="return doclink('link-1012', 'pysrc_url', 'link-183');">pysrc_url</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-1013" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-1013', 'value', 'link-61');">value</a></tt><tt class="py-op">)</tt> </tt>
<a name="L3240"></a><tt class="py-lineno">3240</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L3241"></a><tt class="py-lineno">3241</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L3242"></a><tt class="py-lineno">3242</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-1014" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-1014', 'ModuleDoc', 'link-55');">ModuleDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3243"></a><tt class="py-lineno">3243</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">api_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">modules_with_sourcecode</tt><tt class="py-op">:</tt> </tt>
<a name="L3244"></a><tt class="py-lineno">3244</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-string">'%s-pysrc.html'</tt> <tt class="py-op">%</tt> </tt>
<a name="L3245"></a><tt class="py-lineno">3245</tt> <tt class="py-line"> <tt class="py-name">urllib</tt><tt class="py-op">.</tt><tt class="py-name">quote</tt><tt class="py-op">(</tt><tt class="py-string">'%s'</tt> <tt class="py-op">%</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-1015" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-1015', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L3246"></a><tt class="py-lineno">3246</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L3247"></a><tt class="py-lineno">3247</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L3248"></a><tt class="py-lineno">3248</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L3249"></a><tt class="py-lineno">3249</tt> <tt class="py-line"> <tt class="py-name">module</tt> <tt class="py-op">=</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-1016" class="py-name"><a title="epydoc.apidoc.ValueDoc.defining_module
epydoc.apidoc.VariableDoc.defining_module" class="py-name" href="#" onclick="return doclink('link-1016', 'defining_module', 'link-734');">defining_module</a></tt> </tt>
<a name="L3250"></a><tt class="py-lineno">3250</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">module</tt> <tt class="py-op">==</tt> <tt id="link-1017" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-1017', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L3251"></a><tt class="py-lineno">3251</tt> <tt class="py-line"> <tt class="py-name">module_pysrc_url</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-1018" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.pysrc_url" class="py-name" href="#" onclick="return doclink('link-1018', 'pysrc_url', 'link-183');">pysrc_url</a></tt><tt class="py-op">(</tt><tt class="py-name">module</tt><tt class="py-op">)</tt> </tt>
<a name="L3252"></a><tt class="py-lineno">3252</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">module_pysrc_url</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L3253"></a><tt class="py-lineno">3253</tt> <tt class="py-line"> <tt class="py-name">module_name</tt> <tt class="py-op">=</tt> <tt class="py-name">module</tt><tt class="py-op">.</tt><tt id="link-1019" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-1019', 'canonical_name', 'link-82');">canonical_name</a></tt> </tt>
<a name="L3254"></a><tt class="py-lineno">3254</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">module_name</tt><tt class="py-op">.</tt><tt id="link-1020" class="py-name"><a title="epydoc.apidoc.DottedName.dominates" class="py-name" href="#" onclick="return doclink('link-1020', 'dominates', 'link-84');">dominates</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-1021" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-1021', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3255"></a><tt class="py-lineno">3255</tt> <tt class="py-line"> <tt id="link-1022" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-1022', 'log', 'link-29');">log</a></tt><tt class="py-op">.</tt><tt id="link-1023" class="py-name"><a title="epydoc.log.debug
epydoc.markup.restructuredtext.OptimizedReporter.debug" class="py-name" href="#" onclick="return doclink('link-1023', 'debug', 'link-40');">debug</a></tt><tt class="py-op">(</tt><tt class="py-string">'%r is in %r but name does not dominate'</tt> <tt class="py-op">%</tt> </tt>
<a name="L3256"></a><tt class="py-lineno">3256</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">module</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L3257"></a><tt class="py-lineno">3257</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">module_pysrc_url</tt> </tt>
<a name="L3258"></a><tt class="py-lineno">3258</tt> <tt class="py-line"> <tt class="py-name">mname_len</tt> <tt class="py-op">=</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">module</tt><tt class="py-op">.</tt><tt id="link-1024" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-1024', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L3259"></a><tt class="py-lineno">3259</tt> <tt class="py-line"> <tt class="py-name">anchor</tt> <tt class="py-op">=</tt> <tt class="py-string">'%s'</tt> <tt class="py-op">%</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-1025" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-1025', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">[</tt><tt class="py-name">mname_len</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L3260"></a><tt class="py-lineno">3260</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'%s#%s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">module_pysrc_url</tt><tt class="py-op">,</tt> <tt class="py-name">urllib</tt><tt class="py-op">.</tt><tt class="py-name">quote</tt><tt class="py-op">(</tt><tt class="py-name">anchor</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L3261"></a><tt class="py-lineno">3261</tt> <tt class="py-line"> </tt>
<a name="L3262"></a><tt class="py-lineno">3262</tt> <tt class="py-line"> <tt class="py-comment"># We didn't find it:</tt> </tt>
<a name="L3263"></a><tt class="py-lineno">3263</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
</div><a name="L3264"></a><tt class="py-lineno">3264</tt> <tt class="py-line"> </tt>
<a name="L3265"></a><tt class="py-lineno">3265</tt> <tt class="py-line"> <tt class="py-comment"># [xx] add code to automatically do <code> wrapping or the like?</tt> </tt>
<a name="HTMLWriter.href"></a><div id="HTMLWriter.href-def"><a name="L3266"></a><tt class="py-lineno">3266</tt> <a class="py-toggle" href="#" id="HTMLWriter.href-toggle" onclick="return toggle('HTMLWriter.href');">-</a><tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#href">href</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">target</tt><tt class="py-op">,</tt> <tt class="py-param">label</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">css_class</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">context</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
<a name="L3267"></a><tt class="py-lineno">3267</tt> <tt class="py-line"> <tt class="py-param">tooltip</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.href-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.href-expanded"><a name="L3268"></a><tt class="py-lineno">3268</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L3269"></a><tt class="py-lineno">3269</tt> <tt class="py-line"><tt class="py-docstring"> Return the HTML code for an HREF link to the given target</tt> </tt>
<a name="L3270"></a><tt class="py-lineno">3270</tt> <tt class="py-line"><tt class="py-docstring"> (which can be a C{VariableDoc}, a C{ValueDoc}, or a</tt> </tt>
<a name="L3271"></a><tt class="py-lineno">3271</tt> <tt class="py-line"><tt class="py-docstring"> C{DottedName}.</tt> </tt>
<a name="L3272"></a><tt class="py-lineno">3272</tt> <tt class="py-line"><tt class="py-docstring"> If a C{NamespaceDoc} C{context} is specified, the target label is</tt> </tt>
<a name="L3273"></a><tt class="py-lineno">3273</tt> <tt class="py-line"><tt class="py-docstring"> contextualized to it.</tt> </tt>
<a name="L3274"></a><tt class="py-lineno">3274</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L3275"></a><tt class="py-lineno">3275</tt> <tt class="py-line"> <tt class="py-keyword">assert</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">target</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt id="link-1026" class="py-name" targets="Class epydoc.apidoc.APIDoc=epydoc.apidoc.APIDoc-class.html"><a title="epydoc.apidoc.APIDoc" class="py-name" href="#" onclick="return doclink('link-1026', 'APIDoc', 'link-1026');">APIDoc</a></tt><tt class="py-op">,</tt> <tt id="link-1027" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-1027', 'DottedName', 'link-1002');">DottedName</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L3276"></a><tt class="py-lineno">3276</tt> <tt class="py-line"> </tt>
<a name="L3277"></a><tt class="py-lineno">3277</tt> <tt class="py-line"> <tt class="py-comment"># Pick a label, if none was given.</tt> </tt>
<a name="L3278"></a><tt class="py-lineno">3278</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt id="link-1028" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-1028', 'label', 'link-118');">label</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L3279"></a><tt class="py-lineno">3279</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">target</tt><tt class="py-op">,</tt> <tt id="link-1029" class="py-name"><a title="epydoc.apidoc.VariableDoc" class="py-name" href="#" onclick="return doclink('link-1029', 'VariableDoc', 'link-768');">VariableDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3280"></a><tt class="py-lineno">3280</tt> <tt class="py-line"> <tt id="link-1030" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-1030', 'label', 'link-118');">label</a></tt> <tt class="py-op">=</tt> <tt class="py-name">target</tt><tt class="py-op">.</tt><tt id="link-1031" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-1031', 'name', 'link-117');">name</a></tt> </tt>
<a name="L3281"></a><tt class="py-lineno">3281</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">target</tt><tt class="py-op">,</tt> <tt id="link-1032" class="py-name"><a title="epydoc.apidoc.ValueDoc" class="py-name" href="#" onclick="return doclink('link-1032', 'ValueDoc', 'link-87');">ValueDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L3282"></a><tt class="py-lineno">3282</tt> <tt class="py-line"> <tt class="py-name">target</tt><tt class="py-op">.</tt><tt id="link-1033" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-1033', 'canonical_name', 'link-82');">canonical_name</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-1034" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-1034', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3283"></a><tt class="py-lineno">3283</tt> <tt class="py-line"> <tt id="link-1035" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-1035', 'label', 'link-118');">label</a></tt> <tt class="py-op">=</tt> <tt class="py-name">target</tt><tt class="py-op">.</tt><tt id="link-1036" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-1036', 'canonical_name', 'link-82');">canonical_name</a></tt> </tt>
<a name="L3284"></a><tt class="py-lineno">3284</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">target</tt><tt class="py-op">,</tt> <tt id="link-1037" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-1037', 'DottedName', 'link-1002');">DottedName</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3285"></a><tt class="py-lineno">3285</tt> <tt class="py-line"> <tt id="link-1038" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-1038', 'label', 'link-118');">label</a></tt> <tt class="py-op">=</tt> <tt class="py-name">target</tt> </tt>
<a name="L3286"></a><tt class="py-lineno">3286</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">target</tt><tt class="py-op">,</tt> <tt id="link-1039" class="py-name"><a title="epydoc.apidoc.GenericValueDoc" class="py-name" href="#" onclick="return doclink('link-1039', 'GenericValueDoc', 'link-58');">GenericValueDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3287"></a><tt class="py-lineno">3287</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">"href() should not be called with "</tt> </tt>
<a name="L3288"></a><tt class="py-lineno">3288</tt> <tt class="py-line"> <tt class="py-string">"GenericValueDoc objects (perhaps you "</tt> </tt>
<a name="L3289"></a><tt class="py-lineno">3289</tt> <tt class="py-line"> <tt class="py-string">"meant to use the containing variable?)"</tt><tt class="py-op">)</tt> </tt>
<a name="L3290"></a><tt class="py-lineno">3290</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L3291"></a><tt class="py-lineno">3291</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">"Unable to find a label for %r"</tt> <tt class="py-op">%</tt> <tt class="py-name">target</tt><tt class="py-op">)</tt> </tt>
<a name="L3292"></a><tt class="py-lineno">3292</tt> <tt class="py-line"> </tt>
<a name="L3293"></a><tt class="py-lineno">3293</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">context</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt id="link-1040" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-1040', 'label', 'link-118');">label</a></tt><tt class="py-op">,</tt> <tt id="link-1041" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-1041', 'DottedName', 'link-1002');">DottedName</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3294"></a><tt class="py-lineno">3294</tt> <tt class="py-line"> <tt id="link-1042" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-1042', 'label', 'link-118');">label</a></tt> <tt class="py-op">=</tt> <tt id="link-1043" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-1043', 'label', 'link-118');">label</a></tt><tt class="py-op">.</tt><tt id="link-1044" class="py-name"><a title="epydoc.apidoc.DottedName.contextualize" class="py-name" href="#" onclick="return doclink('link-1044', 'contextualize', 'link-766');">contextualize</a></tt><tt class="py-op">(</tt><tt class="py-name">context</tt><tt class="py-op">.</tt><tt id="link-1045" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-1045', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">.</tt><tt id="link-1046" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-1046', 'container', 'link-63');">container</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L3295"></a><tt class="py-lineno">3295</tt> <tt class="py-line"> </tt>
<a name="L3296"></a><tt class="py-lineno">3296</tt> <tt class="py-line"> <tt id="link-1047" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-1047', 'label', 'link-118');">label</a></tt> <tt class="py-op">=</tt> <tt id="link-1048" class="py-name"><a title="epydoc.util.plaintext_to_html" class="py-name" href="#" onclick="return doclink('link-1048', 'plaintext_to_html', 'link-32');">plaintext_to_html</a></tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt id="link-1049" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-1049', 'label', 'link-118');">label</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L3297"></a><tt class="py-lineno">3297</tt> <tt class="py-line"> </tt>
<a name="L3298"></a><tt class="py-lineno">3298</tt> <tt class="py-line"> <tt class="py-comment"># Munge names for scripts & unreachable values</tt> </tt>
<a name="L3299"></a><tt class="py-lineno">3299</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt id="link-1050" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-1050', 'label', 'link-118');">label</a></tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">'script-'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3300"></a><tt class="py-lineno">3300</tt> <tt class="py-line"> <tt id="link-1051" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-1051', 'label', 'link-118');">label</a></tt> <tt class="py-op">=</tt> <tt id="link-1052" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-1052', 'label', 'link-118');">label</a></tt><tt class="py-op">[</tt><tt class="py-number">7</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> <tt class="py-op">+</tt> <tt class="py-string">' (script)'</tt> </tt>
<a name="L3301"></a><tt class="py-lineno">3301</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-1053" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-1053', 'label', 'link-118');">label</a></tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">'??'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3302"></a><tt class="py-lineno">3302</tt> <tt class="py-line"> <tt id="link-1054" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-1054', 'label', 'link-118');">label</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'<i>unreachable</i>'</tt> <tt class="py-op">+</tt> <tt id="link-1055" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-1055', 'label', 'link-118');">label</a></tt><tt class="py-op">[</tt><tt class="py-number">2</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L3303"></a><tt class="py-lineno">3303</tt> <tt class="py-line"> <tt id="link-1056" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-1056', 'label', 'link-118');">label</a></tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">sub</tt><tt class="py-op">(</tt><tt class="py-string">r'-\d+$'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">,</tt> <tt id="link-1057" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-1057', 'label', 'link-118');">label</a></tt><tt class="py-op">)</tt> </tt>
<a name="L3304"></a><tt class="py-lineno">3304</tt> <tt class="py-line"> </tt>
<a name="L3305"></a><tt class="py-lineno">3305</tt> <tt class="py-line"> <tt class="py-comment"># Get the url for the target.</tt> </tt>
<a name="L3306"></a><tt class="py-lineno">3306</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-1058" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-1058', 'url', 'link-72');">url</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-1059" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-1059', 'url', 'link-72');">url</a></tt><tt class="py-op">(</tt><tt class="py-name">target</tt><tt class="py-op">)</tt> </tt>
<a name="L3307"></a><tt class="py-lineno">3307</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-1060" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-1060', 'url', 'link-72');">url</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L3308"></a><tt class="py-lineno">3308</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">tooltip</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-string">'<span title="%s">%s</span>'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">tooltip</tt><tt class="py-op">,</tt> <tt id="link-1061" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-1061', 'label', 'link-118');">label</a></tt><tt class="py-op">)</tt> </tt>
<a name="L3309"></a><tt class="py-lineno">3309</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt id="link-1062" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-1062', 'label', 'link-118');">label</a></tt> </tt>
<a name="L3310"></a><tt class="py-lineno">3310</tt> <tt class="py-line"> </tt>
<a name="L3311"></a><tt class="py-lineno">3311</tt> <tt class="py-line"> <tt class="py-comment"># Construct a string for the class attribute.</tt> </tt>
<a name="L3312"></a><tt class="py-lineno">3312</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">css_class</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L3313"></a><tt class="py-lineno">3313</tt> <tt class="py-line"> <tt class="py-name">css</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
<a name="L3314"></a><tt class="py-lineno">3314</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L3315"></a><tt class="py-lineno">3315</tt> <tt class="py-line"> <tt class="py-name">css</tt> <tt class="py-op">=</tt> <tt class="py-string">' class="%s"'</tt> <tt class="py-op">%</tt> <tt class="py-name">css_class</tt> </tt>
<a name="L3316"></a><tt class="py-lineno">3316</tt> <tt class="py-line"> </tt>
<a name="L3317"></a><tt class="py-lineno">3317</tt> <tt class="py-line"> <tt class="py-name">onclick</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
<a name="L3318"></a><tt class="py-lineno">3318</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">target</tt><tt class="py-op">,</tt> <tt id="link-1063" class="py-name"><a title="epydoc.apidoc.VariableDoc" class="py-name" href="#" onclick="return doclink('link-1063', 'VariableDoc', 'link-768');">VariableDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt class="py-name">target</tt><tt class="py-op">.</tt><tt id="link-1064" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_public" class="py-name" href="#" onclick="return doclink('link-1064', 'is_public', 'link-578');">is_public</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L3319"></a><tt class="py-lineno">3319</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">target</tt><tt class="py-op">,</tt> <tt id="link-1065" class="py-name"><a title="epydoc.apidoc.ValueDoc" class="py-name" href="#" onclick="return doclink('link-1065', 'ValueDoc', 'link-87');">ValueDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L3320"></a><tt class="py-lineno">3320</tt> <tt class="py-line"> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">target</tt><tt class="py-op">,</tt> <tt id="link-1066" class="py-name"><a title="epydoc.apidoc.GenericValueDoc" class="py-name" href="#" onclick="return doclink('link-1066', 'GenericValueDoc', 'link-58');">GenericValueDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L3321"></a><tt class="py-lineno">3321</tt> <tt class="py-line"> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-1067" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._val_is_public" class="py-name" href="#" onclick="return doclink('link-1067', '_val_is_public', 'link-294');">_val_is_public</a></tt><tt class="py-op">(</tt><tt class="py-name">target</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3322"></a><tt class="py-lineno">3322</tt> <tt class="py-line"> <tt class="py-name">onclick</tt> <tt class="py-op">=</tt> <tt class="py-string">' onclick="show_private();"'</tt> </tt>
<a name="L3323"></a><tt class="py-lineno">3323</tt> <tt class="py-line"> </tt>
<a name="L3324"></a><tt class="py-lineno">3324</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">tooltip</tt><tt class="py-op">:</tt> </tt>
<a name="L3325"></a><tt class="py-lineno">3325</tt> <tt class="py-line"> <tt class="py-name">tooltip</tt> <tt class="py-op">=</tt> <tt class="py-string">' title="%s"'</tt> <tt class="py-op">%</tt> <tt class="py-name">tooltip</tt> </tt>
<a name="L3326"></a><tt class="py-lineno">3326</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L3327"></a><tt class="py-lineno">3327</tt> <tt class="py-line"> <tt class="py-name">tooltip</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
<a name="L3328"></a><tt class="py-lineno">3328</tt> <tt class="py-line"> </tt>
<a name="L3329"></a><tt class="py-lineno">3329</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'<a href="%s"%s%s%s>%s</a>'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt id="link-1068" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-1068', 'url', 'link-72');">url</a></tt><tt class="py-op">,</tt> <tt class="py-name">css</tt><tt class="py-op">,</tt> <tt class="py-name">onclick</tt><tt class="py-op">,</tt> <tt class="py-name">tooltip</tt><tt class="py-op">,</tt> <tt id="link-1069" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-1069', 'label', 'link-118');">label</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L3330"></a><tt class="py-lineno">3330</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter._attr_to_html"></a><div id="HTMLWriter._attr_to_html-def"><a name="L3331"></a><tt class="py-lineno">3331</tt> <a class="py-toggle" href="#" id="HTMLWriter._attr_to_html-toggle" onclick="return toggle('HTMLWriter._attr_to_html');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#_attr_to_html">_attr_to_html</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">attr</tt><tt class="py-op">,</tt> <tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">indent</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter._attr_to_html-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter._attr_to_html-expanded"><a name="L3332"></a><tt class="py-lineno">3332</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">api_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-1070" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-1070', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3333"></a><tt class="py-lineno">3333</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">''</tt> </tt>
<a name="L3334"></a><tt class="py-lineno">3334</tt> <tt class="py-line"> <tt class="py-name">pds</tt> <tt class="py-op">=</tt> <tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">attr</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> <tt class="py-comment"># pds = ParsedDocstring.</tt> </tt>
<a name="L3335"></a><tt class="py-lineno">3335</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">pds</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-1071" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-1071', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3336"></a><tt class="py-lineno">3336</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-1072" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.docstring_to_html" class="py-name" href="#" onclick="return doclink('link-1072', 'docstring_to_html', 'link-383');">docstring_to_html</a></tt><tt class="py-op">(</tt><tt class="py-name">pds</tt><tt class="py-op">,</tt> <tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">)</tt> </tt>
<a name="L3337"></a><tt class="py-lineno">3337</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-1073" class="py-name"><a title="epydoc.apidoc.VariableDoc" class="py-name" href="#" onclick="return doclink('link-1073', 'VariableDoc', 'link-768');">VariableDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3338"></a><tt class="py-lineno">3338</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-1074" class="py-name" targets="Method epydoc.docwriter.html.HTMLWriter._attr_to_html()=epydoc.docwriter.html.HTMLWriter-class.html#_attr_to_html"><a title="epydoc.docwriter.html.HTMLWriter._attr_to_html" class="py-name" href="#" onclick="return doclink('link-1074', '_attr_to_html', 'link-1074');">_attr_to_html</a></tt><tt class="py-op">(</tt><tt class="py-name">attr</tt><tt class="py-op">,</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-1075" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-1075', 'value', 'link-61');">value</a></tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">)</tt> </tt>
</div><a name="L3339"></a><tt class="py-lineno">3339</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.summary"></a><div id="HTMLWriter.summary-def"><a name="L3340"></a><tt class="py-lineno">3340</tt> <a class="py-toggle" href="#" id="HTMLWriter.summary-toggle" onclick="return toggle('HTMLWriter.summary');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#summary">summary</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">indent</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.summary-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.summary-expanded"><a name="L3341"></a><tt class="py-lineno">3341</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-1076" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._attr_to_html" class="py-name" href="#" onclick="return doclink('link-1076', '_attr_to_html', 'link-1074');">_attr_to_html</a></tt><tt class="py-op">(</tt><tt class="py-string">'summary'</tt><tt class="py-op">,</tt> <tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">)</tt> </tt>
</div><a name="L3342"></a><tt class="py-lineno">3342</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.descr"></a><div id="HTMLWriter.descr-def"><a name="L3343"></a><tt class="py-lineno">3343</tt> <a class="py-toggle" href="#" id="HTMLWriter.descr-toggle" onclick="return toggle('HTMLWriter.descr');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#descr">descr</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">indent</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.descr-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.descr-expanded"><a name="L3344"></a><tt class="py-lineno">3344</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-1077" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._attr_to_html" class="py-name" href="#" onclick="return doclink('link-1077', '_attr_to_html', 'link-1074');">_attr_to_html</a></tt><tt class="py-op">(</tt><tt class="py-string">'descr'</tt><tt class="py-op">,</tt> <tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">)</tt> </tt>
</div><a name="L3345"></a><tt class="py-lineno">3345</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.type_descr"></a><div id="HTMLWriter.type_descr-def"><a name="L3346"></a><tt class="py-lineno">3346</tt> <a class="py-toggle" href="#" id="HTMLWriter.type_descr-toggle" onclick="return toggle('HTMLWriter.type_descr');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#type_descr">type_descr</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">indent</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.type_descr-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.type_descr-expanded"><a name="L3347"></a><tt class="py-lineno">3347</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-1078" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._attr_to_html" class="py-name" href="#" onclick="return doclink('link-1078', '_attr_to_html', 'link-1074');">_attr_to_html</a></tt><tt class="py-op">(</tt><tt class="py-string">'type_descr'</tt><tt class="py-op">,</tt> <tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">)</tt> </tt>
</div><a name="L3348"></a><tt class="py-lineno">3348</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.return_type"></a><div id="HTMLWriter.return_type-def"><a name="L3349"></a><tt class="py-lineno">3349</tt> <a class="py-toggle" href="#" id="HTMLWriter.return_type-toggle" onclick="return toggle('HTMLWriter.return_type');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#return_type">return_type</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">indent</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.return_type-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.return_type-expanded"><a name="L3350"></a><tt class="py-lineno">3350</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-1079" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._attr_to_html" class="py-name" href="#" onclick="return doclink('link-1079', '_attr_to_html', 'link-1074');">_attr_to_html</a></tt><tt class="py-op">(</tt><tt class="py-string">'return_type'</tt><tt class="py-op">,</tt> <tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">)</tt> </tt>
</div><a name="L3351"></a><tt class="py-lineno">3351</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.return_descr"></a><div id="HTMLWriter.return_descr-def"><a name="L3352"></a><tt class="py-lineno">3352</tt> <a class="py-toggle" href="#" id="HTMLWriter.return_descr-toggle" onclick="return toggle('HTMLWriter.return_descr');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#return_descr">return_descr</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">indent</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.return_descr-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.return_descr-expanded"><a name="L3353"></a><tt class="py-lineno">3353</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-1080" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._attr_to_html" class="py-name" href="#" onclick="return doclink('link-1080', '_attr_to_html', 'link-1074');">_attr_to_html</a></tt><tt class="py-op">(</tt><tt class="py-string">'return_descr'</tt><tt class="py-op">,</tt> <tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">)</tt> </tt>
</div><a name="L3354"></a><tt class="py-lineno">3354</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.docstring_to_html"></a><div id="HTMLWriter.docstring_to_html-def"><a name="L3355"></a><tt class="py-lineno">3355</tt> <a class="py-toggle" href="#" id="HTMLWriter.docstring_to_html-toggle" onclick="return toggle('HTMLWriter.docstring_to_html');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#docstring_to_html">docstring_to_html</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">parsed_docstring</tt><tt class="py-op">,</tt> <tt class="py-param">where</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">indent</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.docstring_to_html-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.docstring_to_html-expanded"><a name="L3356"></a><tt class="py-lineno">3356</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">parsed_docstring</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-1081" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-1081', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-string">''</tt> </tt>
<a name="L3357"></a><tt class="py-lineno">3357</tt> <tt class="py-line"> <tt class="py-name">linker</tt> <tt class="py-op">=</tt> <tt id="link-1082" class="py-name"><a title="epydoc.docwriter.html._HTMLDocstringLinker" class="py-name" href="#" onclick="return doclink('link-1082', '_HTMLDocstringLinker', 'link-319');">_HTMLDocstringLinker</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">where</tt><tt class="py-op">)</tt> </tt>
<a name="L3358"></a><tt class="py-lineno">3358</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">=</tt> <tt class="py-name">parsed_docstring</tt><tt class="py-op">.</tt><tt id="link-1083" class="py-name"><a title="epydoc.docwriter.dotgraph.DotGraph.to_html
epydoc.markup.ConcatenatedDocstring.to_html
epydoc.markup.ParsedDocstring.to_html
epydoc.markup.epytext.ParsedEpytextDocstring.to_html
epydoc.markup.javadoc.ParsedJavadocDocstring.to_html
epydoc.markup.plaintext.ParsedPlaintextDocstring.to_html
epydoc.markup.restructuredtext.ParsedRstDocstring.to_html" class="py-name" href="#" onclick="return doclink('link-1083', 'to_html', 'link-522');">to_html</a></tt><tt class="py-op">(</tt><tt class="py-name">linker</tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">=</tt><tt class="py-name">indent</tt><tt class="py-op">,</tt> </tt>
<a name="L3359"></a><tt class="py-lineno">3359</tt> <tt class="py-line"> <tt class="py-name">directory</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_directory</tt><tt class="py-op">,</tt> </tt>
<a name="L3360"></a><tt class="py-lineno">3360</tt> <tt class="py-line"> <tt class="py-name">docindex</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">docindex</tt><tt class="py-op">,</tt> </tt>
<a name="L3361"></a><tt class="py-lineno">3361</tt> <tt class="py-line"> <tt class="py-name">context</tt><tt class="py-op">=</tt><tt class="py-name">where</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L3362"></a><tt class="py-lineno">3362</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_mark_docstrings</tt><tt class="py-op">:</tt> </tt>
<a name="L3363"></a><tt class="py-lineno">3363</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">=</tt> <tt class="py-string">'<span class="docstring">%s</span><!--end docstring-->'</tt> <tt class="py-op">%</tt> <tt class="py-name">s</tt> </tt>
<a name="L3364"></a><tt class="py-lineno">3364</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">s</tt> </tt>
</div><a name="L3365"></a><tt class="py-lineno">3365</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter.description"></a><div id="HTMLWriter.description-def"><a name="L3366"></a><tt class="py-lineno">3366</tt> <a class="py-toggle" href="#" id="HTMLWriter.description-toggle" onclick="return toggle('HTMLWriter.description');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#description">description</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">parsed_docstring</tt><tt class="py-op">,</tt> <tt class="py-param">where</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">indent</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.description-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.description-expanded"><a name="L3367"></a><tt class="py-lineno">3367</tt> <tt class="py-line"> <tt class="py-keyword">assert</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">where</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt id="link-1084" class="py-name"><a title="epydoc.apidoc.APIDoc" class="py-name" href="#" onclick="return doclink('link-1084', 'APIDoc', 'link-1026');">APIDoc</a></tt><tt class="py-op">,</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L3368"></a><tt class="py-lineno">3368</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">parsed_docstring</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-1085" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-1085', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-string">''</tt> </tt>
<a name="L3369"></a><tt class="py-lineno">3369</tt> <tt class="py-line"> <tt class="py-name">linker</tt> <tt class="py-op">=</tt> <tt id="link-1086" class="py-name"><a title="epydoc.docwriter.html._HTMLDocstringLinker" class="py-name" href="#" onclick="return doclink('link-1086', '_HTMLDocstringLinker', 'link-319');">_HTMLDocstringLinker</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">where</tt><tt class="py-op">)</tt> </tt>
<a name="L3370"></a><tt class="py-lineno">3370</tt> <tt class="py-line"> <tt id="link-1087" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-1087', 'descr', 'link-228');">descr</a></tt> <tt class="py-op">=</tt> <tt class="py-name">parsed_docstring</tt><tt class="py-op">.</tt><tt id="link-1088" class="py-name"><a title="epydoc.docwriter.dotgraph.DotGraph.to_html
epydoc.markup.ConcatenatedDocstring.to_html
epydoc.markup.ParsedDocstring.to_html
epydoc.markup.epytext.ParsedEpytextDocstring.to_html
epydoc.markup.javadoc.ParsedJavadocDocstring.to_html
epydoc.markup.plaintext.ParsedPlaintextDocstring.to_html
epydoc.markup.restructuredtext.ParsedRstDocstring.to_html" class="py-name" href="#" onclick="return doclink('link-1088', 'to_html', 'link-522');">to_html</a></tt><tt class="py-op">(</tt><tt class="py-name">linker</tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">=</tt><tt class="py-name">indent</tt><tt class="py-op">,</tt> </tt>
<a name="L3371"></a><tt class="py-lineno">3371</tt> <tt class="py-line"> <tt class="py-name">directory</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_directory</tt><tt class="py-op">,</tt> </tt>
<a name="L3372"></a><tt class="py-lineno">3372</tt> <tt class="py-line"> <tt class="py-name">docindex</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">docindex</tt><tt class="py-op">,</tt> </tt>
<a name="L3373"></a><tt class="py-lineno">3373</tt> <tt class="py-line"> <tt class="py-name">context</tt><tt class="py-op">=</tt><tt class="py-name">where</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L3374"></a><tt class="py-lineno">3374</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-1089" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-1089', 'descr', 'link-228');">descr</a></tt> <tt class="py-op">==</tt> <tt class="py-string">''</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-string">'&nbsp;'</tt> </tt>
<a name="L3375"></a><tt class="py-lineno">3375</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-1090" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-1090', 'descr', 'link-228');">descr</a></tt> </tt>
</div><a name="L3376"></a><tt class="py-lineno">3376</tt> <tt class="py-line"> </tt>
<a name="L3377"></a><tt class="py-lineno">3377</tt> <tt class="py-line"> <tt class="py-comment"># [xx] Should this be defined by the APIDoc classes themselves??</tt> </tt>
<a name="HTMLWriter.doc_kind"></a><div id="HTMLWriter.doc_kind-def"><a name="L3378"></a><tt class="py-lineno">3378</tt> <a class="py-toggle" href="#" id="HTMLWriter.doc_kind-toggle" onclick="return toggle('HTMLWriter.doc_kind');">-</a><tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#doc_kind">doc_kind</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter.doc_kind-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter.doc_kind-expanded"><a name="L3379"></a><tt class="py-lineno">3379</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-1091" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-1091', 'ModuleDoc', 'link-55');">ModuleDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-1092" class="py-name"><a title="epydoc.apidoc.ModuleDoc.is_package" class="py-name" href="#" onclick="return doclink('link-1092', 'is_package', 'link-226');">is_package</a></tt> <tt class="py-op">==</tt> <tt class="py-name">True</tt><tt class="py-op">:</tt> </tt>
<a name="L3380"></a><tt class="py-lineno">3380</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'Package'</tt> </tt>
<a name="L3381"></a><tt class="py-lineno">3381</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-1093" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-1093', 'ModuleDoc', 'link-55');">ModuleDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L3382"></a><tt class="py-lineno">3382</tt> <tt class="py-line"> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-1094" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-1094', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">'script'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3383"></a><tt class="py-lineno">3383</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'Script'</tt> </tt>
<a name="L3384"></a><tt class="py-lineno">3384</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-1095" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-1095', 'ModuleDoc', 'link-55');">ModuleDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3385"></a><tt class="py-lineno">3385</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'Module'</tt> </tt>
<a name="L3386"></a><tt class="py-lineno">3386</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-1096" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-1096', 'ClassDoc', 'link-56');">ClassDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3387"></a><tt class="py-lineno">3387</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'Class'</tt> </tt>
<a name="L3388"></a><tt class="py-lineno">3388</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-1097" class="py-name" targets="Class epydoc.apidoc.ClassMethodDoc=epydoc.apidoc.ClassMethodDoc-class.html"><a title="epydoc.apidoc.ClassMethodDoc" class="py-name" href="#" onclick="return doclink('link-1097', 'ClassMethodDoc', 'link-1097');">ClassMethodDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3389"></a><tt class="py-lineno">3389</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'Class Method'</tt> </tt>
<a name="L3390"></a><tt class="py-lineno">3390</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-1098" class="py-name" targets="Class epydoc.apidoc.StaticMethodDoc=epydoc.apidoc.StaticMethodDoc-class.html"><a title="epydoc.apidoc.StaticMethodDoc" class="py-name" href="#" onclick="return doclink('link-1098', 'StaticMethodDoc', 'link-1098');">StaticMethodDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3391"></a><tt class="py-lineno">3391</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'Static Method'</tt> </tt>
<a name="L3392"></a><tt class="py-lineno">3392</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-1099" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-1099', 'RoutineDoc', 'link-57');">RoutineDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3393"></a><tt class="py-lineno">3393</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt id="link-1100" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-1100', 'container', 'link-63');">container</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt id="link-1101" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-1101', 'ClassDoc', 'link-56');">ClassDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3394"></a><tt class="py-lineno">3394</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'Method'</tt> </tt>
<a name="L3395"></a><tt class="py-lineno">3395</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L3396"></a><tt class="py-lineno">3396</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'Function'</tt> </tt>
<a name="L3397"></a><tt class="py-lineno">3397</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L3398"></a><tt class="py-lineno">3398</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'Variable'</tt> </tt>
</div><a name="L3399"></a><tt class="py-lineno">3399</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter._doc_or_ancestor_is_private"></a><div id="HTMLWriter._doc_or_ancestor_is_private-def"><a name="L3400"></a><tt class="py-lineno">3400</tt> <a class="py-toggle" href="#" id="HTMLWriter._doc_or_ancestor_is_private-toggle" onclick="return toggle('HTMLWriter._doc_or_ancestor_is_private');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#_doc_or_ancestor_is_private">_doc_or_ancestor_is_private</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">api_doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter._doc_or_ancestor_is_private-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter._doc_or_ancestor_is_private-expanded"><a name="L3401"></a><tt class="py-lineno">3401</tt> <tt class="py-line"> <tt id="link-1102" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-1102', 'name', 'link-117');">name</a></tt> <tt class="py-op">=</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-1103" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-1103', 'canonical_name', 'link-82');">canonical_name</a></tt> </tt>
<a name="L3402"></a><tt class="py-lineno">3402</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">i</tt> <tt class="py-keyword">in</tt> <tt class="py-name">range</tt><tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-1104" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-1104', 'name', 'link-117');">name</a></tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3403"></a><tt class="py-lineno">3403</tt> <tt class="py-line"> <tt class="py-comment"># Is it (or an ancestor) a private var?</tt> </tt>
<a name="L3404"></a><tt class="py-lineno">3404</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">var_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt id="link-1105" class="py-name" targets="Method epydoc.apidoc.DocIndex.get_vardoc()=epydoc.apidoc.DocIndex-class.html#get_vardoc"><a title="epydoc.apidoc.DocIndex.get_vardoc" class="py-name" href="#" onclick="return doclink('link-1105', 'get_vardoc', 'link-1105');">get_vardoc</a></tt><tt class="py-op">(</tt><tt id="link-1106" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-1106', 'name', 'link-117');">name</a></tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-name">i</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L3405"></a><tt class="py-lineno">3405</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-1107" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_public" class="py-name" href="#" onclick="return doclink('link-1107', 'is_public', 'link-578');">is_public</a></tt> <tt class="py-op">==</tt> <tt class="py-name">False</tt><tt class="py-op">:</tt> </tt>
<a name="L3406"></a><tt class="py-lineno">3406</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L3407"></a><tt class="py-lineno">3407</tt> <tt class="py-line"> <tt class="py-comment"># Is it (or an ancestor) a private module?</tt> </tt>
<a name="L3408"></a><tt class="py-lineno">3408</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">val_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt id="link-1108" class="py-name"><a title="epydoc.apidoc.DocIndex.get_valdoc" class="py-name" href="#" onclick="return doclink('link-1108', 'get_valdoc', 'link-71');">get_valdoc</a></tt><tt class="py-op">(</tt><tt id="link-1109" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-1109', 'name', 'link-117');">name</a></tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-name">i</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L3409"></a><tt class="py-lineno">3409</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">val_doc</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt id="link-1110" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-1110', 'ModuleDoc', 'link-55');">ModuleDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L3410"></a><tt class="py-lineno">3410</tt> <tt class="py-line"> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-1111" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-1111', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">'_'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3411"></a><tt class="py-lineno">3411</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L3412"></a><tt class="py-lineno">3412</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
</div><a name="L3413"></a><tt class="py-lineno">3413</tt> <tt class="py-line"> </tt>
<a name="HTMLWriter._private_subclasses"></a><div id="HTMLWriter._private_subclasses-def"><a name="L3414"></a><tt class="py-lineno">3414</tt> <a class="py-toggle" href="#" id="HTMLWriter._private_subclasses-toggle" onclick="return toggle('HTMLWriter._private_subclasses');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html.HTMLWriter-class.html#_private_subclasses">_private_subclasses</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">class_doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HTMLWriter._private_subclasses-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="HTMLWriter._private_subclasses-expanded"><a name="L3415"></a><tt class="py-lineno">3415</tt> <tt class="py-line"> <tt class="py-docstring">"""Return a list of all subclasses of the given class that are</tt> </tt>
<a name="L3416"></a><tt class="py-lineno">3416</tt> <tt class="py-line"><tt class="py-docstring"> private, as determined by L{_val_is_private}. Recursive</tt> </tt>
<a name="L3417"></a><tt class="py-lineno">3417</tt> <tt class="py-line"><tt class="py-docstring"> subclasses are included in this list."""</tt> </tt>
<a name="L3418"></a><tt class="py-lineno">3418</tt> <tt class="py-line"> <tt class="py-name">queue</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">class_doc</tt><tt class="py-op">]</tt> </tt>
<a name="L3419"></a><tt class="py-lineno">3419</tt> <tt class="py-line"> <tt class="py-name">private</tt> <tt class="py-op">=</tt> <tt class="py-name">set</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L3420"></a><tt class="py-lineno">3420</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">cls</tt> <tt class="py-keyword">in</tt> <tt class="py-name">queue</tt><tt class="py-op">:</tt> </tt>
<a name="L3421"></a><tt class="py-lineno">3421</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">cls</tt><tt class="py-op">,</tt> <tt id="link-1112" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-1112', 'ClassDoc', 'link-56');">ClassDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L3422"></a><tt class="py-lineno">3422</tt> <tt class="py-line"> <tt class="py-name">cls</tt><tt class="py-op">.</tt><tt id="link-1113" class="py-name"><a title="epydoc.apidoc.ClassDoc.subclasses" class="py-name" href="#" onclick="return doclink('link-1113', 'subclasses', 'link-54');">subclasses</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-1114" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-1114', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3423"></a><tt class="py-lineno">3423</tt> <tt class="py-line"> <tt class="py-name">queue</tt><tt class="py-op">.</tt><tt class="py-name">extend</tt><tt class="py-op">(</tt><tt class="py-name">cls</tt><tt class="py-op">.</tt><tt id="link-1115" class="py-name"><a title="epydoc.apidoc.ClassDoc.subclasses" class="py-name" href="#" onclick="return doclink('link-1115', 'subclasses', 'link-54');">subclasses</a></tt><tt class="py-op">)</tt> </tt>
<a name="L3424"></a><tt class="py-lineno">3424</tt> <tt class="py-line"> <tt class="py-name">private</tt><tt class="py-op">.</tt><tt class="py-name">update</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">c</tt> <tt class="py-keyword">for</tt> <tt class="py-name">c</tt> <tt class="py-keyword">in</tt> <tt class="py-name">cls</tt><tt class="py-op">.</tt><tt id="link-1116" class="py-name"><a title="epydoc.apidoc.ClassDoc.subclasses" class="py-name" href="#" onclick="return doclink('link-1116', 'subclasses', 'link-54');">subclasses</a></tt> <tt class="py-keyword">if</tt> </tt>
<a name="L3425"></a><tt class="py-lineno">3425</tt> <tt class="py-line"> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-1117" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._val_is_public" class="py-name" href="#" onclick="return doclink('link-1117', '_val_is_public', 'link-294');">_val_is_public</a></tt><tt class="py-op">(</tt><tt class="py-name">c</tt><tt class="py-op">)</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L3426"></a><tt class="py-lineno">3426</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">private</tt> </tt>
</div></div><a name="L3427"></a><tt class="py-lineno">3427</tt> <tt class="py-line"> </tt>
<a name="_HTMLDocstringLinker"></a><div id="_HTMLDocstringLinker-def"><a name="L3428"></a><tt class="py-lineno">3428</tt> <a class="py-toggle" href="#" id="_HTMLDocstringLinker-toggle" onclick="return toggle('_HTMLDocstringLinker');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.docwriter.html._HTMLDocstringLinker-class.html">_HTMLDocstringLinker</a><tt class="py-op">(</tt><tt class="py-base-class">epydoc</tt><tt class="py-op">.</tt><tt class="py-base-class">markup</tt><tt class="py-op">.</tt><tt class="py-base-class">DocstringLinker</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_HTMLDocstringLinker-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_HTMLDocstringLinker-expanded"><a name="_HTMLDocstringLinker.__init__"></a><div id="_HTMLDocstringLinker.__init__-def"><a name="L3429"></a><tt class="py-lineno">3429</tt> <a class="py-toggle" href="#" id="_HTMLDocstringLinker.__init__-toggle" onclick="return toggle('_HTMLDocstringLinker.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html._HTMLDocstringLinker-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">htmlwriter</tt><tt class="py-op">,</tt> <tt class="py-param">container</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_HTMLDocstringLinker.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="_HTMLDocstringLinker.__init__-expanded"><a name="L3430"></a><tt class="py-lineno">3430</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">htmlwriter</tt> <tt class="py-op">=</tt> <tt class="py-name">htmlwriter</tt> </tt>
<a name="L3431"></a><tt class="py-lineno">3431</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">docindex</tt> <tt class="py-op">=</tt> <tt class="py-name">htmlwriter</tt><tt class="py-op">.</tt><tt class="py-name">docindex</tt> </tt>
<a name="L3432"></a><tt class="py-lineno">3432</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-1118" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-1118', 'container', 'link-63');">container</a></tt> <tt class="py-op">=</tt> <tt id="link-1119" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-1119', 'container', 'link-63');">container</a></tt> </tt>
</div><a name="L3433"></a><tt class="py-lineno">3433</tt> <tt class="py-line"> </tt>
<a name="_HTMLDocstringLinker.translate_indexterm"></a><div id="_HTMLDocstringLinker.translate_indexterm-def"><a name="L3434"></a><tt class="py-lineno">3434</tt> <a class="py-toggle" href="#" id="_HTMLDocstringLinker.translate_indexterm-toggle" onclick="return toggle('_HTMLDocstringLinker.translate_indexterm');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html._HTMLDocstringLinker-class.html#translate_indexterm">translate_indexterm</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">indexterm</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_HTMLDocstringLinker.translate_indexterm-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="_HTMLDocstringLinker.translate_indexterm-expanded"><a name="L3435"></a><tt class="py-lineno">3435</tt> <tt class="py-line"> <tt id="link-1120" class="py-name"><a title="epydoc.cli.key" class="py-name" href="#" onclick="return doclink('link-1120', 'key', 'link-79');">key</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">htmlwriter</tt><tt class="py-op">.</tt><tt id="link-1121" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter._term_index_to_anchor" class="py-name" href="#" onclick="return doclink('link-1121', '_term_index_to_anchor', 'link-915');">_term_index_to_anchor</a></tt><tt class="py-op">(</tt><tt id="link-1122" class="py-name" targets="Method epydoc.docwriter.latex.LatexWriter.indexterm()=epydoc.docwriter.latex.LatexWriter-class.html#indexterm"><a title="epydoc.docwriter.latex.LatexWriter.indexterm" class="py-name" href="#" onclick="return doclink('link-1122', 'indexterm', 'link-1122');">indexterm</a></tt><tt class="py-op">)</tt> </tt>
<a name="L3436"></a><tt class="py-lineno">3436</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-string">'<a name="%s"></a><i class="indexterm">%s</i>'</tt> <tt class="py-op">%</tt> </tt>
<a name="L3437"></a><tt class="py-lineno">3437</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt id="link-1123" class="py-name"><a title="epydoc.cli.key" class="py-name" href="#" onclick="return doclink('link-1123', 'key', 'link-79');">key</a></tt><tt class="py-op">,</tt> <tt id="link-1124" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.indexterm" class="py-name" href="#" onclick="return doclink('link-1124', 'indexterm', 'link-1122');">indexterm</a></tt><tt class="py-op">.</tt><tt id="link-1125" class="py-name"><a title="epydoc.docwriter.dotgraph.DotGraph.to_html
epydoc.markup.ConcatenatedDocstring.to_html
epydoc.markup.ParsedDocstring.to_html
epydoc.markup.epytext.ParsedEpytextDocstring.to_html
epydoc.markup.javadoc.ParsedJavadocDocstring.to_html
epydoc.markup.plaintext.ParsedPlaintextDocstring.to_html
epydoc.markup.restructuredtext.ParsedRstDocstring.to_html" class="py-name" href="#" onclick="return doclink('link-1125', 'to_html', 'link-522');">to_html</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L3438"></a><tt class="py-lineno">3438</tt> <tt class="py-line"> </tt>
<a name="_HTMLDocstringLinker.translate_identifier_xref"></a><div id="_HTMLDocstringLinker.translate_identifier_xref-def"><a name="L3439"></a><tt class="py-lineno">3439</tt> <a class="py-toggle" href="#" id="_HTMLDocstringLinker.translate_identifier_xref-toggle" onclick="return toggle('_HTMLDocstringLinker.translate_identifier_xref');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html._HTMLDocstringLinker-class.html#translate_identifier_xref">translate_identifier_xref</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">identifier</tt><tt class="py-op">,</tt> <tt class="py-param">label</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_HTMLDocstringLinker.translate_identifier_xref-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="_HTMLDocstringLinker.translate_identifier_xref-expanded"><a name="L3440"></a><tt class="py-lineno">3440</tt> <tt class="py-line"> <tt class="py-comment"># Pick a label for this xref.</tt> </tt>
<a name="L3441"></a><tt class="py-lineno">3441</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt id="link-1126" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-1126', 'label', 'link-118');">label</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt id="link-1127" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-1127', 'label', 'link-118');">label</a></tt> <tt class="py-op">=</tt> <tt id="link-1128" class="py-name"><a title="epydoc.util.plaintext_to_html" class="py-name" href="#" onclick="return doclink('link-1128', 'plaintext_to_html', 'link-32');">plaintext_to_html</a></tt><tt class="py-op">(</tt><tt class="py-name">identifier</tt><tt class="py-op">)</tt> </tt>
<a name="L3442"></a><tt class="py-lineno">3442</tt> <tt class="py-line"> </tt>
<a name="L3443"></a><tt class="py-lineno">3443</tt> <tt class="py-line"> <tt class="py-comment"># Find the APIDoc for it (if it's available).</tt> </tt>
<a name="L3444"></a><tt class="py-lineno">3444</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">doc</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt id="link-1129" class="py-name" targets="Method epydoc.apidoc.DocIndex.find()=epydoc.apidoc.DocIndex-class.html#find"><a title="epydoc.apidoc.DocIndex.find" class="py-name" href="#" onclick="return doclink('link-1129', 'find', 'link-1129');">find</a></tt><tt class="py-op">(</tt><tt class="py-name">identifier</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-1130" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-1130', 'container', 'link-63');">container</a></tt><tt class="py-op">)</tt> </tt>
<a name="L3445"></a><tt class="py-lineno">3445</tt> <tt class="py-line"> </tt>
<a name="L3446"></a><tt class="py-lineno">3446</tt> <tt class="py-line"> <tt class="py-comment"># If we didn't find a target, then try checking in the contexts</tt> </tt>
<a name="L3447"></a><tt class="py-lineno">3447</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># of the ancestor classes. </tt> </tt>
<a name="L3448"></a><tt class="py-lineno">3448</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-1131" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-1131', 'container', 'link-63');">container</a></tt><tt class="py-op">,</tt> <tt id="link-1132" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-1132', 'RoutineDoc', 'link-57');">RoutineDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3449"></a><tt class="py-lineno">3449</tt> <tt class="py-line"> <tt id="link-1133" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-1133', 'container', 'link-63');">container</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt id="link-1134" class="py-name"><a title="epydoc.apidoc.DocIndex.get_vardoc" class="py-name" href="#" onclick="return doclink('link-1134', 'get_vardoc', 'link-1105');">get_vardoc</a></tt><tt class="py-op">(</tt> </tt>
<a name="L3450"></a><tt class="py-lineno">3450</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-1135" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-1135', 'container', 'link-63');">container</a></tt><tt class="py-op">.</tt><tt id="link-1136" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-1136', 'canonical_name', 'link-82');">canonical_name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L3451"></a><tt class="py-lineno">3451</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt class="py-op">(</tt><tt class="py-name">doc</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt id="link-1137" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-1137', 'container', 'link-63');">container</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-1138" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-1138', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">)</tt> </tt>
<a name="L3452"></a><tt class="py-lineno">3452</tt> <tt class="py-line"> <tt class="py-keyword">and</tt> <tt id="link-1139" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-1139', 'container', 'link-63');">container</a></tt><tt class="py-op">.</tt><tt id="link-1140" class="py-name" targets="Variable epydoc.apidoc.VariableDoc.overrides=epydoc.apidoc.VariableDoc-class.html#overrides"><a title="epydoc.apidoc.VariableDoc.overrides" class="py-name" href="#" onclick="return doclink('link-1140', 'overrides', 'link-1140');">overrides</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-1141" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-1141', 'UNKNOWN', 'link-229');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3453"></a><tt class="py-lineno">3453</tt> <tt class="py-line"> <tt id="link-1142" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-1142', 'container', 'link-63');">container</a></tt> <tt class="py-op">=</tt> <tt id="link-1143" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-1143', 'container', 'link-63');">container</a></tt><tt class="py-op">.</tt><tt id="link-1144" class="py-name"><a title="epydoc.apidoc.VariableDoc.overrides" class="py-name" href="#" onclick="return doclink('link-1144', 'overrides', 'link-1140');">overrides</a></tt> </tt>
<a name="L3454"></a><tt class="py-lineno">3454</tt> <tt class="py-line"> <tt class="py-name">doc</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt id="link-1145" class="py-name"><a title="epydoc.apidoc.DocIndex.find" class="py-name" href="#" onclick="return doclink('link-1145', 'find', 'link-1129');">find</a></tt><tt class="py-op">(</tt><tt class="py-name">identifier</tt><tt class="py-op">,</tt> <tt id="link-1146" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-1146', 'container', 'link-63');">container</a></tt><tt class="py-op">)</tt> </tt>
<a name="L3455"></a><tt class="py-lineno">3455</tt> <tt class="py-line"> </tt>
<a name="L3456"></a><tt class="py-lineno">3456</tt> <tt class="py-line"> <tt class="py-comment"># Translate it into HTML.</tt> </tt>
<a name="L3457"></a><tt class="py-lineno">3457</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L3458"></a><tt class="py-lineno">3458</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-1147" class="py-name" targets="Method epydoc.docwriter.html._HTMLDocstringLinker._failed_xref()=epydoc.docwriter.html._HTMLDocstringLinker-class.html#_failed_xref"><a title="epydoc.docwriter.html._HTMLDocstringLinker._failed_xref" class="py-name" href="#" onclick="return doclink('link-1147', '_failed_xref', 'link-1147');">_failed_xref</a></tt><tt class="py-op">(</tt><tt class="py-name">identifier</tt><tt class="py-op">)</tt> </tt>
<a name="L3459"></a><tt class="py-lineno">3459</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'<code class="link">%s</code>'</tt> <tt class="py-op">%</tt> <tt id="link-1148" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-1148', 'label', 'link-118');">label</a></tt> </tt>
<a name="L3460"></a><tt class="py-lineno">3460</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L3461"></a><tt class="py-lineno">3461</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">htmlwriter</tt><tt class="py-op">.</tt><tt id="link-1149" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.href" class="py-name" href="#" onclick="return doclink('link-1149', 'href', 'link-254');">href</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-1150" class="py-name"><a title="epydoc.docwriter.latex.LatexWriter.label" class="py-name" href="#" onclick="return doclink('link-1150', 'label', 'link-118');">label</a></tt><tt class="py-op">,</tt> <tt class="py-string">'link'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L3462"></a><tt class="py-lineno">3462</tt> <tt class="py-line"> </tt>
<a name="L3463"></a><tt class="py-lineno">3463</tt> <tt class="py-line"> <tt class="py-comment"># [xx] Should this be added to the DocstringLinker interface???</tt> </tt>
<a name="L3464"></a><tt class="py-lineno">3464</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># Currently, this is *only* used by dotgraph.</tt> </tt>
<a name="_HTMLDocstringLinker.url_for"></a><div id="_HTMLDocstringLinker.url_for-def"><a name="L3465"></a><tt class="py-lineno">3465</tt> <a class="py-toggle" href="#" id="_HTMLDocstringLinker.url_for-toggle" onclick="return toggle('_HTMLDocstringLinker.url_for');">-</a><tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html._HTMLDocstringLinker-class.html#url_for">url_for</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">identifier</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_HTMLDocstringLinker.url_for-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="_HTMLDocstringLinker.url_for-expanded"><a name="L3466"></a><tt class="py-lineno">3466</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">identifier</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">basestring</tt><tt class="py-op">,</tt> <tt id="link-1151" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-1151', 'DottedName', 'link-1002');">DottedName</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3467"></a><tt class="py-lineno">3467</tt> <tt class="py-line"> <tt class="py-name">doc</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt id="link-1152" class="py-name"><a title="epydoc.apidoc.DocIndex.find" class="py-name" href="#" onclick="return doclink('link-1152', 'find', 'link-1129');">find</a></tt><tt class="py-op">(</tt><tt class="py-name">identifier</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-1153" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-1153', 'container', 'link-63');">container</a></tt><tt class="py-op">)</tt> </tt>
<a name="L3468"></a><tt class="py-lineno">3468</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt><tt class="py-op">:</tt> </tt>
<a name="L3469"></a><tt class="py-lineno">3469</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">htmlwriter</tt><tt class="py-op">.</tt><tt id="link-1154" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-1154', 'url', 'link-72');">url</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L3470"></a><tt class="py-lineno">3470</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L3471"></a><tt class="py-lineno">3471</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L3472"></a><tt class="py-lineno">3472</tt> <tt class="py-line"> </tt>
<a name="L3473"></a><tt class="py-lineno">3473</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">identifier</tt><tt class="py-op">,</tt> <tt id="link-1155" class="py-name"><a title="epydoc.apidoc.APIDoc" class="py-name" href="#" onclick="return doclink('link-1155', 'APIDoc', 'link-1026');">APIDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3474"></a><tt class="py-lineno">3474</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">htmlwriter</tt><tt class="py-op">.</tt><tt id="link-1156" class="py-name"><a title="epydoc.docwriter.html.HTMLWriter.url" class="py-name" href="#" onclick="return doclink('link-1156', 'url', 'link-72');">url</a></tt><tt class="py-op">(</tt><tt class="py-name">identifier</tt><tt class="py-op">)</tt> </tt>
<a name="L3475"></a><tt class="py-lineno">3475</tt> <tt class="py-line"> <tt class="py-name">doc</tt> <tt class="py-op">=</tt> <tt class="py-name">identifier</tt> </tt>
<a name="L3476"></a><tt class="py-lineno">3476</tt> <tt class="py-line"> </tt>
<a name="L3477"></a><tt class="py-lineno">3477</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L3478"></a><tt class="py-lineno">3478</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">TypeError</tt><tt class="py-op">(</tt><tt class="py-string">'Expected string or APIDoc'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L3479"></a><tt class="py-lineno">3479</tt> <tt class="py-line"> </tt>
<a name="_HTMLDocstringLinker._failed_xref"></a><div id="_HTMLDocstringLinker._failed_xref-def"><a name="L3480"></a><tt class="py-lineno">3480</tt> <a class="py-toggle" href="#" id="_HTMLDocstringLinker._failed_xref-toggle" onclick="return toggle('_HTMLDocstringLinker._failed_xref');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docwriter.html._HTMLDocstringLinker-class.html#_failed_xref">_failed_xref</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">identifier</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_HTMLDocstringLinker._failed_xref-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="_HTMLDocstringLinker._failed_xref-expanded"><a name="L3481"></a><tt class="py-lineno">3481</tt> <tt class="py-line"> <tt class="py-docstring">"""Add an identifier to the htmlwriter's failed crossreference</tt> </tt>
<a name="L3482"></a><tt class="py-lineno">3482</tt> <tt class="py-line"><tt class="py-docstring"> list."""</tt> </tt>
<a name="L3483"></a><tt class="py-lineno">3483</tt> <tt class="py-line"> <tt class="py-comment"># Don't count it as a failed xref if it's a parameter of the</tt> </tt>
<a name="L3484"></a><tt class="py-lineno">3484</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># current function.</tt> </tt>
<a name="L3485"></a><tt class="py-lineno">3485</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-1157" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-1157', 'container', 'link-63');">container</a></tt><tt class="py-op">,</tt> <tt id="link-1158" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-1158', 'RoutineDoc', 'link-57');">RoutineDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L3486"></a><tt class="py-lineno">3486</tt> <tt class="py-line"> <tt class="py-name">identifier</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-1159" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-1159', 'container', 'link-63');">container</a></tt><tt class="py-op">.</tt><tt id="link-1160" class="py-name" targets="Method epydoc.apidoc.RoutineDoc.all_args()=epydoc.apidoc.RoutineDoc-class.html#all_args"><a title="epydoc.apidoc.RoutineDoc.all_args" class="py-name" href="#" onclick="return doclink('link-1160', 'all_args', 'link-1160');">all_args</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L3487"></a><tt class="py-lineno">3487</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
<a name="L3488"></a><tt class="py-lineno">3488</tt> <tt class="py-line"> </tt>
<a name="L3489"></a><tt class="py-lineno">3489</tt> <tt class="py-line"> <tt class="py-name">failed_xrefs</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">htmlwriter</tt><tt class="py-op">.</tt><tt class="py-name">_failed_xrefs</tt> </tt>
<a name="L3490"></a><tt class="py-lineno">3490</tt> <tt class="py-line"> <tt class="py-name">context</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-1161" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-1161', 'container', 'link-63');">container</a></tt><tt class="py-op">.</tt><tt id="link-1162" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-1162', 'canonical_name', 'link-82');">canonical_name</a></tt> </tt>
<a name="L3491"></a><tt class="py-lineno">3491</tt> <tt class="py-line"> <tt class="py-name">failed_xrefs</tt><tt class="py-op">.</tt><tt class="py-name">setdefault</tt><tt class="py-op">(</tt><tt class="py-name">identifier</tt><tt class="py-op">,</tt><tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-name">context</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
</div></div><a name="L3492"></a><tt class="py-lineno">3492</tt> <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="epydoc-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
<a href="epydoc-log.html">Generated by Epydoc
3.0.1 on Wed Jan 30 14:09:51 2008</a>
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
|
