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
|
<?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.markup.epytext</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.markup-module.html">Package markup</a> ::
Module epytext
</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.markup.epytext-pysrc.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<h1 class="epydoc">Source Code for <a href="epydoc.markup.epytext-module.html">Module epydoc.markup.epytext</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"># epytext.py: epydoc formatted docstring parsing</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 [04/10/01 12:00 AM]</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: epytext.py 1652 2007-09-26 04:45:34Z 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">Parser for epytext strings. Epytext is a lightweight markup whose</tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt> <tt class="py-line"><tt class="py-docstring">primary intended application is Python documentation strings. This</tt> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt> <tt class="py-line"><tt class="py-docstring">parser converts Epytext strings to a simple DOM-like representation</tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt> <tt class="py-line"><tt class="py-docstring">(encoded as a tree of L{Element} objects and strings). Epytext</tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt> <tt class="py-line"><tt class="py-docstring">strings can contain the following X{structural blocks}:</tt> </tt>
<a name="L15"></a><tt class="py-lineno"> 15</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt> <tt class="py-line"><tt class="py-docstring"> - X{epytext}: The top-level element of the DOM tree.</tt> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt> <tt class="py-line"><tt class="py-docstring"> - X{para}: A paragraph of text. Paragraphs contain no newlines, </tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt> <tt class="py-line"><tt class="py-docstring"> and all spaces are soft.</tt> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt> <tt class="py-line"><tt class="py-docstring"> - X{section}: A section or subsection.</tt> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt> <tt class="py-line"><tt class="py-docstring"> - X{field}: A tagged field. These fields provide information</tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt> <tt class="py-line"><tt class="py-docstring"> about specific aspects of a Python object, such as the</tt> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</tt> <tt class="py-line"><tt class="py-docstring"> description of a function's parameter, or the author of a</tt> </tt>
<a name="L23"></a><tt class="py-lineno"> 23</tt> <tt class="py-line"><tt class="py-docstring"> module.</tt> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt> <tt class="py-line"><tt class="py-docstring"> - X{literalblock}: A block of literal text. This text should be</tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt> <tt class="py-line"><tt class="py-docstring"> displayed as it would be displayed in plaintext. The</tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt> <tt class="py-line"><tt class="py-docstring"> parser removes the appropriate amount of leading whitespace </tt> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt> <tt class="py-line"><tt class="py-docstring"> from each line in the literal block.</tt> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt> <tt class="py-line"><tt class="py-docstring"> - X{doctestblock}: A block containing sample python code,</tt> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt> <tt class="py-line"><tt class="py-docstring"> formatted according to the specifications of the C{doctest}</tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt> <tt class="py-line"><tt class="py-docstring"> module.</tt> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt> <tt class="py-line"><tt class="py-docstring"> - X{ulist}: An unordered list.</tt> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt> <tt class="py-line"><tt class="py-docstring"> - X{olist}: An ordered list.</tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt> <tt class="py-line"><tt class="py-docstring"> - X{li}: A list item. This tag is used both for unordered list</tt> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt> <tt class="py-line"><tt class="py-docstring"> items and for ordered list items.</tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt> <tt class="py-line"><tt class="py-docstring">Additionally, the following X{inline regions} may be used within</tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"><tt class="py-docstring">C{para} blocks:</tt> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"><tt class="py-docstring"> - X{code}: Source code and identifiers.</tt> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"><tt class="py-docstring"> - X{math}: Mathematical expressions.</tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"><tt class="py-docstring"> - X{index}: A term which should be included in an index, if one</tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"><tt class="py-docstring"> is generated.</tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"><tt class="py-docstring"> - X{italic}: Italicized text.</tt> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"><tt class="py-docstring"> - X{bold}: Bold-faced text.</tt> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"><tt class="py-docstring"> - X{uri}: A Universal Resource Indicator (URI) or Universal</tt> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"><tt class="py-docstring"> Resource Locator (URL)</tt> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"><tt class="py-docstring"> - X{link}: A Python identifier which should be hyperlinked to</tt> </tt>
<a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"><tt class="py-docstring"> the named object's documentation, when possible.</tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"><tt class="py-docstring">The returned DOM tree will conform to the the following Document Type</tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"><tt class="py-docstring">Description::</tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"><tt class="py-docstring"> <!ENTITY % colorized '(code | math | index | italic |</tt> </tt>
<a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"><tt class="py-docstring"> bold | uri | link | symbol)*'></tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt> <tt class="py-line"><tt class="py-docstring"> <!ELEMENT epytext ((para | literalblock | doctestblock |</tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"><tt class="py-docstring"> section | ulist | olist)*, fieldlist?)></tt> </tt>
<a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"><tt class="py-docstring"> <!ELEMENT para (#PCDATA | %colorized;)*></tt> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"><tt class="py-docstring"> <!ELEMENT section (para | listblock | doctestblock |</tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt> <tt class="py-line"><tt class="py-docstring"> section | ulist | olist)+></tt> </tt>
<a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"><tt class="py-docstring"> <!ELEMENT fieldlist (field+)></tt> </tt>
<a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"><tt class="py-docstring"> <!ELEMENT field (tag, arg?, (para | listblock | doctestblock)</tt> </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"><tt class="py-docstring"> ulist | olist)+)></tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"><tt class="py-docstring"> <!ELEMENT tag (#PCDATA)></tt> </tt>
<a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"><tt class="py-docstring"> <!ELEMENT arg (#PCDATA)></tt> </tt>
<a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"><tt class="py-docstring"> <!ELEMENT literalblock (#PCDATA | %colorized;)*></tt> </tt>
<a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"><tt class="py-docstring"> <!ELEMENT doctestblock (#PCDATA)></tt> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"><tt class="py-docstring"> <!ELEMENT ulist (li+)></tt> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"><tt class="py-docstring"> <!ELEMENT olist (li+)></tt> </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"><tt class="py-docstring"> <!ELEMENT li (para | literalblock | doctestblock | ulist | olist)+></tt> </tt>
<a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"><tt class="py-docstring"> <!ATTLIST li bullet NMTOKEN #IMPLIED></tt> </tt>
<a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"><tt class="py-docstring"> <!ATTLIST olist start NMTOKEN #IMPLIED></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"> <!ELEMENT uri (name, target)></tt> </tt>
<a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"><tt class="py-docstring"> <!ELEMENT link (name, target)></tt> </tt>
<a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"><tt class="py-docstring"> <!ELEMENT name (#PCDATA | %colorized;)*></tt> </tt>
<a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"><tt class="py-docstring"> <!ELEMENT target (#PCDATA)></tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"><tt class="py-docstring"> <!ELEMENT code (#PCDATA | %colorized;)*></tt> </tt>
<a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"><tt class="py-docstring"> <!ELEMENT math (#PCDATA | %colorized;)*></tt> </tt>
<a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"><tt class="py-docstring"> <!ELEMENT italic (#PCDATA | %colorized;)*></tt> </tt>
<a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"><tt class="py-docstring"> <!ELEMENT bold (#PCDATA | %colorized;)*></tt> </tt>
<a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"><tt class="py-docstring"> <!ELEMENT indexed (#PCDATA | %colorized;)></tt> </tt>
<a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"><tt class="py-docstring"> <!ATTLIST code style CDATA #IMPLIED></tt> </tt>
<a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"><tt class="py-docstring"> <!ELEMENT symbol (#PCDATA)></tt> </tt>
<a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"><tt class="py-docstring">@var SYMBOLS: A list of the of escape symbols that are supported</tt> </tt>
<a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"><tt class="py-docstring"> by epydoc. Currently the following symbols are supported:</tt> </tt>
<a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"><tt class="py-docstring"><<<SYMBOLS>>></tt> </tt>
<a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"><tt class="py-comment"># Note: the symbol list is appended to the docstring automatically,</tt> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># below.</tt> </tt>
<a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L100"></a><tt class="py-lineno"> 100</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="L101"></a><tt class="py-lineno"> 101</tt> <tt class="py-line"> </tt>
<a name="L102"></a><tt class="py-lineno"> 102</tt> <tt class="py-line"><tt class="py-comment"># Code organization..</tt> </tt>
<a name="L103"></a><tt class="py-lineno"> 103</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># 1. parse()</tt> </tt>
<a name="L104"></a><tt class="py-lineno"> 104</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># 2. tokenize()</tt> </tt>
<a name="L105"></a><tt class="py-lineno"> 105</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># 3. colorize()</tt> </tt>
<a name="L106"></a><tt class="py-lineno"> 106</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># 4. helpers</tt> </tt>
<a name="L107"></a><tt class="py-lineno"> 107</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># 5. testing</tt> </tt>
<a name="L108"></a><tt class="py-lineno"> 108</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L109"></a><tt class="py-lineno"> 109</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">string</tt><tt class="py-op">,</tt> <tt class="py-name">types</tt><tt class="py-op">,</tt> <tt class="py-name">sys</tt><tt class="py-op">,</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-0" 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-0', 'path', 'link-0');">path</a></tt> </tt>
<a name="L110"></a><tt class="py-lineno"> 110</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-1" class="py-name" targets="Package epydoc=epydoc-module.html"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-1', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-2" 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-2', 'markup', 'link-2');">markup</a></tt> <tt class="py-keyword">import</tt> <tt class="py-op">*</tt> </tt>
<a name="L111"></a><tt class="py-lineno"> 111</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-3" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-3', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-4" 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-4', 'util', 'link-4');">util</a></tt> <tt class="py-keyword">import</tt> <tt id="link-5" class="py-name" targets="Function epydoc.util.wordwrap()=epydoc.util-module.html#wordwrap"><a title="epydoc.util.wordwrap" class="py-name" href="#" onclick="return doclink('link-5', 'wordwrap', 'link-5');">wordwrap</a></tt><tt class="py-op">,</tt> <tt id="link-6" 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-6', 'plaintext_to_html', 'link-6');">plaintext_to_html</a></tt><tt class="py-op">,</tt> <tt id="link-7" class="py-name" targets="Function epydoc.util.plaintext_to_latex()=epydoc.util-module.html#plaintext_to_latex"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-7', 'plaintext_to_latex', 'link-7');">plaintext_to_latex</a></tt> </tt>
<a name="L112"></a><tt class="py-lineno"> 112</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-8" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-8', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-9" 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-9', 'markup', 'link-2');">markup</a></tt><tt class="py-op">.</tt><tt id="link-10" class="py-name" targets="Module epydoc.markup.doctest=epydoc.markup.doctest-module.html"><a title="epydoc.markup.doctest" class="py-name" href="#" onclick="return doclink('link-10', 'doctest', 'link-10');">doctest</a></tt> <tt class="py-keyword">import</tt> <tt id="link-11" class="py-name" targets="Function epydoc.markup.doctest.doctest_to_html()=epydoc.markup.doctest-module.html#doctest_to_html"><a title="epydoc.markup.doctest.doctest_to_html" class="py-name" href="#" onclick="return doclink('link-11', 'doctest_to_html', 'link-11');">doctest_to_html</a></tt><tt class="py-op">,</tt> <tt id="link-12" class="py-name" targets="Function epydoc.markup.doctest.doctest_to_latex()=epydoc.markup.doctest-module.html#doctest_to_latex"><a title="epydoc.markup.doctest.doctest_to_latex" class="py-name" href="#" onclick="return doclink('link-12', 'doctest_to_latex', 'link-12');">doctest_to_latex</a></tt> </tt>
<a name="L113"></a><tt class="py-lineno"> 113</tt> <tt class="py-line"> </tt>
<a name="L114"></a><tt class="py-lineno"> 114</tt> <tt class="py-line"><tt class="py-comment">##################################################</tt> </tt>
<a name="L115"></a><tt class="py-lineno"> 115</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## DOM-Like Encoding</tt> </tt>
<a name="L116"></a><tt class="py-lineno"> 116</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">##################################################</tt> </tt>
<a name="L117"></a><tt class="py-lineno"> 117</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="Element"></a><div id="Element-def"><a name="L118"></a><tt class="py-lineno"> 118</tt> <a class="py-toggle" href="#" id="Element-toggle" onclick="return toggle('Element');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.markup.epytext.Element-class.html">Element</a><tt class="py-op">:</tt> </tt>
</div><div id="Element-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="Element-expanded"><a name="L119"></a><tt class="py-lineno"> 119</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L120"></a><tt class="py-lineno"> 120</tt> <tt class="py-line"><tt class="py-docstring"> A very simple DOM-like representation for parsed epytext</tt> </tt>
<a name="L121"></a><tt class="py-lineno"> 121</tt> <tt class="py-line"><tt class="py-docstring"> documents. Each epytext document is encoded as a tree whose nodes</tt> </tt>
<a name="L122"></a><tt class="py-lineno"> 122</tt> <tt class="py-line"><tt class="py-docstring"> are L{Element} objects, and whose leaves are C{string}s. Each</tt> </tt>
<a name="L123"></a><tt class="py-lineno"> 123</tt> <tt class="py-line"><tt class="py-docstring"> node is marked by a I{tag} and zero or more I{attributes}. Each</tt> </tt>
<a name="L124"></a><tt class="py-lineno"> 124</tt> <tt class="py-line"><tt class="py-docstring"> attribute is a mapping from a string key to a string value.</tt> </tt>
<a name="L125"></a><tt class="py-lineno"> 125</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="Element.__init__"></a><div id="Element.__init__-def"><a name="L126"></a><tt class="py-lineno"> 126</tt> <a class="py-toggle" href="#" id="Element.__init__-toggle" onclick="return toggle('Element.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext.Element-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">tag</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-param">children</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">attribs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Element.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Element.__init__-expanded"><a name="L127"></a><tt class="py-lineno"> 127</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-13" class="py-name" targets="Method epydoc.markup.Field.tag()=epydoc.markup.Field-class.html#tag"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-13', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">=</tt> <tt id="link-14" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-14', 'tag', 'link-13');">tag</a></tt> </tt>
<a name="L128"></a><tt class="py-lineno"> 128</tt> <tt class="py-line"> <tt class="py-string">"""A string tag indicating the type of this element.</tt> </tt>
<a name="L129"></a><tt class="py-lineno"> 129</tt> <tt class="py-line"><tt class="py-string"> @type: C{string}"""</tt> </tt>
<a name="L130"></a><tt class="py-lineno"> 130</tt> <tt class="py-line"> </tt>
<a name="L131"></a><tt class="py-lineno"> 131</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">children</tt> <tt class="py-op">=</tt> <tt class="py-name">list</tt><tt class="py-op">(</tt><tt class="py-name">children</tt><tt class="py-op">)</tt> </tt>
<a name="L132"></a><tt class="py-lineno"> 132</tt> <tt class="py-line"> <tt class="py-string">"""A list of the children of this element.</tt> </tt>
<a name="L133"></a><tt class="py-lineno"> 133</tt> <tt class="py-line"><tt class="py-string"> @type: C{list} of (C{string} or C{Element})"""</tt> </tt>
<a name="L134"></a><tt class="py-lineno"> 134</tt> <tt class="py-line"> </tt>
<a name="L135"></a><tt class="py-lineno"> 135</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">attribs</tt> <tt class="py-op">=</tt> <tt class="py-name">attribs</tt> </tt>
<a name="L136"></a><tt class="py-lineno"> 136</tt> <tt class="py-line"> <tt class="py-string">"""A dictionary mapping attribute names to attribute values</tt> </tt>
<a name="L137"></a><tt class="py-lineno"> 137</tt> <tt class="py-line"><tt class="py-string"> for this element.</tt> </tt>
<a name="L138"></a><tt class="py-lineno"> 138</tt> <tt class="py-line"><tt class="py-string"> @type: C{dict} from C{string} to C{string}"""</tt> </tt>
</div><a name="L139"></a><tt class="py-lineno"> 139</tt> <tt class="py-line"> </tt>
<a name="Element.__str__"></a><div id="Element.__str__-def"><a name="L140"></a><tt class="py-lineno"> 140</tt> <a class="py-toggle" href="#" id="Element.__str__-toggle" onclick="return toggle('Element.__str__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext.Element-class.html#__str__">__str__</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="Element.__str__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Element.__str__-expanded"><a name="L141"></a><tt class="py-lineno"> 141</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L142"></a><tt class="py-lineno"> 142</tt> <tt class="py-line"><tt class="py-docstring"> Return a string representation of this element, using XML</tt> </tt>
<a name="L143"></a><tt class="py-lineno"> 143</tt> <tt class="py-line"><tt class="py-docstring"> notation.</tt> </tt>
<a name="L144"></a><tt class="py-lineno"> 144</tt> <tt class="py-line"><tt class="py-docstring"> @bug: Doesn't escape '<' or '&' or '>'.</tt> </tt>
<a name="L145"></a><tt class="py-lineno"> 145</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L146"></a><tt class="py-lineno"> 146</tt> <tt class="py-line"> <tt class="py-name">attribs</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-string">' %s=%r'</tt> <tt class="py-op">%</tt> <tt class="py-name">t</tt> <tt class="py-keyword">for</tt> <tt class="py-name">t</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">attribs</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 class="py-op">)</tt> </tt>
<a name="L147"></a><tt class="py-lineno"> 147</tt> <tt class="py-line"> <tt class="py-keyword">return</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-15" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-15', 'tag', 'link-13');">tag</a></tt><tt class="py-op">,</tt> <tt class="py-name">attribs</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> </tt>
<a name="L148"></a><tt class="py-lineno"> 148</tt> <tt class="py-line"> <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">str</tt><tt class="py-op">(</tt><tt class="py-name">child</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">child</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">]</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-string">'</%s>'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-16" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-16', 'tag', 'link-13');">tag</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L150"></a><tt class="py-lineno"> 150</tt> <tt class="py-line"> </tt>
<a name="Element.__repr__"></a><div id="Element.__repr__-def"><a name="L151"></a><tt class="py-lineno"> 151</tt> <a class="py-toggle" href="#" id="Element.__repr__-toggle" onclick="return toggle('Element.__repr__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext.Element-class.html#__repr__">__repr__</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="Element.__repr__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Element.__repr__-expanded"><a name="L152"></a><tt class="py-lineno"> 152</tt> <tt class="py-line"> <tt class="py-name">attribs</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-string">', %s=%r'</tt> <tt class="py-op">%</tt> <tt class="py-name">t</tt> <tt class="py-keyword">for</tt> <tt class="py-name">t</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">attribs</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 class="py-op">)</tt> </tt>
<a name="L153"></a><tt class="py-lineno"> 153</tt> <tt class="py-line"> <tt class="py-name">args</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-string">', %r'</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">self</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L154"></a><tt class="py-lineno"> 154</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'Element(%s%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-17" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-17', 'tag', 'link-13');">tag</a></tt><tt class="py-op">,</tt> <tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-name">attribs</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L155"></a><tt class="py-lineno"> 155</tt> <tt class="py-line"> </tt>
<a name="L156"></a><tt class="py-lineno"> 156</tt> <tt class="py-line"><tt class="py-comment">##################################################</tt> </tt>
<a name="L157"></a><tt class="py-lineno"> 157</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## Constants</tt> </tt>
<a name="L158"></a><tt class="py-lineno"> 158</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">##################################################</tt> </tt>
<a name="L159"></a><tt class="py-lineno"> 159</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L160"></a><tt class="py-lineno"> 160</tt> <tt class="py-line"><tt class="py-comment"># The possible heading underline characters, listed in order of</tt> </tt>
<a name="L161"></a><tt class="py-lineno"> 161</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># heading depth. </tt> </tt>
<a name="L162"></a><tt class="py-lineno"> 162</tt> <tt class="py-line"><tt class="py-comment"></tt><tt id="link-18" class="py-name" targets="Variable epydoc.markup.epytext._HEADING_CHARS=epydoc.markup.epytext-module.html#_HEADING_CHARS"><a title="epydoc.markup.epytext._HEADING_CHARS" class="py-name" href="#" onclick="return doclink('link-18', '_HEADING_CHARS', 'link-18');">_HEADING_CHARS</a></tt> <tt class="py-op">=</tt> <tt class="py-string">"=-~"</tt> </tt>
<a name="L163"></a><tt class="py-lineno"> 163</tt> <tt class="py-line"> </tt>
<a name="L164"></a><tt class="py-lineno"> 164</tt> <tt class="py-line"><tt class="py-comment"># Escape codes. These should be needed very rarely.</tt> </tt>
<a name="L165"></a><tt class="py-lineno"> 165</tt> <tt class="py-line"><tt class="py-comment"></tt><tt id="link-19" class="py-name" targets="Variable epydoc.markup.epytext._ESCAPES=epydoc.markup.epytext-module.html#_ESCAPES"><a title="epydoc.markup.epytext._ESCAPES" class="py-name" href="#" onclick="return doclink('link-19', '_ESCAPES', 'link-19');">_ESCAPES</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-string">'lb'</tt><tt class="py-op">:</tt><tt class="py-string">'{'</tt><tt class="py-op">,</tt> <tt class="py-string">'rb'</tt><tt class="py-op">:</tt> <tt class="py-string">'}'</tt><tt class="py-op">}</tt> </tt>
<a name="L166"></a><tt class="py-lineno"> 166</tt> <tt class="py-line"> </tt>
<a name="L167"></a><tt class="py-lineno"> 167</tt> <tt class="py-line"><tt class="py-comment"># Symbols. These can be generated via S{...} escapes.</tt> </tt>
<a name="L168"></a><tt class="py-lineno"> 168</tt> <tt class="py-line"><tt class="py-comment"></tt><tt id="link-20" class="py-name" targets="Variable epydoc.markup.epytext.SYMBOLS=epydoc.markup.epytext-module.html#SYMBOLS"><a title="epydoc.markup.epytext.SYMBOLS" class="py-name" href="#" onclick="return doclink('link-20', 'SYMBOLS', 'link-20');">SYMBOLS</a></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-comment"># Arrows</tt> </tt>
<a name="L170"></a><tt class="py-lineno"> 170</tt> <tt class="py-line"> <tt class="py-string">'<-'</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">'v'</tt><tt class="py-op">,</tt> </tt>
<a name="L171"></a><tt class="py-lineno"> 171</tt> <tt class="py-line"> </tt>
<a name="L172"></a><tt class="py-lineno"> 172</tt> <tt class="py-line"> <tt class="py-comment"># Greek letters</tt> </tt>
<a name="L173"></a><tt class="py-lineno"> 173</tt> <tt class="py-line"> <tt class="py-string">'alpha'</tt><tt class="py-op">,</tt> <tt class="py-string">'beta'</tt><tt class="py-op">,</tt> <tt class="py-string">'gamma'</tt><tt class="py-op">,</tt> <tt class="py-string">'delta'</tt><tt class="py-op">,</tt> <tt class="py-string">'epsilon'</tt><tt class="py-op">,</tt> <tt class="py-string">'zeta'</tt><tt class="py-op">,</tt> </tt>
<a name="L174"></a><tt class="py-lineno"> 174</tt> <tt class="py-line"> <tt class="py-string">'eta'</tt><tt class="py-op">,</tt> <tt class="py-string">'theta'</tt><tt class="py-op">,</tt> <tt class="py-string">'iota'</tt><tt class="py-op">,</tt> <tt class="py-string">'kappa'</tt><tt class="py-op">,</tt> <tt class="py-string">'lambda'</tt><tt class="py-op">,</tt> <tt class="py-string">'mu'</tt><tt class="py-op">,</tt> </tt>
<a name="L175"></a><tt class="py-lineno"> 175</tt> <tt class="py-line"> <tt class="py-string">'nu'</tt><tt class="py-op">,</tt> <tt class="py-string">'xi'</tt><tt class="py-op">,</tt> <tt class="py-string">'omicron'</tt><tt class="py-op">,</tt> <tt class="py-string">'pi'</tt><tt class="py-op">,</tt> <tt class="py-string">'rho'</tt><tt class="py-op">,</tt> <tt class="py-string">'sigma'</tt><tt class="py-op">,</tt> </tt>
<a name="L176"></a><tt class="py-lineno"> 176</tt> <tt class="py-line"> <tt class="py-string">'tau'</tt><tt class="py-op">,</tt> <tt class="py-string">'upsilon'</tt><tt class="py-op">,</tt> <tt class="py-string">'phi'</tt><tt class="py-op">,</tt> <tt class="py-string">'chi'</tt><tt class="py-op">,</tt> <tt class="py-string">'psi'</tt><tt class="py-op">,</tt> <tt class="py-string">'omega'</tt><tt class="py-op">,</tt> </tt>
<a name="L177"></a><tt class="py-lineno"> 177</tt> <tt class="py-line"> <tt class="py-string">'Alpha'</tt><tt class="py-op">,</tt> <tt class="py-string">'Beta'</tt><tt class="py-op">,</tt> <tt class="py-string">'Gamma'</tt><tt class="py-op">,</tt> <tt class="py-string">'Delta'</tt><tt class="py-op">,</tt> <tt class="py-string">'Epsilon'</tt><tt class="py-op">,</tt> <tt class="py-string">'Zeta'</tt><tt class="py-op">,</tt> </tt>
<a name="L178"></a><tt class="py-lineno"> 178</tt> <tt class="py-line"> <tt class="py-string">'Eta'</tt><tt class="py-op">,</tt> <tt class="py-string">'Theta'</tt><tt class="py-op">,</tt> <tt class="py-string">'Iota'</tt><tt class="py-op">,</tt> <tt class="py-string">'Kappa'</tt><tt class="py-op">,</tt> <tt class="py-string">'Lambda'</tt><tt class="py-op">,</tt> <tt class="py-string">'Mu'</tt><tt class="py-op">,</tt> </tt>
<a name="L179"></a><tt class="py-lineno"> 179</tt> <tt class="py-line"> <tt class="py-string">'Nu'</tt><tt class="py-op">,</tt> <tt class="py-string">'Xi'</tt><tt class="py-op">,</tt> <tt class="py-string">'Omicron'</tt><tt class="py-op">,</tt> <tt class="py-string">'Pi'</tt><tt class="py-op">,</tt> <tt class="py-string">'Rho'</tt><tt class="py-op">,</tt> <tt class="py-string">'Sigma'</tt><tt class="py-op">,</tt> </tt>
<a name="L180"></a><tt class="py-lineno"> 180</tt> <tt class="py-line"> <tt class="py-string">'Tau'</tt><tt class="py-op">,</tt> <tt class="py-string">'Upsilon'</tt><tt class="py-op">,</tt> <tt class="py-string">'Phi'</tt><tt class="py-op">,</tt> <tt class="py-string">'Chi'</tt><tt class="py-op">,</tt> <tt class="py-string">'Psi'</tt><tt class="py-op">,</tt> <tt class="py-string">'Omega'</tt><tt class="py-op">,</tt> </tt>
<a name="L181"></a><tt class="py-lineno"> 181</tt> <tt class="py-line"> </tt>
<a name="L182"></a><tt class="py-lineno"> 182</tt> <tt class="py-line"> <tt class="py-comment"># HTML character entities</tt> </tt>
<a name="L183"></a><tt class="py-lineno"> 183</tt> <tt class="py-line"> <tt class="py-string">'larr'</tt><tt class="py-op">,</tt> <tt class="py-string">'rarr'</tt><tt class="py-op">,</tt> <tt class="py-string">'uarr'</tt><tt class="py-op">,</tt> <tt class="py-string">'darr'</tt><tt class="py-op">,</tt> <tt class="py-string">'harr'</tt><tt class="py-op">,</tt> <tt class="py-string">'crarr'</tt><tt class="py-op">,</tt> </tt>
<a name="L184"></a><tt class="py-lineno"> 184</tt> <tt class="py-line"> <tt class="py-string">'lArr'</tt><tt class="py-op">,</tt> <tt class="py-string">'rArr'</tt><tt class="py-op">,</tt> <tt class="py-string">'uArr'</tt><tt class="py-op">,</tt> <tt class="py-string">'dArr'</tt><tt class="py-op">,</tt> <tt class="py-string">'hArr'</tt><tt class="py-op">,</tt> </tt>
<a name="L185"></a><tt class="py-lineno"> 185</tt> <tt class="py-line"> <tt class="py-string">'copy'</tt><tt class="py-op">,</tt> <tt class="py-string">'times'</tt><tt class="py-op">,</tt> <tt class="py-string">'forall'</tt><tt class="py-op">,</tt> <tt class="py-string">'exist'</tt><tt class="py-op">,</tt> <tt class="py-string">'part'</tt><tt class="py-op">,</tt> </tt>
<a name="L186"></a><tt class="py-lineno"> 186</tt> <tt class="py-line"> <tt class="py-string">'empty'</tt><tt class="py-op">,</tt> <tt class="py-string">'isin'</tt><tt class="py-op">,</tt> <tt class="py-string">'notin'</tt><tt class="py-op">,</tt> <tt class="py-string">'ni'</tt><tt class="py-op">,</tt> <tt class="py-string">'prod'</tt><tt class="py-op">,</tt> <tt class="py-string">'sum'</tt><tt class="py-op">,</tt> </tt>
<a name="L187"></a><tt class="py-lineno"> 187</tt> <tt class="py-line"> <tt class="py-string">'prop'</tt><tt class="py-op">,</tt> <tt class="py-string">'infin'</tt><tt class="py-op">,</tt> <tt class="py-string">'ang'</tt><tt class="py-op">,</tt> <tt class="py-string">'and'</tt><tt class="py-op">,</tt> <tt class="py-string">'or'</tt><tt class="py-op">,</tt> <tt class="py-string">'cap'</tt><tt class="py-op">,</tt> <tt class="py-string">'cup'</tt><tt class="py-op">,</tt> </tt>
<a name="L188"></a><tt class="py-lineno"> 188</tt> <tt class="py-line"> <tt class="py-string">'int'</tt><tt class="py-op">,</tt> <tt class="py-string">'there4'</tt><tt class="py-op">,</tt> <tt class="py-string">'sim'</tt><tt class="py-op">,</tt> <tt class="py-string">'cong'</tt><tt class="py-op">,</tt> <tt class="py-string">'asymp'</tt><tt class="py-op">,</tt> <tt class="py-string">'ne'</tt><tt class="py-op">,</tt> </tt>
<a name="L189"></a><tt class="py-lineno"> 189</tt> <tt class="py-line"> <tt class="py-string">'equiv'</tt><tt class="py-op">,</tt> <tt class="py-string">'le'</tt><tt class="py-op">,</tt> <tt class="py-string">'ge'</tt><tt class="py-op">,</tt> <tt class="py-string">'sub'</tt><tt class="py-op">,</tt> <tt class="py-string">'sup'</tt><tt class="py-op">,</tt> <tt class="py-string">'nsub'</tt><tt class="py-op">,</tt> </tt>
<a name="L190"></a><tt class="py-lineno"> 190</tt> <tt class="py-line"> <tt class="py-string">'sube'</tt><tt class="py-op">,</tt> <tt class="py-string">'supe'</tt><tt class="py-op">,</tt> <tt class="py-string">'oplus'</tt><tt class="py-op">,</tt> <tt class="py-string">'otimes'</tt><tt class="py-op">,</tt> <tt class="py-string">'perp'</tt><tt class="py-op">,</tt> </tt>
<a name="L191"></a><tt class="py-lineno"> 191</tt> <tt class="py-line"> </tt>
<a name="L192"></a><tt class="py-lineno"> 192</tt> <tt class="py-line"> <tt class="py-comment"># Alternate (long) names</tt> </tt>
<a name="L193"></a><tt class="py-lineno"> 193</tt> <tt class="py-line"> <tt class="py-string">'infinity'</tt><tt class="py-op">,</tt> <tt class="py-string">'integral'</tt><tt class="py-op">,</tt> <tt class="py-string">'product'</tt><tt class="py-op">,</tt> </tt>
<a name="L194"></a><tt class="py-lineno"> 194</tt> <tt class="py-line"> <tt class="py-string">'>='</tt><tt class="py-op">,</tt> <tt class="py-string">'<='</tt><tt class="py-op">,</tt> </tt>
<a name="L195"></a><tt class="py-lineno"> 195</tt> <tt class="py-line"> <tt class="py-op">]</tt> </tt>
<a name="L196"></a><tt class="py-lineno"> 196</tt> <tt class="py-line"><tt class="py-comment"># Convert to a dictionary, for quick lookup</tt> </tt>
<a name="L197"></a><tt class="py-lineno"> 197</tt> <tt class="py-line"><tt class="py-comment"></tt><tt id="link-21" class="py-name" targets="Variable epydoc.markup.epytext._SYMBOLS=epydoc.markup.epytext-module.html#_SYMBOLS"><a title="epydoc.markup.epytext._SYMBOLS" class="py-name" href="#" onclick="return doclink('link-21', '_SYMBOLS', 'link-21');">_SYMBOLS</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L198"></a><tt class="py-lineno"> 198</tt> <tt class="py-line"><tt class="py-keyword">for</tt> <tt class="py-name">symbol</tt> <tt class="py-keyword">in</tt> <tt id="link-22" class="py-name"><a title="epydoc.markup.epytext.SYMBOLS" class="py-name" href="#" onclick="return doclink('link-22', 'SYMBOLS', 'link-20');">SYMBOLS</a></tt><tt class="py-op">:</tt> <tt id="link-23" class="py-name"><a title="epydoc.markup.epytext._SYMBOLS" class="py-name" href="#" onclick="return doclink('link-23', '_SYMBOLS', 'link-21');">_SYMBOLS</a></tt><tt class="py-op">[</tt><tt class="py-name">symbol</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
<a name="L199"></a><tt class="py-lineno"> 199</tt> <tt class="py-line"> </tt>
<a name="L200"></a><tt class="py-lineno"> 200</tt> <tt class="py-line"><tt class="py-comment"># Add symbols to the docstring.</tt> </tt>
<a name="L201"></a><tt class="py-lineno"> 201</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-name">symblist</tt> <tt class="py-op">=</tt> <tt class="py-string">' '</tt> </tt>
<a name="L202"></a><tt class="py-lineno"> 202</tt> <tt class="py-line"><tt class="py-name">symblist</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">' - C{E{S}{%s}}=S{%s}'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">symbol</tt><tt class="py-op">,</tt> <tt class="py-name">symbol</tt><tt class="py-op">)</tt> </tt>
<a name="L203"></a><tt class="py-lineno"> 203</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">symbol</tt> <tt class="py-keyword">in</tt> <tt id="link-24" class="py-name"><a title="epydoc.markup.epytext.SYMBOLS" class="py-name" href="#" onclick="return doclink('link-24', 'SYMBOLS', 'link-20');">SYMBOLS</a></tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L204"></a><tt class="py-lineno"> 204</tt> <tt class="py-line"><tt id="link-25" 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-25', '__doc__', 'link-25');">__doc__</a></tt> <tt class="py-op">=</tt> <tt id="link-26" class="py-name"><a title="epydoc.markup.epytext.__doc__" class="py-name" href="#" onclick="return doclink('link-26', '__doc__', 'link-25');">__doc__</a></tt><tt class="py-op">.</tt><tt class="py-name">replace</tt><tt class="py-op">(</tt><tt class="py-string">'<<<SYMBOLS>>>'</tt><tt class="py-op">,</tt> <tt class="py-name">symblist</tt><tt class="py-op">)</tt> </tt>
<a name="L205"></a><tt class="py-lineno"> 205</tt> <tt class="py-line"><tt class="py-keyword">del</tt> <tt class="py-name">symbol</tt><tt class="py-op">,</tt> <tt class="py-name">symblist</tt> </tt>
<a name="L206"></a><tt class="py-lineno"> 206</tt> <tt class="py-line"> </tt>
<a name="L207"></a><tt class="py-lineno"> 207</tt> <tt class="py-line"><tt class="py-comment"># Tags for colorizing text.</tt> </tt>
<a name="L208"></a><tt class="py-lineno"> 208</tt> <tt class="py-line"><tt class="py-comment"></tt><tt id="link-27" class="py-name" targets="Variable epydoc.markup.epytext._COLORIZING_TAGS=epydoc.markup.epytext-module.html#_COLORIZING_TAGS"><a title="epydoc.markup.epytext._COLORIZING_TAGS" class="py-name" href="#" onclick="return doclink('link-27', '_COLORIZING_TAGS', 'link-27');">_COLORIZING_TAGS</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
<a name="L209"></a><tt class="py-lineno"> 209</tt> <tt class="py-line"> <tt class="py-string">'C'</tt><tt class="py-op">:</tt> <tt class="py-string">'code'</tt><tt class="py-op">,</tt> </tt>
<a name="L210"></a><tt class="py-lineno"> 210</tt> <tt class="py-line"> <tt class="py-string">'M'</tt><tt class="py-op">:</tt> <tt class="py-string">'math'</tt><tt class="py-op">,</tt> </tt>
<a name="L211"></a><tt class="py-lineno"> 211</tt> <tt class="py-line"> <tt class="py-string">'X'</tt><tt class="py-op">:</tt> <tt class="py-string">'indexed'</tt><tt class="py-op">,</tt> </tt>
<a name="L212"></a><tt class="py-lineno"> 212</tt> <tt class="py-line"> <tt class="py-string">'I'</tt><tt class="py-op">:</tt> <tt class="py-string">'italic'</tt><tt class="py-op">,</tt> </tt>
<a name="L213"></a><tt class="py-lineno"> 213</tt> <tt class="py-line"> <tt class="py-string">'B'</tt><tt class="py-op">:</tt> <tt class="py-string">'bold'</tt><tt class="py-op">,</tt> </tt>
<a name="L214"></a><tt class="py-lineno"> 214</tt> <tt class="py-line"> <tt class="py-string">'U'</tt><tt class="py-op">:</tt> <tt class="py-string">'uri'</tt><tt class="py-op">,</tt> </tt>
<a name="L215"></a><tt class="py-lineno"> 215</tt> <tt class="py-line"> <tt class="py-string">'L'</tt><tt class="py-op">:</tt> <tt class="py-string">'link'</tt><tt class="py-op">,</tt> <tt class="py-comment"># A Python identifier that should be linked to </tt> </tt>
<a name="L216"></a><tt class="py-lineno"> 216</tt> <tt class="py-line"> <tt class="py-string">'E'</tt><tt class="py-op">:</tt> <tt class="py-string">'escape'</tt><tt class="py-op">,</tt> <tt class="py-comment"># escapes characters or creates symbols</tt> </tt>
<a name="L217"></a><tt class="py-lineno"> 217</tt> <tt class="py-line"> <tt class="py-string">'S'</tt><tt class="py-op">:</tt> <tt class="py-string">'symbol'</tt><tt class="py-op">,</tt> </tt>
<a name="L218"></a><tt class="py-lineno"> 218</tt> <tt class="py-line"> <tt class="py-string">'G'</tt><tt class="py-op">:</tt> <tt class="py-string">'graph'</tt><tt class="py-op">,</tt> </tt>
<a name="L219"></a><tt class="py-lineno"> 219</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt>
<a name="L220"></a><tt class="py-lineno"> 220</tt> <tt class="py-line"> </tt>
<a name="L221"></a><tt class="py-lineno"> 221</tt> <tt class="py-line"><tt class="py-comment"># Which tags can use "link syntax" (e.g., U{Python<www.python.org>})?</tt> </tt>
<a name="L222"></a><tt class="py-lineno"> 222</tt> <tt class="py-line"><tt class="py-comment"></tt><tt id="link-28" class="py-name" targets="Variable epydoc.markup.epytext._LINK_COLORIZING_TAGS=epydoc.markup.epytext-module.html#_LINK_COLORIZING_TAGS"><a title="epydoc.markup.epytext._LINK_COLORIZING_TAGS" class="py-name" href="#" onclick="return doclink('link-28', '_LINK_COLORIZING_TAGS', 'link-28');">_LINK_COLORIZING_TAGS</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">'link'</tt><tt class="py-op">,</tt> <tt class="py-string">'uri'</tt><tt class="py-op">]</tt> </tt>
<a name="L223"></a><tt class="py-lineno"> 223</tt> <tt class="py-line"> </tt>
<a name="L224"></a><tt class="py-lineno"> 224</tt> <tt class="py-line"><tt class="py-comment">##################################################</tt> </tt>
<a name="L225"></a><tt class="py-lineno"> 225</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## Structuring (Top Level)</tt> </tt>
<a name="L226"></a><tt class="py-lineno"> 226</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">##################################################</tt> </tt>
<a name="L227"></a><tt class="py-lineno"> 227</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="parse"></a><div id="parse-def"><a name="L228"></a><tt class="py-lineno"> 228</tt> <a class="py-toggle" href="#" id="parse-toggle" onclick="return toggle('parse');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext-module.html#parse">parse</a><tt class="py-op">(</tt><tt class="py-param">str</tt><tt class="py-op">,</tt> <tt class="py-param">errors</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="parse-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="parse-expanded"><a name="L229"></a><tt class="py-lineno"> 229</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L230"></a><tt class="py-lineno"> 230</tt> <tt class="py-line"><tt class="py-docstring"> Return a DOM tree encoding the contents of an epytext string. Any</tt> </tt>
<a name="L231"></a><tt class="py-lineno"> 231</tt> <tt class="py-line"><tt class="py-docstring"> errors generated during parsing will be stored in C{errors}.</tt> </tt>
<a name="L232"></a><tt class="py-lineno"> 232</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L233"></a><tt class="py-lineno"> 233</tt> <tt class="py-line"><tt class="py-docstring"> @param str: The epytext string to parse.</tt> </tt>
<a name="L234"></a><tt class="py-lineno"> 234</tt> <tt class="py-line"><tt class="py-docstring"> @type str: C{string}</tt> </tt>
<a name="L235"></a><tt class="py-lineno"> 235</tt> <tt class="py-line"><tt class="py-docstring"> @param errors: A list where any errors generated during parsing</tt> </tt>
<a name="L236"></a><tt class="py-lineno"> 236</tt> <tt class="py-line"><tt class="py-docstring"> will be stored. If no list is specified, then fatal errors</tt> </tt>
<a name="L237"></a><tt class="py-lineno"> 237</tt> <tt class="py-line"><tt class="py-docstring"> will generate exceptions, and non-fatal errors will be</tt> </tt>
<a name="L238"></a><tt class="py-lineno"> 238</tt> <tt class="py-line"><tt class="py-docstring"> ignored.</tt> </tt>
<a name="L239"></a><tt class="py-lineno"> 239</tt> <tt class="py-line"><tt class="py-docstring"> @type errors: C{list} of L{ParseError}</tt> </tt>
<a name="L240"></a><tt class="py-lineno"> 240</tt> <tt class="py-line"><tt class="py-docstring"> @return: a DOM tree encoding the contents of an epytext string.</tt> </tt>
<a name="L241"></a><tt class="py-lineno"> 241</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{Element}</tt> </tt>
<a name="L242"></a><tt class="py-lineno"> 242</tt> <tt class="py-line"><tt class="py-docstring"> @raise ParseError: If C{errors} is C{None} and an error is</tt> </tt>
<a name="L243"></a><tt class="py-lineno"> 243</tt> <tt class="py-line"><tt class="py-docstring"> encountered while parsing.</tt> </tt>
<a name="L244"></a><tt class="py-lineno"> 244</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L245"></a><tt class="py-lineno"> 245</tt> <tt class="py-line"> <tt class="py-comment"># Initialize errors list.</tt> </tt>
<a name="L246"></a><tt class="py-lineno"> 246</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">errors</tt> <tt class="py-op">==</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L247"></a><tt class="py-lineno"> 247</tt> <tt class="py-line"> <tt class="py-name">errors</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L248"></a><tt class="py-lineno"> 248</tt> <tt class="py-line"> <tt class="py-name">raise_on_error</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
<a name="L249"></a><tt class="py-lineno"> 249</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L250"></a><tt class="py-lineno"> 250</tt> <tt class="py-line"> <tt class="py-name">raise_on_error</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L251"></a><tt class="py-lineno"> 251</tt> <tt class="py-line"> </tt>
<a name="L252"></a><tt class="py-lineno"> 252</tt> <tt class="py-line"> <tt class="py-comment"># Preprocess the string.</tt> </tt>
<a name="L253"></a><tt class="py-lineno"> 253</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">str</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">'\015\012'</tt><tt class="py-op">,</tt> <tt class="py-string">'\012'</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
<a name="L254"></a><tt class="py-lineno"> 254</tt> <tt class="py-line"> <tt class="py-name">str</tt> <tt class="py-op">=</tt> <tt class="py-name">string</tt><tt class="py-op">.</tt><tt class="py-name">expandtabs</tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
<a name="L255"></a><tt class="py-lineno"> 255</tt> <tt class="py-line"> </tt>
<a name="L256"></a><tt class="py-lineno"> 256</tt> <tt class="py-line"> <tt class="py-comment"># Tokenize the input string.</tt> </tt>
<a name="L257"></a><tt class="py-lineno"> 257</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">tokens</tt> <tt class="py-op">=</tt> <tt id="link-29" class="py-name" targets="Function epydoc.markup.epytext._tokenize()=epydoc.markup.epytext-module.html#_tokenize"><a title="epydoc.markup.epytext._tokenize" class="py-name" href="#" onclick="return doclink('link-29', '_tokenize', 'link-29');">_tokenize</a></tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">,</tt> <tt class="py-name">errors</tt><tt class="py-op">)</tt> </tt>
<a name="L258"></a><tt class="py-lineno"> 258</tt> <tt class="py-line"> </tt>
<a name="L259"></a><tt class="py-lineno"> 259</tt> <tt class="py-line"> <tt class="py-comment"># Have we encountered a field yet?</tt> </tt>
<a name="L260"></a><tt class="py-lineno"> 260</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">encountered_field</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L261"></a><tt class="py-lineno"> 261</tt> <tt class="py-line"> </tt>
<a name="L262"></a><tt class="py-lineno"> 262</tt> <tt class="py-line"> <tt class="py-comment"># Create an document to hold the epytext.</tt> </tt>
<a name="L263"></a><tt class="py-lineno"> 263</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">doc</tt> <tt class="py-op">=</tt> <tt id="link-30" class="py-name" targets="Class epydoc.markup.epytext.Element=epydoc.markup.epytext.Element-class.html"><a title="epydoc.markup.epytext.Element" class="py-name" href="#" onclick="return doclink('link-30', 'Element', 'link-30');">Element</a></tt><tt class="py-op">(</tt><tt class="py-string">'epytext'</tt><tt class="py-op">)</tt> </tt>
<a name="L264"></a><tt class="py-lineno"> 264</tt> <tt class="py-line"> </tt>
<a name="L265"></a><tt class="py-lineno"> 265</tt> <tt class="py-line"> <tt class="py-comment"># Maintain two parallel stacks: one contains DOM elements, and</tt> </tt>
<a name="L266"></a><tt class="py-lineno"> 266</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># gives the ancestors of the current block. The other contains</tt> </tt>
<a name="L267"></a><tt class="py-lineno"> 267</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># indentation values, and gives the indentation of the</tt> </tt>
<a name="L268"></a><tt class="py-lineno"> 268</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># corresponding DOM elements. An indentation of "None" reflects</tt> </tt>
<a name="L269"></a><tt class="py-lineno"> 269</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># an unknown indentation. However, the indentation must be</tt> </tt>
<a name="L270"></a><tt class="py-lineno"> 270</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># greater than, or greater than or equal to, the indentation of</tt> </tt>
<a name="L271"></a><tt class="py-lineno"> 271</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># the prior element (depending on what type of DOM element it</tt> </tt>
<a name="L272"></a><tt class="py-lineno"> 272</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># corresponds to). No 2 consecutive indent_stack values will be</tt> </tt>
<a name="L273"></a><tt class="py-lineno"> 273</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># ever be "None." Use initial dummy elements in the stack, so we</tt> </tt>
<a name="L274"></a><tt class="py-lineno"> 274</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># don't have to worry about bounds checking.</tt> </tt>
<a name="L275"></a><tt class="py-lineno"> 275</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">stack</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">]</tt> </tt>
<a name="L276"></a><tt class="py-lineno"> 276</tt> <tt class="py-line"> <tt class="py-name">indent_stack</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-name">None</tt><tt class="py-op">]</tt> </tt>
<a name="L277"></a><tt class="py-lineno"> 277</tt> <tt class="py-line"> </tt>
<a name="L278"></a><tt class="py-lineno"> 278</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">token</tt> <tt class="py-keyword">in</tt> <tt class="py-name">tokens</tt><tt class="py-op">:</tt> </tt>
<a name="L279"></a><tt class="py-lineno"> 279</tt> <tt class="py-line"> <tt class="py-comment"># Uncomment this for debugging:</tt> </tt>
<a name="L280"></a><tt class="py-lineno"> 280</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#print ('%s: %s\n%s: %s\n' % </tt> </tt>
<a name="L281"></a><tt class="py-lineno"> 281</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># (''.join(['%-11s' % (t and t.tag) for t in stack]),</tt> </tt>
<a name="L282"></a><tt class="py-lineno"> 282</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># token.tag, ''.join(['%-11s' % i for i in indent_stack]),</tt> </tt>
<a name="L283"></a><tt class="py-lineno"> 283</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># token.indent))</tt> </tt>
<a name="L284"></a><tt class="py-lineno"> 284</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L285"></a><tt class="py-lineno"> 285</tt> <tt class="py-line"> <tt class="py-comment"># Pop any completed blocks off the stack.</tt> </tt>
<a name="L286"></a><tt class="py-lineno"> 286</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-31" class="py-name" targets="Function epydoc.markup.epytext._pop_completed_blocks()=epydoc.markup.epytext-module.html#_pop_completed_blocks"><a title="epydoc.markup.epytext._pop_completed_blocks" class="py-name" href="#" onclick="return doclink('link-31', '_pop_completed_blocks', 'link-31');">_pop_completed_blocks</a></tt><tt class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">,</tt> <tt class="py-name">stack</tt><tt class="py-op">,</tt> <tt class="py-name">indent_stack</tt><tt class="py-op">)</tt> </tt>
<a name="L287"></a><tt class="py-lineno"> 287</tt> <tt class="py-line"> </tt>
<a name="L288"></a><tt class="py-lineno"> 288</tt> <tt class="py-line"> <tt class="py-comment"># If Token has type PARA, colorize and add the new paragraph</tt> </tt>
<a name="L289"></a><tt class="py-lineno"> 289</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">token</tt><tt class="py-op">.</tt><tt id="link-32" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-32', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt id="link-33" class="py-name" targets="Class epydoc.markup.epytext.Token=epydoc.markup.epytext.Token-class.html"><a title="epydoc.markup.epytext.Token" class="py-name" href="#" onclick="return doclink('link-33', 'Token', 'link-33');">Token</a></tt><tt class="py-op">.</tt><tt id="link-34" class="py-name" targets="Variable epydoc.markup.epytext.Token.PARA=epydoc.markup.epytext.Token-class.html#PARA"><a title="epydoc.markup.epytext.Token.PARA" class="py-name" href="#" onclick="return doclink('link-34', 'PARA', 'link-34');">PARA</a></tt><tt class="py-op">:</tt> </tt>
<a name="L290"></a><tt class="py-lineno"> 290</tt> <tt class="py-line"> <tt id="link-35" class="py-name" targets="Function epydoc.markup.epytext._add_para()=epydoc.markup.epytext-module.html#_add_para"><a title="epydoc.markup.epytext._add_para" class="py-name" href="#" onclick="return doclink('link-35', '_add_para', 'link-35');">_add_para</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-name">token</tt><tt class="py-op">,</tt> <tt class="py-name">stack</tt><tt class="py-op">,</tt> <tt class="py-name">indent_stack</tt><tt class="py-op">,</tt> <tt class="py-name">errors</tt><tt class="py-op">)</tt> </tt>
<a name="L291"></a><tt class="py-lineno"> 291</tt> <tt class="py-line"> </tt>
<a name="L292"></a><tt class="py-lineno"> 292</tt> <tt class="py-line"> <tt class="py-comment"># If Token has type HEADING, add the new section</tt> </tt>
<a name="L293"></a><tt class="py-lineno"> 293</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-name">token</tt><tt class="py-op">.</tt><tt id="link-36" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-36', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt id="link-37" class="py-name"><a title="epydoc.markup.epytext.Token" class="py-name" href="#" onclick="return doclink('link-37', 'Token', 'link-33');">Token</a></tt><tt class="py-op">.</tt><tt id="link-38" class="py-name" targets="Variable epydoc.markup.epytext.Token.HEADING=epydoc.markup.epytext.Token-class.html#HEADING"><a title="epydoc.markup.epytext.Token.HEADING" class="py-name" href="#" onclick="return doclink('link-38', 'HEADING', 'link-38');">HEADING</a></tt><tt class="py-op">:</tt> </tt>
<a name="L294"></a><tt class="py-lineno"> 294</tt> <tt class="py-line"> <tt id="link-39" class="py-name" targets="Function epydoc.markup.epytext._add_section()=epydoc.markup.epytext-module.html#_add_section"><a title="epydoc.markup.epytext._add_section" class="py-name" href="#" onclick="return doclink('link-39', '_add_section', 'link-39');">_add_section</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-name">token</tt><tt class="py-op">,</tt> <tt class="py-name">stack</tt><tt class="py-op">,</tt> <tt class="py-name">indent_stack</tt><tt class="py-op">,</tt> <tt class="py-name">errors</tt><tt class="py-op">)</tt> </tt>
<a name="L295"></a><tt class="py-lineno"> 295</tt> <tt class="py-line"> </tt>
<a name="L296"></a><tt class="py-lineno"> 296</tt> <tt class="py-line"> <tt class="py-comment"># If Token has type LBLOCK, add the new literal block</tt> </tt>
<a name="L297"></a><tt class="py-lineno"> 297</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-name">token</tt><tt class="py-op">.</tt><tt id="link-40" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-40', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt id="link-41" class="py-name"><a title="epydoc.markup.epytext.Token" class="py-name" href="#" onclick="return doclink('link-41', 'Token', 'link-33');">Token</a></tt><tt class="py-op">.</tt><tt id="link-42" class="py-name" targets="Variable epydoc.markup.epytext.Token.LBLOCK=epydoc.markup.epytext.Token-class.html#LBLOCK"><a title="epydoc.markup.epytext.Token.LBLOCK" class="py-name" href="#" onclick="return doclink('link-42', 'LBLOCK', 'link-42');">LBLOCK</a></tt><tt class="py-op">:</tt> </tt>
<a name="L298"></a><tt class="py-lineno"> 298</tt> <tt class="py-line"> <tt class="py-name">stack</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">children</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt id="link-43" class="py-name" targets="Method epydoc.markup.epytext.Token.to_dom()=epydoc.markup.epytext.Token-class.html#to_dom"><a title="epydoc.markup.epytext.Token.to_dom" class="py-name" href="#" onclick="return doclink('link-43', 'to_dom', 'link-43');">to_dom</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="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"># If Token has type DTBLOCK, add the new doctest block</tt> </tt>
<a name="L301"></a><tt class="py-lineno"> 301</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-name">token</tt><tt class="py-op">.</tt><tt id="link-44" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-44', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt id="link-45" class="py-name"><a title="epydoc.markup.epytext.Token" class="py-name" href="#" onclick="return doclink('link-45', 'Token', 'link-33');">Token</a></tt><tt class="py-op">.</tt><tt id="link-46" class="py-name" targets="Variable epydoc.markup.epytext.Token.DTBLOCK=epydoc.markup.epytext.Token-class.html#DTBLOCK"><a title="epydoc.markup.epytext.Token.DTBLOCK" class="py-name" href="#" onclick="return doclink('link-46', 'DTBLOCK', 'link-46');">DTBLOCK</a></tt><tt class="py-op">:</tt> </tt>
<a name="L302"></a><tt class="py-lineno"> 302</tt> <tt class="py-line"> <tt class="py-name">stack</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">children</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt id="link-47" class="py-name"><a title="epydoc.markup.epytext.Token.to_dom" class="py-name" href="#" onclick="return doclink('link-47', 'to_dom', 'link-43');">to_dom</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="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-comment"># If Token has type BULLET, add the new list/list item/field</tt> </tt>
<a name="L305"></a><tt class="py-lineno"> 305</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-name">token</tt><tt class="py-op">.</tt><tt id="link-48" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-48', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt id="link-49" class="py-name"><a title="epydoc.markup.epytext.Token" class="py-name" href="#" onclick="return doclink('link-49', 'Token', 'link-33');">Token</a></tt><tt class="py-op">.</tt><tt id="link-50" class="py-name" targets="Variable epydoc.markup.epytext.Token.BULLET=epydoc.markup.epytext.Token-class.html#BULLET"><a title="epydoc.markup.epytext.Token.BULLET" class="py-name" href="#" onclick="return doclink('link-50', 'BULLET', 'link-50');">BULLET</a></tt><tt class="py-op">:</tt> </tt>
<a name="L306"></a><tt class="py-lineno"> 306</tt> <tt class="py-line"> <tt id="link-51" class="py-name" targets="Function epydoc.markup.epytext._add_list()=epydoc.markup.epytext-module.html#_add_list"><a title="epydoc.markup.epytext._add_list" class="py-name" href="#" onclick="return doclink('link-51', '_add_list', 'link-51');">_add_list</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-name">token</tt><tt class="py-op">,</tt> <tt class="py-name">stack</tt><tt class="py-op">,</tt> <tt class="py-name">indent_stack</tt><tt class="py-op">,</tt> <tt class="py-name">errors</tt><tt class="py-op">)</tt> </tt>
<a name="L307"></a><tt class="py-lineno"> 307</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L308"></a><tt class="py-lineno"> 308</tt> <tt class="py-line"> <tt class="py-keyword">assert</tt> <tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-string">'Unknown token type: '</tt><tt class="py-op">+</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt id="link-52" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-52', 'tag', 'link-13');">tag</a></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-comment"># Check if the DOM element we just added was a field..</tt> </tt>
<a name="L311"></a><tt class="py-lineno"> 311</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">stack</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 id="link-53" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-53', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'field'</tt><tt class="py-op">:</tt> </tt>
<a name="L312"></a><tt class="py-lineno"> 312</tt> <tt class="py-line"> <tt class="py-name">encountered_field</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
<a name="L313"></a><tt class="py-lineno"> 313</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">encountered_field</tt> <tt class="py-op">==</tt> <tt class="py-number">1</tt><tt class="py-op">:</tt> </tt>
<a name="L314"></a><tt class="py-lineno"> 314</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">stack</tt><tt class="py-op">)</tt> <tt class="py-op"><=</tt> <tt class="py-number">3</tt><tt class="py-op">:</tt> </tt>
<a name="L315"></a><tt class="py-lineno"> 315</tt> <tt class="py-line"> <tt class="py-name">estr</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">"Fields must be the final elements in an "</tt><tt class="py-op">+</tt> </tt>
<a name="L316"></a><tt class="py-lineno"> 316</tt> <tt class="py-line"> <tt class="py-string">"epytext string."</tt><tt class="py-op">)</tt> </tt>
<a name="L317"></a><tt class="py-lineno"> 317</tt> <tt class="py-line"> <tt class="py-name">errors</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-54" class="py-name" targets="Class epydoc.markup.epytext.StructuringError=epydoc.markup.epytext.StructuringError-class.html"><a title="epydoc.markup.epytext.StructuringError" class="py-name" href="#" onclick="return doclink('link-54', 'StructuringError', 'link-54');">StructuringError</a></tt><tt class="py-op">(</tt><tt class="py-name">estr</tt><tt class="py-op">,</tt> <tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">startline</tt><tt class="py-op">)</tt><tt class="py-op">)</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-comment"># Graphs use inline markup (G{...}) but are really block-level</tt> </tt>
<a name="L320"></a><tt class="py-lineno"> 320</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># elements; so "raise" any graphs we generated. This is a bit of</tt> </tt>
<a name="L321"></a><tt class="py-lineno"> 321</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># a hack, but the alternative is to define a new markup for</tt> </tt>
<a name="L322"></a><tt class="py-lineno"> 322</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># block-level elements, which I'd rather not do. (See sourceforge</tt> </tt>
<a name="L323"></a><tt class="py-lineno"> 323</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># bug #1673017.)</tt> </tt>
<a name="L324"></a><tt class="py-lineno"> 324</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">child</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">:</tt> </tt>
<a name="L325"></a><tt class="py-lineno"> 325</tt> <tt class="py-line"> <tt id="link-55" class="py-name" targets="Function epydoc.markup.epytext._raise_graphs()=epydoc.markup.epytext-module.html#_raise_graphs"><a title="epydoc.markup.epytext._raise_graphs" class="py-name" href="#" onclick="return doclink('link-55', '_raise_graphs', 'link-55');">_raise_graphs</a></tt><tt class="py-op">(</tt><tt class="py-name">child</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L326"></a><tt class="py-lineno"> 326</tt> <tt class="py-line"> </tt>
<a name="L327"></a><tt class="py-lineno"> 327</tt> <tt class="py-line"> <tt class="py-comment"># If there was an error, then signal it!</tt> </tt>
<a name="L328"></a><tt class="py-lineno"> 328</tt> <tt class="py-line"><tt class="py-comment"></tt> <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-name">e</tt> <tt class="py-keyword">for</tt> <tt class="py-name">e</tt> <tt class="py-keyword">in</tt> <tt class="py-name">errors</tt> <tt class="py-keyword">if</tt> <tt class="py-name">e</tt><tt class="py-op">.</tt><tt id="link-56" class="py-name" targets="Method epydoc.markup.ParseError.is_fatal()=epydoc.markup.ParseError-class.html#is_fatal"><a title="epydoc.markup.ParseError.is_fatal" class="py-name" href="#" onclick="return doclink('link-56', 'is_fatal', 'link-56');">is_fatal</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-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L329"></a><tt class="py-lineno"> 329</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">raise_on_error</tt><tt class="py-op">:</tt> </tt>
<a name="L330"></a><tt class="py-lineno"> 330</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">errors</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L331"></a><tt class="py-lineno"> 331</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L332"></a><tt class="py-lineno"> 332</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</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-comment"># Return the top-level epytext DOM element.</tt> </tt>
<a name="L335"></a><tt class="py-lineno"> 335</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt class="py-name">doc</tt> </tt>
</div><a name="L336"></a><tt class="py-lineno"> 336</tt> <tt class="py-line"> </tt>
<a name="_raise_graphs"></a><div id="_raise_graphs-def"><a name="L337"></a><tt class="py-lineno"> 337</tt> <a class="py-toggle" href="#" id="_raise_graphs-toggle" onclick="return toggle('_raise_graphs');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext-module.html#_raise_graphs">_raise_graphs</a><tt class="py-op">(</tt><tt class="py-param">tree</tt><tt class="py-op">,</tt> <tt class="py-param">parent</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_raise_graphs-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_raise_graphs-expanded"><a name="L338"></a><tt class="py-lineno"> 338</tt> <tt class="py-line"> <tt class="py-comment"># Recurse to children.</tt> </tt>
<a name="L339"></a><tt class="py-lineno"> 339</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">have_graph_child</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L340"></a><tt class="py-lineno"> 340</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">elt</tt> <tt class="py-keyword">in</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">:</tt> </tt>
<a name="L341"></a><tt class="py-lineno"> 341</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">elt</tt><tt class="py-op">,</tt> <tt id="link-57" class="py-name"><a title="epydoc.markup.epytext.Element" class="py-name" href="#" onclick="return doclink('link-57', 'Element', 'link-30');">Element</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L342"></a><tt class="py-lineno"> 342</tt> <tt class="py-line"> <tt id="link-58" class="py-name"><a title="epydoc.markup.epytext._raise_graphs" class="py-name" href="#" onclick="return doclink('link-58', '_raise_graphs', 'link-55');">_raise_graphs</a></tt><tt class="py-op">(</tt><tt class="py-name">elt</tt><tt class="py-op">,</tt> <tt class="py-name">tree</tt><tt class="py-op">)</tt> </tt>
<a name="L343"></a><tt class="py-lineno"> 343</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">elt</tt><tt class="py-op">.</tt><tt id="link-59" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-59', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'graph'</tt><tt class="py-op">:</tt> <tt class="py-name">have_graph_child</tt> <tt class="py-op">=</tt> <tt class="py-name">True</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">block</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">'section'</tt><tt class="py-op">,</tt> <tt class="py-string">'fieldlist'</tt><tt class="py-op">,</tt> <tt class="py-string">'field'</tt><tt class="py-op">,</tt> <tt class="py-string">'ulist'</tt><tt class="py-op">,</tt> <tt class="py-string">'olist'</tt><tt class="py-op">,</tt> <tt class="py-string">'li'</tt><tt class="py-op">)</tt> </tt>
<a name="L346"></a><tt class="py-lineno"> 346</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">have_graph_child</tt> <tt class="py-keyword">and</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-60" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-60', 'tag', 'link-13');">tag</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">block</tt><tt class="py-op">:</tt> </tt>
<a name="L347"></a><tt class="py-lineno"> 347</tt> <tt class="py-line"> <tt class="py-name">child_index</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L348"></a><tt class="py-lineno"> 348</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">elt</tt> <tt class="py-keyword">in</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">:</tt> </tt>
<a name="L349"></a><tt class="py-lineno"> 349</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">elt</tt><tt class="py-op">,</tt> <tt id="link-61" class="py-name"><a title="epydoc.markup.epytext.Element" class="py-name" href="#" onclick="return doclink('link-61', 'Element', 'link-30');">Element</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">elt</tt><tt class="py-op">.</tt><tt id="link-62" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-62', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'graph'</tt><tt class="py-op">:</tt> </tt>
<a name="L350"></a><tt class="py-lineno"> 350</tt> <tt class="py-line"> <tt class="py-comment"># We found a graph: splice it into the parent.</tt> </tt>
<a name="L351"></a><tt class="py-lineno"> 351</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">parent_index</tt> <tt class="py-op">=</tt> <tt class="py-name">parent</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">.</tt><tt class="py-name">index</tt><tt class="py-op">(</tt><tt class="py-name">tree</tt><tt class="py-op">)</tt> </tt>
<a name="L352"></a><tt class="py-lineno"> 352</tt> <tt class="py-line"> <tt class="py-name">left</tt> <tt class="py-op">=</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-name">child_index</tt><tt class="py-op">]</tt> </tt>
<a name="L353"></a><tt class="py-lineno"> 353</tt> <tt class="py-line"> <tt class="py-name">right</tt> <tt class="py-op">=</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">[</tt><tt class="py-name">child_index</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="L354"></a><tt class="py-lineno"> 354</tt> <tt class="py-line"> <tt class="py-name">parent</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">[</tt><tt class="py-name">parent_index</tt><tt class="py-op">:</tt><tt class="py-name">parent_index</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="L355"></a><tt class="py-lineno"> 355</tt> <tt class="py-line"> <tt id="link-63" class="py-name"><a title="epydoc.markup.epytext.Element" class="py-name" href="#" onclick="return doclink('link-63', 'Element', 'link-30');">Element</a></tt><tt class="py-op">(</tt><tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-64" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-64', 'tag', 'link-13');">tag</a></tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-name">left</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">attribs</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-name">elt</tt><tt class="py-op">,</tt> </tt>
<a name="L357"></a><tt class="py-lineno"> 357</tt> <tt class="py-line"> <tt id="link-65" class="py-name"><a title="epydoc.markup.epytext.Element" class="py-name" href="#" onclick="return doclink('link-65', 'Element', 'link-30');">Element</a></tt><tt class="py-op">(</tt><tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-66" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-66', 'tag', 'link-13');">tag</a></tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-name">right</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">attribs</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L358"></a><tt class="py-lineno"> 358</tt> <tt class="py-line"> <tt class="py-name">child_index</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L359"></a><tt class="py-lineno"> 359</tt> <tt class="py-line"> <tt class="py-name">parent_index</tt> <tt class="py-op">+=</tt> <tt class="py-number">2</tt> </tt>
<a name="L360"></a><tt class="py-lineno"> 360</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L361"></a><tt class="py-lineno"> 361</tt> <tt class="py-line"> <tt class="py-name">child_index</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
</div><a name="L362"></a><tt class="py-lineno"> 362</tt> <tt class="py-line"> </tt>
<a name="_pop_completed_blocks"></a><div id="_pop_completed_blocks-def"><a name="L363"></a><tt class="py-lineno"> 363</tt> <a class="py-toggle" href="#" id="_pop_completed_blocks-toggle" onclick="return toggle('_pop_completed_blocks');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext-module.html#_pop_completed_blocks">_pop_completed_blocks</a><tt class="py-op">(</tt><tt class="py-param">token</tt><tt class="py-op">,</tt> <tt class="py-param">stack</tt><tt class="py-op">,</tt> <tt class="py-param">indent_stack</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_pop_completed_blocks-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_pop_completed_blocks-expanded"><a name="L364"></a><tt class="py-lineno"> 364</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L365"></a><tt class="py-lineno"> 365</tt> <tt class="py-line"><tt class="py-docstring"> Pop any completed blocks off the stack. This includes any</tt> </tt>
<a name="L366"></a><tt class="py-lineno"> 366</tt> <tt class="py-line"><tt class="py-docstring"> blocks that we have dedented past, as well as any list item</tt> </tt>
<a name="L367"></a><tt class="py-lineno"> 367</tt> <tt class="py-line"><tt class="py-docstring"> blocks that we've dedented to. The top element on the stack </tt> </tt>
<a name="L368"></a><tt class="py-lineno"> 368</tt> <tt class="py-line"><tt class="py-docstring"> should only be a list if we're about to start a new list</tt> </tt>
<a name="L369"></a><tt class="py-lineno"> 369</tt> <tt class="py-line"><tt class="py-docstring"> item (i.e., if the next token is a bullet).</tt> </tt>
<a name="L370"></a><tt class="py-lineno"> 370</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L371"></a><tt class="py-lineno"> 371</tt> <tt class="py-line"> <tt class="py-name">indent</tt> <tt class="py-op">=</tt> <tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">indent</tt> </tt>
<a name="L372"></a><tt class="py-lineno"> 372</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">indent</tt> <tt class="py-op">!=</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L373"></a><tt class="py-lineno"> 373</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">stack</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>
<a name="L374"></a><tt class="py-lineno"> 374</tt> <tt class="py-line"> <tt class="py-name">pop</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L375"></a><tt class="py-lineno"> 375</tt> <tt class="py-line"> </tt>
<a name="L376"></a><tt class="py-lineno"> 376</tt> <tt class="py-line"> <tt class="py-comment"># Dedent past a block</tt> </tt>
<a name="L377"></a><tt class="py-lineno"> 377</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">indent_stack</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">None</tt> <tt class="py-keyword">and</tt> <tt class="py-name">indent</tt><tt class="py-op"><</tt><tt class="py-name">indent_stack</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">pop</tt><tt class="py-op">=</tt><tt class="py-number">1</tt> </tt>
<a name="L378"></a><tt class="py-lineno"> 378</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">indent_stack</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">None</tt> <tt class="py-keyword">and</tt> <tt class="py-name">indent</tt><tt class="py-op"><</tt><tt class="py-name">indent_stack</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-name">pop</tt><tt class="py-op">=</tt><tt class="py-number">1</tt> </tt>
<a name="L379"></a><tt class="py-lineno"> 379</tt> <tt class="py-line"> </tt>
<a name="L380"></a><tt class="py-lineno"> 380</tt> <tt class="py-line"> <tt class="py-comment"># Dedent to a list item, if it is follwed by another list</tt> </tt>
<a name="L381"></a><tt class="py-lineno"> 381</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># item with the same indentation.</tt> </tt>
<a name="L382"></a><tt class="py-lineno"> 382</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt id="link-67" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-67', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'bullet'</tt> <tt class="py-keyword">and</tt> <tt class="py-name">indent</tt><tt class="py-op">==</tt><tt class="py-name">indent_stack</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-keyword">and</tt> </tt>
<a name="L383"></a><tt class="py-lineno"> 383</tt> <tt class="py-line"> <tt class="py-name">stack</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 id="link-68" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-68', 'tag', 'link-13');">tag</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-string">'li'</tt><tt class="py-op">,</tt> <tt class="py-string">'field'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-name">pop</tt><tt class="py-op">=</tt><tt class="py-number">1</tt> </tt>
<a name="L384"></a><tt class="py-lineno"> 384</tt> <tt class="py-line"> </tt>
<a name="L385"></a><tt class="py-lineno"> 385</tt> <tt class="py-line"> <tt class="py-comment"># End of a list (no more list items available)</tt> </tt>
<a name="L386"></a><tt class="py-lineno"> 386</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-op">(</tt><tt class="py-name">stack</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 id="link-69" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-69', 'tag', 'link-13');">tag</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-string">'ulist'</tt><tt class="py-op">,</tt> <tt class="py-string">'olist'</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L387"></a><tt class="py-lineno"> 387</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt id="link-70" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-70', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">!=</tt> <tt class="py-string">'bullet'</tt> <tt class="py-keyword">or</tt> <tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">contents</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-string">':'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L388"></a><tt class="py-lineno"> 388</tt> <tt class="py-line"> <tt class="py-name">pop</tt><tt class="py-op">=</tt><tt class="py-number">1</tt> </tt>
<a name="L389"></a><tt class="py-lineno"> 389</tt> <tt class="py-line"> </tt>
<a name="L390"></a><tt class="py-lineno"> 390</tt> <tt class="py-line"> <tt class="py-comment"># Pop the block, if it's complete. Otherwise, we're done.</tt> </tt>
<a name="L391"></a><tt class="py-lineno"> 391</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">pop</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="L392"></a><tt class="py-lineno"> 392</tt> <tt class="py-line"> <tt class="py-name">stack</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="L393"></a><tt class="py-lineno"> 393</tt> <tt class="py-line"> <tt class="py-name">indent_stack</tt><tt class="py-op">.</tt><tt class="py-name">pop</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L394"></a><tt class="py-lineno"> 394</tt> <tt class="py-line"> </tt>
<a name="_add_para"></a><div id="_add_para-def"><a name="L395"></a><tt class="py-lineno"> 395</tt> <a class="py-toggle" href="#" id="_add_para-toggle" onclick="return toggle('_add_para');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext-module.html#_add_para">_add_para</a><tt class="py-op">(</tt><tt class="py-param">doc</tt><tt class="py-op">,</tt> <tt class="py-param">para_token</tt><tt class="py-op">,</tt> <tt class="py-param">stack</tt><tt class="py-op">,</tt> <tt class="py-param">indent_stack</tt><tt class="py-op">,</tt> <tt class="py-param">errors</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_add_para-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_add_para-expanded"><a name="L396"></a><tt class="py-lineno"> 396</tt> <tt class="py-line"> <tt class="py-docstring">"""Colorize the given paragraph, and add it to the DOM tree."""</tt> </tt>
<a name="L397"></a><tt class="py-lineno"> 397</tt> <tt class="py-line"> <tt class="py-comment"># Check indentation, and update the parent's indentation</tt> </tt>
<a name="L398"></a><tt class="py-lineno"> 398</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># when appropriate.</tt> </tt>
<a name="L399"></a><tt class="py-lineno"> 399</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">indent_stack</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">None</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">indent_stack</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">para_token</tt><tt class="py-op">.</tt><tt class="py-name">indent</tt> </tt>
<a name="L401"></a><tt class="py-lineno"> 401</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">para_token</tt><tt class="py-op">.</tt><tt class="py-name">indent</tt> <tt class="py-op">==</tt> <tt class="py-name">indent_stack</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="L402"></a><tt class="py-lineno"> 402</tt> <tt class="py-line"> <tt class="py-comment"># Colorize the paragraph and add it.</tt> </tt>
<a name="L403"></a><tt class="py-lineno"> 403</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">para</tt> <tt class="py-op">=</tt> <tt id="link-71" class="py-name" targets="Function epydoc.markup.epytext._colorize()=epydoc.markup.epytext-module.html#_colorize,Method epydoc.markup.pyval_repr.PyvalColorizer._colorize()=epydoc.markup.pyval_repr.PyvalColorizer-class.html#_colorize"><a title="epydoc.markup.epytext._colorize
epydoc.markup.pyval_repr.PyvalColorizer._colorize" class="py-name" href="#" onclick="return doclink('link-71', '_colorize', 'link-71');">_colorize</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-name">para_token</tt><tt class="py-op">,</tt> <tt class="py-name">errors</tt><tt class="py-op">)</tt> </tt>
<a name="L404"></a><tt class="py-lineno"> 404</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">para_token</tt><tt class="py-op">.</tt><tt class="py-name">inline</tt><tt class="py-op">:</tt> </tt>
<a name="L405"></a><tt class="py-lineno"> 405</tt> <tt class="py-line"> <tt class="py-name">para</tt><tt class="py-op">.</tt><tt class="py-name">attribs</tt><tt class="py-op">[</tt><tt class="py-string">'inline'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L406"></a><tt class="py-lineno"> 406</tt> <tt class="py-line"> <tt class="py-name">stack</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">children</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">para</tt><tt class="py-op">)</tt> </tt>
<a name="L407"></a><tt class="py-lineno"> 407</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L408"></a><tt class="py-lineno"> 408</tt> <tt class="py-line"> <tt class="py-name">estr</tt> <tt class="py-op">=</tt> <tt class="py-string">"Improper paragraph indentation."</tt> </tt>
<a name="L409"></a><tt class="py-lineno"> 409</tt> <tt class="py-line"> <tt class="py-name">errors</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-72" class="py-name"><a title="epydoc.markup.epytext.StructuringError" class="py-name" href="#" onclick="return doclink('link-72', 'StructuringError', 'link-54');">StructuringError</a></tt><tt class="py-op">(</tt><tt class="py-name">estr</tt><tt class="py-op">,</tt> <tt class="py-name">para_token</tt><tt class="py-op">.</tt><tt class="py-name">startline</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L410"></a><tt class="py-lineno"> 410</tt> <tt class="py-line"> </tt>
<a name="_add_section"></a><div id="_add_section-def"><a name="L411"></a><tt class="py-lineno"> 411</tt> <a class="py-toggle" href="#" id="_add_section-toggle" onclick="return toggle('_add_section');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext-module.html#_add_section">_add_section</a><tt class="py-op">(</tt><tt class="py-param">doc</tt><tt class="py-op">,</tt> <tt class="py-param">heading_token</tt><tt class="py-op">,</tt> <tt class="py-param">stack</tt><tt class="py-op">,</tt> <tt class="py-param">indent_stack</tt><tt class="py-op">,</tt> <tt class="py-param">errors</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_add_section-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_add_section-expanded"><a name="L412"></a><tt class="py-lineno"> 412</tt> <tt class="py-line"> <tt class="py-docstring">"""Add a new section to the DOM tree, with the given heading."""</tt> </tt>
<a name="L413"></a><tt class="py-lineno"> 413</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">indent_stack</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">None</tt><tt class="py-op">:</tt> </tt>
<a name="L414"></a><tt class="py-lineno"> 414</tt> <tt class="py-line"> <tt class="py-name">indent_stack</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">heading_token</tt><tt class="py-op">.</tt><tt class="py-name">indent</tt> </tt>
<a name="L415"></a><tt class="py-lineno"> 415</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">indent_stack</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">heading_token</tt><tt class="py-op">.</tt><tt class="py-name">indent</tt><tt class="py-op">:</tt> </tt>
<a name="L416"></a><tt class="py-lineno"> 416</tt> <tt class="py-line"> <tt class="py-name">estr</tt> <tt class="py-op">=</tt> <tt class="py-string">"Improper heading indentation."</tt> </tt>
<a name="L417"></a><tt class="py-lineno"> 417</tt> <tt class="py-line"> <tt class="py-name">errors</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-73" class="py-name"><a title="epydoc.markup.epytext.StructuringError" class="py-name" href="#" onclick="return doclink('link-73', 'StructuringError', 'link-54');">StructuringError</a></tt><tt class="py-op">(</tt><tt class="py-name">estr</tt><tt class="py-op">,</tt> <tt class="py-name">heading_token</tt><tt class="py-op">.</tt><tt class="py-name">startline</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L418"></a><tt class="py-lineno"> 418</tt> <tt class="py-line"> </tt>
<a name="L419"></a><tt class="py-lineno"> 419</tt> <tt class="py-line"> <tt class="py-comment"># Check for errors.</tt> </tt>
<a name="L420"></a><tt class="py-lineno"> 420</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">tok</tt> <tt class="py-keyword">in</tt> <tt class="py-name">stack</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-op">:</tt> </tt>
<a name="L421"></a><tt class="py-lineno"> 421</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">tok</tt><tt class="py-op">.</tt><tt id="link-74" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-74', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">!=</tt> <tt class="py-string">"section"</tt><tt class="py-op">:</tt> </tt>
<a name="L422"></a><tt class="py-lineno"> 422</tt> <tt class="py-line"> <tt class="py-name">estr</tt> <tt class="py-op">=</tt> <tt class="py-string">"Headings must occur at the top level."</tt> </tt>
<a name="L423"></a><tt class="py-lineno"> 423</tt> <tt class="py-line"> <tt class="py-name">errors</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-75" class="py-name"><a title="epydoc.markup.epytext.StructuringError" class="py-name" href="#" onclick="return doclink('link-75', 'StructuringError', 'link-54');">StructuringError</a></tt><tt class="py-op">(</tt><tt class="py-name">estr</tt><tt class="py-op">,</tt> <tt class="py-name">heading_token</tt><tt class="py-op">.</tt><tt class="py-name">startline</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L424"></a><tt class="py-lineno"> 424</tt> <tt class="py-line"> <tt class="py-keyword">break</tt> </tt>
<a name="L425"></a><tt class="py-lineno"> 425</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">heading_token</tt><tt class="py-op">.</tt><tt class="py-name">level</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-name">len</tt><tt class="py-op">(</tt><tt class="py-name">stack</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L426"></a><tt class="py-lineno"> 426</tt> <tt class="py-line"> <tt class="py-name">estr</tt> <tt class="py-op">=</tt> <tt class="py-string">"Wrong underline character for heading."</tt> </tt>
<a name="L427"></a><tt class="py-lineno"> 427</tt> <tt class="py-line"> <tt class="py-name">errors</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-76" class="py-name"><a title="epydoc.markup.epytext.StructuringError" class="py-name" href="#" onclick="return doclink('link-76', 'StructuringError', 'link-54');">StructuringError</a></tt><tt class="py-op">(</tt><tt class="py-name">estr</tt><tt class="py-op">,</tt> <tt class="py-name">heading_token</tt><tt class="py-op">.</tt><tt class="py-name">startline</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L428"></a><tt class="py-lineno"> 428</tt> <tt class="py-line"> </tt>
<a name="L429"></a><tt class="py-lineno"> 429</tt> <tt class="py-line"> <tt class="py-comment"># Pop the appropriate number of headings so we're at the</tt> </tt>
<a name="L430"></a><tt class="py-lineno"> 430</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># correct level.</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">stack</tt><tt class="py-op">[</tt><tt class="py-name">heading_token</tt><tt class="py-op">.</tt><tt class="py-name">level</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-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L432"></a><tt class="py-lineno"> 432</tt> <tt class="py-line"> <tt class="py-name">indent_stack</tt><tt class="py-op">[</tt><tt class="py-name">heading_token</tt><tt class="py-op">.</tt><tt class="py-name">level</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-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L433"></a><tt class="py-lineno"> 433</tt> <tt class="py-line"> </tt>
<a name="L434"></a><tt class="py-lineno"> 434</tt> <tt class="py-line"> <tt class="py-comment"># Colorize the heading</tt> </tt>
<a name="L435"></a><tt class="py-lineno"> 435</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">head</tt> <tt class="py-op">=</tt> <tt id="link-77" class="py-name"><a title="epydoc.markup.epytext._colorize
epydoc.markup.pyval_repr.PyvalColorizer._colorize" class="py-name" href="#" onclick="return doclink('link-77', '_colorize', 'link-71');">_colorize</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-name">heading_token</tt><tt class="py-op">,</tt> <tt class="py-name">errors</tt><tt class="py-op">,</tt> <tt class="py-string">'heading'</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"># Add the section's and heading's DOM elements.</tt> </tt>
<a name="L438"></a><tt class="py-lineno"> 438</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">sec</tt> <tt class="py-op">=</tt> <tt id="link-78" class="py-name"><a title="epydoc.markup.epytext.Element" class="py-name" href="#" onclick="return doclink('link-78', 'Element', 'link-30');">Element</a></tt><tt class="py-op">(</tt><tt class="py-string">"section"</tt><tt class="py-op">)</tt> </tt>
<a name="L439"></a><tt class="py-lineno"> 439</tt> <tt class="py-line"> <tt class="py-name">stack</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">children</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">sec</tt><tt class="py-op">)</tt> </tt>
<a name="L440"></a><tt class="py-lineno"> 440</tt> <tt class="py-line"> <tt class="py-name">stack</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">sec</tt><tt class="py-op">)</tt> </tt>
<a name="L441"></a><tt class="py-lineno"> 441</tt> <tt class="py-line"> <tt class="py-name">sec</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">head</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">indent_stack</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
</div><a name="L443"></a><tt class="py-lineno"> 443</tt> <tt class="py-line"> </tt>
<a name="_add_list"></a><div id="_add_list-def"><a name="L444"></a><tt class="py-lineno"> 444</tt> <a class="py-toggle" href="#" id="_add_list-toggle" onclick="return toggle('_add_list');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext-module.html#_add_list">_add_list</a><tt class="py-op">(</tt><tt class="py-param">doc</tt><tt class="py-op">,</tt> <tt class="py-param">bullet_token</tt><tt class="py-op">,</tt> <tt class="py-param">stack</tt><tt class="py-op">,</tt> <tt class="py-param">indent_stack</tt><tt class="py-op">,</tt> <tt class="py-param">errors</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_add_list-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_add_list-expanded"><a name="L445"></a><tt class="py-lineno"> 445</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L446"></a><tt class="py-lineno"> 446</tt> <tt class="py-line"><tt class="py-docstring"> Add a new list item or field to the DOM tree, with the given</tt> </tt>
<a name="L447"></a><tt class="py-lineno"> 447</tt> <tt class="py-line"><tt class="py-docstring"> bullet or field tag. When necessary, create the associated</tt> </tt>
<a name="L448"></a><tt class="py-lineno"> 448</tt> <tt class="py-line"><tt class="py-docstring"> list.</tt> </tt>
<a name="L449"></a><tt class="py-lineno"> 449</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L450"></a><tt class="py-lineno"> 450</tt> <tt class="py-line"> <tt class="py-comment"># Determine what type of bullet it is.</tt> </tt>
<a name="L451"></a><tt class="py-lineno"> 451</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">bullet_token</tt><tt class="py-op">.</tt><tt class="py-name">contents</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-string">'-'</tt><tt class="py-op">:</tt> </tt>
<a name="L452"></a><tt class="py-lineno"> 452</tt> <tt class="py-line"> <tt class="py-name">list_type</tt> <tt class="py-op">=</tt> <tt class="py-string">'ulist'</tt> </tt>
<a name="L453"></a><tt class="py-lineno"> 453</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">bullet_token</tt><tt class="py-op">.</tt><tt class="py-name">contents</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-string">'.'</tt><tt class="py-op">:</tt> </tt>
<a name="L454"></a><tt class="py-lineno"> 454</tt> <tt class="py-line"> <tt class="py-name">list_type</tt> <tt class="py-op">=</tt> <tt class="py-string">'olist'</tt> </tt>
<a name="L455"></a><tt class="py-lineno"> 455</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">bullet_token</tt><tt class="py-op">.</tt><tt class="py-name">contents</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-string">':'</tt><tt class="py-op">:</tt> </tt>
<a name="L456"></a><tt class="py-lineno"> 456</tt> <tt class="py-line"> <tt class="py-name">list_type</tt> <tt class="py-op">=</tt> <tt class="py-string">'fieldlist'</tt> </tt>
<a name="L457"></a><tt class="py-lineno"> 457</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L458"></a><tt class="py-lineno"> 458</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">AssertionError</tt><tt class="py-op">(</tt><tt class="py-string">'Bad Bullet: %r'</tt> <tt class="py-op">%</tt> <tt class="py-name">bullet_token</tt><tt class="py-op">.</tt><tt class="py-name">contents</tt><tt class="py-op">)</tt> </tt>
<a name="L459"></a><tt class="py-lineno"> 459</tt> <tt class="py-line"> </tt>
<a name="L460"></a><tt class="py-lineno"> 460</tt> <tt class="py-line"> <tt class="py-comment"># Is this a new list?</tt> </tt>
<a name="L461"></a><tt class="py-lineno"> 461</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">newlist</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L462"></a><tt class="py-lineno"> 462</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">stack</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 id="link-79" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-79', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">!=</tt> <tt class="py-name">list_type</tt><tt class="py-op">:</tt> </tt>
<a name="L463"></a><tt class="py-lineno"> 463</tt> <tt class="py-line"> <tt class="py-name">newlist</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
<a name="L464"></a><tt class="py-lineno"> 464</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">list_type</tt> <tt class="py-op">==</tt> <tt class="py-string">'olist'</tt> <tt class="py-keyword">and</tt> <tt class="py-name">stack</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 id="link-80" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-80', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'olist'</tt><tt class="py-op">:</tt> </tt>
<a name="L465"></a><tt class="py-lineno"> 465</tt> <tt class="py-line"> <tt class="py-name">old_listitem</tt> <tt class="py-op">=</tt> <tt class="py-name">stack</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">children</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="L466"></a><tt class="py-lineno"> 466</tt> <tt class="py-line"> <tt class="py-name">old_bullet</tt> <tt class="py-op">=</tt> <tt class="py-name">old_listitem</tt><tt class="py-op">.</tt><tt class="py-name">attribs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">"bullet"</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">'.'</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">1</tt><tt class="py-op">]</tt> </tt>
<a name="L467"></a><tt class="py-lineno"> 467</tt> <tt class="py-line"> <tt class="py-name">new_bullet</tt> <tt class="py-op">=</tt> <tt class="py-name">bullet_token</tt><tt class="py-op">.</tt><tt class="py-name">contents</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-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="L468"></a><tt class="py-lineno"> 468</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">new_bullet</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-name">old_bullet</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-keyword">or</tt> </tt>
<a name="L469"></a><tt class="py-lineno"> 469</tt> <tt class="py-line"> <tt class="py-name">int</tt><tt class="py-op">(</tt><tt class="py-name">new_bullet</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">int</tt><tt class="py-op">(</tt><tt class="py-name">old_bullet</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-number">1</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L470"></a><tt class="py-lineno"> 470</tt> <tt class="py-line"> <tt class="py-name">newlist</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
<a name="L471"></a><tt class="py-lineno"> 471</tt> <tt class="py-line"> </tt>
<a name="L472"></a><tt class="py-lineno"> 472</tt> <tt class="py-line"> <tt class="py-comment"># Create the new list.</tt> </tt>
<a name="L473"></a><tt class="py-lineno"> 473</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">newlist</tt><tt class="py-op">:</tt> </tt>
<a name="L474"></a><tt class="py-lineno"> 474</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">stack</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 id="link-81" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-81', 'tag', 'link-13');">tag</a></tt> <tt class="py-keyword">is</tt> <tt class="py-string">'fieldlist'</tt><tt class="py-op">:</tt> </tt>
<a name="L475"></a><tt class="py-lineno"> 475</tt> <tt class="py-line"> <tt class="py-comment"># The new list item is not a field list item (since this</tt> </tt>
<a name="L476"></a><tt class="py-lineno"> 476</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># is a new list); but it's indented the same as the field</tt> </tt>
<a name="L477"></a><tt class="py-lineno"> 477</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># list. This either means that they forgot to indent the</tt> </tt>
<a name="L478"></a><tt class="py-lineno"> 478</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># list, or they are trying to put something after the</tt> </tt>
<a name="L479"></a><tt class="py-lineno"> 479</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># field list. The first one seems more likely, so we'll</tt> </tt>
<a name="L480"></a><tt class="py-lineno"> 480</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># just warn about that (to avoid confusion).</tt> </tt>
<a name="L481"></a><tt class="py-lineno"> 481</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">estr</tt> <tt class="py-op">=</tt> <tt class="py-string">"Lists must be indented."</tt> </tt>
<a name="L482"></a><tt class="py-lineno"> 482</tt> <tt class="py-line"> <tt class="py-name">errors</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-82" class="py-name"><a title="epydoc.markup.epytext.StructuringError" class="py-name" href="#" onclick="return doclink('link-82', 'StructuringError', 'link-54');">StructuringError</a></tt><tt class="py-op">(</tt><tt class="py-name">estr</tt><tt class="py-op">,</tt> <tt class="py-name">bullet_token</tt><tt class="py-op">.</tt><tt class="py-name">startline</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">if</tt> <tt class="py-name">stack</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 id="link-83" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-83', 'tag', 'link-13');">tag</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-string">'ulist'</tt><tt class="py-op">,</tt> <tt class="py-string">'olist'</tt><tt class="py-op">,</tt> <tt class="py-string">'fieldlist'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L484"></a><tt class="py-lineno"> 484</tt> <tt class="py-line"> <tt class="py-name">stack</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="L485"></a><tt class="py-lineno"> 485</tt> <tt class="py-line"> <tt class="py-name">indent_stack</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="L486"></a><tt class="py-lineno"> 486</tt> <tt class="py-line"> </tt>
<a name="L487"></a><tt class="py-lineno"> 487</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">list_type</tt> <tt class="py-op">!=</tt> <tt class="py-string">'fieldlist'</tt> <tt class="py-keyword">and</tt> <tt class="py-name">indent_stack</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-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L488"></a><tt class="py-lineno"> 488</tt> <tt class="py-line"> <tt class="py-name">bullet_token</tt><tt class="py-op">.</tt><tt class="py-name">indent</tt> <tt class="py-op">==</tt> <tt class="py-name">indent_stack</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="L489"></a><tt class="py-lineno"> 489</tt> <tt class="py-line"> <tt class="py-comment"># Ignore this error if there's text on the same line as</tt> </tt>
<a name="L490"></a><tt class="py-lineno"> 490</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># the comment-opening quote -- epydoc can't reliably</tt> </tt>
<a name="L491"></a><tt class="py-lineno"> 491</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># determine the indentation for that line.</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">if</tt> <tt class="py-name">bullet_token</tt><tt class="py-op">.</tt><tt class="py-name">startline</tt> <tt class="py-op">!=</tt> <tt class="py-number">1</tt> <tt class="py-keyword">or</tt> <tt class="py-name">bullet_token</tt><tt class="py-op">.</tt><tt class="py-name">indent</tt> <tt class="py-op">!=</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L493"></a><tt class="py-lineno"> 493</tt> <tt class="py-line"> <tt class="py-name">estr</tt> <tt class="py-op">=</tt> <tt class="py-string">"Lists must be indented."</tt> </tt>
<a name="L494"></a><tt class="py-lineno"> 494</tt> <tt class="py-line"> <tt class="py-name">errors</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-84" class="py-name"><a title="epydoc.markup.epytext.StructuringError" class="py-name" href="#" onclick="return doclink('link-84', 'StructuringError', 'link-54');">StructuringError</a></tt><tt class="py-op">(</tt><tt class="py-name">estr</tt><tt class="py-op">,</tt> <tt class="py-name">bullet_token</tt><tt class="py-op">.</tt><tt class="py-name">startline</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L495"></a><tt class="py-lineno"> 495</tt> <tt class="py-line"> </tt>
<a name="L496"></a><tt class="py-lineno"> 496</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">list_type</tt> <tt class="py-op">==</tt> <tt class="py-string">'fieldlist'</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"># Fieldlist should be at the top-level.</tt> </tt>
<a name="L498"></a><tt class="py-lineno"> 498</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">tok</tt> <tt class="py-keyword">in</tt> <tt class="py-name">stack</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-op">:</tt> </tt>
<a name="L499"></a><tt class="py-lineno"> 499</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">tok</tt><tt class="py-op">.</tt><tt id="link-85" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-85', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">!=</tt> <tt class="py-string">"section"</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">estr</tt> <tt class="py-op">=</tt> <tt class="py-string">"Fields must be at the top level."</tt> </tt>
<a name="L501"></a><tt class="py-lineno"> 501</tt> <tt class="py-line"> <tt class="py-name">errors</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt> </tt>
<a name="L502"></a><tt class="py-lineno"> 502</tt> <tt class="py-line"> <tt id="link-86" class="py-name"><a title="epydoc.markup.epytext.StructuringError" class="py-name" href="#" onclick="return doclink('link-86', 'StructuringError', 'link-54');">StructuringError</a></tt><tt class="py-op">(</tt><tt class="py-name">estr</tt><tt class="py-op">,</tt> <tt class="py-name">bullet_token</tt><tt class="py-op">.</tt><tt class="py-name">startline</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">break</tt> </tt>
<a name="L504"></a><tt class="py-lineno"> 504</tt> <tt class="py-line"> <tt class="py-name">stack</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-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L505"></a><tt class="py-lineno"> 505</tt> <tt class="py-line"> <tt class="py-name">indent_stack</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-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<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"># Add the new list.</tt> </tt>
<a name="L508"></a><tt class="py-lineno"> 508</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">lst</tt> <tt class="py-op">=</tt> <tt id="link-87" class="py-name"><a title="epydoc.markup.epytext.Element" class="py-name" href="#" onclick="return doclink('link-87', 'Element', 'link-30');">Element</a></tt><tt class="py-op">(</tt><tt class="py-name">list_type</tt><tt class="py-op">)</tt> </tt>
<a name="L509"></a><tt class="py-lineno"> 509</tt> <tt class="py-line"> <tt class="py-name">stack</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">children</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">lst</tt><tt class="py-op">)</tt> </tt>
<a name="L510"></a><tt class="py-lineno"> 510</tt> <tt class="py-line"> <tt class="py-name">stack</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">lst</tt><tt class="py-op">)</tt> </tt>
<a name="L511"></a><tt class="py-lineno"> 511</tt> <tt class="py-line"> <tt class="py-name">indent_stack</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">bullet_token</tt><tt class="py-op">.</tt><tt class="py-name">indent</tt><tt class="py-op">)</tt> </tt>
<a name="L512"></a><tt class="py-lineno"> 512</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">list_type</tt> <tt class="py-op">==</tt> <tt class="py-string">'olist'</tt><tt class="py-op">:</tt> </tt>
<a name="L513"></a><tt class="py-lineno"> 513</tt> <tt class="py-line"> <tt class="py-name">start</tt> <tt class="py-op">=</tt> <tt class="py-name">bullet_token</tt><tt class="py-op">.</tt><tt class="py-name">contents</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-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="L514"></a><tt class="py-lineno"> 514</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">start</tt> <tt class="py-op">!=</tt> <tt class="py-string">'1'</tt><tt class="py-op">:</tt> </tt>
<a name="L515"></a><tt class="py-lineno"> 515</tt> <tt class="py-line"> <tt class="py-name">lst</tt><tt class="py-op">.</tt><tt class="py-name">attribs</tt><tt class="py-op">[</tt><tt class="py-string">"start"</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">start</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="L516"></a><tt class="py-lineno"> 516</tt> <tt class="py-line"> </tt>
<a name="L517"></a><tt class="py-lineno"> 517</tt> <tt class="py-line"> <tt class="py-comment"># Fields are treated somewhat specially: A "fieldlist"</tt> </tt>
<a name="L518"></a><tt class="py-lineno"> 518</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># node is created to make the parsing simpler, but fields</tt> </tt>
<a name="L519"></a><tt class="py-lineno"> 519</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># are adjoined directly into the "epytext" node, not into</tt> </tt>
<a name="L520"></a><tt class="py-lineno"> 520</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># the "fieldlist" node.</tt> </tt>
<a name="L521"></a><tt class="py-lineno"> 521</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">list_type</tt> <tt class="py-op">==</tt> <tt class="py-string">'fieldlist'</tt><tt class="py-op">:</tt> </tt>
<a name="L522"></a><tt class="py-lineno"> 522</tt> <tt class="py-line"> <tt class="py-name">li</tt> <tt class="py-op">=</tt> <tt id="link-88" class="py-name"><a title="epydoc.markup.epytext.Element" class="py-name" href="#" onclick="return doclink('link-88', 'Element', 'link-30');">Element</a></tt><tt class="py-op">(</tt><tt class="py-string">"field"</tt><tt class="py-op">)</tt> </tt>
<a name="L523"></a><tt class="py-lineno"> 523</tt> <tt class="py-line"> <tt class="py-name">token_words</tt> <tt class="py-op">=</tt> <tt class="py-name">bullet_token</tt><tt class="py-op">.</tt><tt class="py-name">contents</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-name">split</tt><tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
<a name="L524"></a><tt class="py-lineno"> 524</tt> <tt class="py-line"> <tt class="py-name">tag_elt</tt> <tt class="py-op">=</tt> <tt id="link-89" class="py-name"><a title="epydoc.markup.epytext.Element" class="py-name" href="#" onclick="return doclink('link-89', 'Element', 'link-30');">Element</a></tt><tt class="py-op">(</tt><tt class="py-string">"tag"</tt><tt class="py-op">)</tt> </tt>
<a name="L525"></a><tt class="py-lineno"> 525</tt> <tt class="py-line"> <tt class="py-name">tag_elt</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">token_words</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="L526"></a><tt class="py-lineno"> 526</tt> <tt class="py-line"> <tt class="py-name">li</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">tag_elt</tt><tt class="py-op">)</tt> </tt>
<a name="L527"></a><tt class="py-lineno"> 527</tt> <tt class="py-line"> </tt>
<a name="L528"></a><tt class="py-lineno"> 528</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">token_words</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="L529"></a><tt class="py-lineno"> 529</tt> <tt class="py-line"> <tt class="py-name">arg_elt</tt> <tt class="py-op">=</tt> <tt id="link-90" class="py-name"><a title="epydoc.markup.epytext.Element" class="py-name" href="#" onclick="return doclink('link-90', 'Element', 'link-30');">Element</a></tt><tt class="py-op">(</tt><tt class="py-string">"arg"</tt><tt class="py-op">)</tt> </tt>
<a name="L530"></a><tt class="py-lineno"> 530</tt> <tt class="py-line"> <tt class="py-name">arg_elt</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">token_words</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="L531"></a><tt class="py-lineno"> 531</tt> <tt class="py-line"> <tt class="py-name">li</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">arg_elt</tt><tt class="py-op">)</tt> </tt>
<a name="L532"></a><tt class="py-lineno"> 532</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L533"></a><tt class="py-lineno"> 533</tt> <tt class="py-line"> <tt class="py-name">li</tt> <tt class="py-op">=</tt> <tt id="link-91" class="py-name"><a title="epydoc.markup.epytext.Element" class="py-name" href="#" onclick="return doclink('link-91', 'Element', 'link-30');">Element</a></tt><tt class="py-op">(</tt><tt class="py-string">"li"</tt><tt class="py-op">)</tt> </tt>
<a name="L534"></a><tt class="py-lineno"> 534</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">list_type</tt> <tt class="py-op">==</tt> <tt class="py-string">'olist'</tt><tt class="py-op">:</tt> </tt>
<a name="L535"></a><tt class="py-lineno"> 535</tt> <tt class="py-line"> <tt class="py-name">li</tt><tt class="py-op">.</tt><tt class="py-name">attribs</tt><tt class="py-op">[</tt><tt class="py-string">"bullet"</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">bullet_token</tt><tt class="py-op">.</tt><tt class="py-name">contents</tt> </tt>
<a name="L536"></a><tt class="py-lineno"> 536</tt> <tt class="py-line"> </tt>
<a name="L537"></a><tt class="py-lineno"> 537</tt> <tt class="py-line"> <tt class="py-comment"># Add the bullet.</tt> </tt>
<a name="L538"></a><tt class="py-lineno"> 538</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">stack</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">children</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">li</tt><tt class="py-op">)</tt> </tt>
<a name="L539"></a><tt class="py-lineno"> 539</tt> <tt class="py-line"> <tt class="py-name">stack</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">li</tt><tt class="py-op">)</tt> </tt>
<a name="L540"></a><tt class="py-lineno"> 540</tt> <tt class="py-line"> <tt class="py-name">indent_stack</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
</div><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">##################################################</tt> </tt>
<a name="L543"></a><tt class="py-lineno"> 543</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## Tokenization</tt> </tt>
<a name="L544"></a><tt class="py-lineno"> 544</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">##################################################</tt> </tt>
<a name="L545"></a><tt class="py-lineno"> 545</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="Token"></a><div id="Token-def"><a name="L546"></a><tt class="py-lineno"> 546</tt> <a class="py-toggle" href="#" id="Token-toggle" onclick="return toggle('Token');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.markup.epytext.Token-class.html">Token</a><tt class="py-op">:</tt> </tt>
</div><div id="Token-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="Token-expanded"><a name="L547"></a><tt class="py-lineno"> 547</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L548"></a><tt class="py-lineno"> 548</tt> <tt class="py-line"><tt class="py-docstring"> C{Token}s are an intermediate data structure used while</tt> </tt>
<a name="L549"></a><tt class="py-lineno"> 549</tt> <tt class="py-line"><tt class="py-docstring"> constructing the structuring DOM tree for a formatted docstring.</tt> </tt>
<a name="L550"></a><tt class="py-lineno"> 550</tt> <tt class="py-line"><tt class="py-docstring"> There are five types of C{Token}:</tt> </tt>
<a name="L551"></a><tt class="py-lineno"> 551</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L552"></a><tt class="py-lineno"> 552</tt> <tt class="py-line"><tt class="py-docstring"> - Paragraphs</tt> </tt>
<a name="L553"></a><tt class="py-lineno"> 553</tt> <tt class="py-line"><tt class="py-docstring"> - Literal blocks</tt> </tt>
<a name="L554"></a><tt class="py-lineno"> 554</tt> <tt class="py-line"><tt class="py-docstring"> - Doctest blocks</tt> </tt>
<a name="L555"></a><tt class="py-lineno"> 555</tt> <tt class="py-line"><tt class="py-docstring"> - Headings</tt> </tt>
<a name="L556"></a><tt class="py-lineno"> 556</tt> <tt class="py-line"><tt class="py-docstring"> - Bullets</tt> </tt>
<a name="L557"></a><tt class="py-lineno"> 557</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L558"></a><tt class="py-lineno"> 558</tt> <tt class="py-line"><tt class="py-docstring"> The text contained in each C{Token} is stored in the</tt> </tt>
<a name="L559"></a><tt class="py-lineno"> 559</tt> <tt class="py-line"><tt class="py-docstring"> C{contents} variable. The string in this variable has been</tt> </tt>
<a name="L560"></a><tt class="py-lineno"> 560</tt> <tt class="py-line"><tt class="py-docstring"> normalized. For paragraphs, this means that it has been converted </tt> </tt>
<a name="L561"></a><tt class="py-lineno"> 561</tt> <tt class="py-line"><tt class="py-docstring"> into a single line of text, with newline/indentation replaced by</tt> </tt>
<a name="L562"></a><tt class="py-lineno"> 562</tt> <tt class="py-line"><tt class="py-docstring"> single spaces. For literal blocks and doctest blocks, this means</tt> </tt>
<a name="L563"></a><tt class="py-lineno"> 563</tt> <tt class="py-line"><tt class="py-docstring"> that the appropriate amount of leading whitespace has been removed </tt> </tt>
<a name="L564"></a><tt class="py-lineno"> 564</tt> <tt class="py-line"><tt class="py-docstring"> from each line.</tt> </tt>
<a name="L565"></a><tt class="py-lineno"> 565</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L566"></a><tt class="py-lineno"> 566</tt> <tt class="py-line"><tt class="py-docstring"> Each C{Token} has an indentation level associated with it,</tt> </tt>
<a name="L567"></a><tt class="py-lineno"> 567</tt> <tt class="py-line"><tt class="py-docstring"> stored in the C{indent} variable. This indentation level is used</tt> </tt>
<a name="L568"></a><tt class="py-lineno"> 568</tt> <tt class="py-line"><tt class="py-docstring"> by the structuring procedure to assemble hierarchical blocks.</tt> </tt>
<a name="L569"></a><tt class="py-lineno"> 569</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L570"></a><tt class="py-lineno"> 570</tt> <tt class="py-line"><tt class="py-docstring"> @type tag: C{string}</tt> </tt>
<a name="L571"></a><tt class="py-lineno"> 571</tt> <tt class="py-line"><tt class="py-docstring"> @ivar tag: This C{Token}'s type. Possible values are C{Token.PARA} </tt> </tt>
<a name="L572"></a><tt class="py-lineno"> 572</tt> <tt class="py-line"><tt class="py-docstring"> (paragraph), C{Token.LBLOCK} (literal block), C{Token.DTBLOCK}</tt> </tt>
<a name="L573"></a><tt class="py-lineno"> 573</tt> <tt class="py-line"><tt class="py-docstring"> (doctest block), C{Token.HEADINGC}, and C{Token.BULLETC}.</tt> </tt>
<a name="L574"></a><tt class="py-lineno"> 574</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L575"></a><tt class="py-lineno"> 575</tt> <tt class="py-line"><tt class="py-docstring"> @type startline: C{int}</tt> </tt>
<a name="L576"></a><tt class="py-lineno"> 576</tt> <tt class="py-line"><tt class="py-docstring"> @ivar startline: The line on which this C{Token} begins. This </tt> </tt>
<a name="L577"></a><tt class="py-lineno"> 577</tt> <tt class="py-line"><tt class="py-docstring"> line number is only used for issuing errors.</tt> </tt>
<a name="L578"></a><tt class="py-lineno"> 578</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L579"></a><tt class="py-lineno"> 579</tt> <tt class="py-line"><tt class="py-docstring"> @type contents: C{string}</tt> </tt>
<a name="L580"></a><tt class="py-lineno"> 580</tt> <tt class="py-line"><tt class="py-docstring"> @ivar contents: The normalized text contained in this C{Token}.</tt> </tt>
<a name="L581"></a><tt class="py-lineno"> 581</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L582"></a><tt class="py-lineno"> 582</tt> <tt class="py-line"><tt class="py-docstring"> @type indent: C{int} or C{None}</tt> </tt>
<a name="L583"></a><tt class="py-lineno"> 583</tt> <tt class="py-line"><tt class="py-docstring"> @ivar indent: The indentation level of this C{Token} (in</tt> </tt>
<a name="L584"></a><tt class="py-lineno"> 584</tt> <tt class="py-line"><tt class="py-docstring"> number of leading spaces). A value of C{None} indicates an</tt> </tt>
<a name="L585"></a><tt class="py-lineno"> 585</tt> <tt class="py-line"><tt class="py-docstring"> unknown indentation; this is used for list items and fields</tt> </tt>
<a name="L586"></a><tt class="py-lineno"> 586</tt> <tt class="py-line"><tt class="py-docstring"> that begin with one-line paragraphs.</tt> </tt>
<a name="L587"></a><tt class="py-lineno"> 587</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L588"></a><tt class="py-lineno"> 588</tt> <tt class="py-line"><tt class="py-docstring"> @type level: C{int} or C{None}</tt> </tt>
<a name="L589"></a><tt class="py-lineno"> 589</tt> <tt class="py-line"><tt class="py-docstring"> @ivar level: The heading-level of this C{Token} if it is a</tt> </tt>
<a name="L590"></a><tt class="py-lineno"> 590</tt> <tt class="py-line"><tt class="py-docstring"> heading; C{None}, otherwise. Valid heading levels are 0, 1,</tt> </tt>
<a name="L591"></a><tt class="py-lineno"> 591</tt> <tt class="py-line"><tt class="py-docstring"> and 2.</tt> </tt>
<a name="L592"></a><tt class="py-lineno"> 592</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L593"></a><tt class="py-lineno"> 593</tt> <tt class="py-line"><tt class="py-docstring"> @type inline: C{bool}</tt> </tt>
<a name="L594"></a><tt class="py-lineno"> 594</tt> <tt class="py-line"><tt class="py-docstring"> @ivar inline: If True, the element is an inline level element, comparable</tt> </tt>
<a name="L595"></a><tt class="py-lineno"> 595</tt> <tt class="py-line"><tt class="py-docstring"> to an HTML C{<span>} tag. Else, it is a block level element, comparable</tt> </tt>
<a name="L596"></a><tt class="py-lineno"> 596</tt> <tt class="py-line"><tt class="py-docstring"> to an HTML C{<div>}.</tt> </tt>
<a name="L597"></a><tt class="py-lineno"> 597</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L598"></a><tt class="py-lineno"> 598</tt> <tt class="py-line"><tt class="py-docstring"> @type PARA: C{string}</tt> </tt>
<a name="L599"></a><tt class="py-lineno"> 599</tt> <tt class="py-line"><tt class="py-docstring"> @cvar PARA: The C{tag} value for paragraph C{Token}s.</tt> </tt>
<a name="L600"></a><tt class="py-lineno"> 600</tt> <tt class="py-line"><tt class="py-docstring"> @type LBLOCK: C{string}</tt> </tt>
<a name="L601"></a><tt class="py-lineno"> 601</tt> <tt class="py-line"><tt class="py-docstring"> @cvar LBLOCK: The C{tag} value for literal C{Token}s.</tt> </tt>
<a name="L602"></a><tt class="py-lineno"> 602</tt> <tt class="py-line"><tt class="py-docstring"> @type DTBLOCK: C{string}</tt> </tt>
<a name="L603"></a><tt class="py-lineno"> 603</tt> <tt class="py-line"><tt class="py-docstring"> @cvar DTBLOCK: The C{tag} value for doctest C{Token}s.</tt> </tt>
<a name="L604"></a><tt class="py-lineno"> 604</tt> <tt class="py-line"><tt class="py-docstring"> @type HEADING: C{string}</tt> </tt>
<a name="L605"></a><tt class="py-lineno"> 605</tt> <tt class="py-line"><tt class="py-docstring"> @cvar HEADING: The C{tag} value for heading C{Token}s.</tt> </tt>
<a name="L606"></a><tt class="py-lineno"> 606</tt> <tt class="py-line"><tt class="py-docstring"> @type BULLET: C{string}</tt> </tt>
<a name="L607"></a><tt class="py-lineno"> 607</tt> <tt class="py-line"><tt class="py-docstring"> @cvar BULLET: The C{tag} value for bullet C{Token}s. This C{tag}</tt> </tt>
<a name="L608"></a><tt class="py-lineno"> 608</tt> <tt class="py-line"><tt class="py-docstring"> value is also used for field tag C{Token}s, since fields</tt> </tt>
<a name="L609"></a><tt class="py-lineno"> 609</tt> <tt class="py-line"><tt class="py-docstring"> function syntactically the same as list items.</tt> </tt>
<a name="L610"></a><tt class="py-lineno"> 610</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L611"></a><tt class="py-lineno"> 611</tt> <tt class="py-line"> <tt class="py-comment"># The possible token types.</tt> </tt>
<a name="L612"></a><tt class="py-lineno"> 612</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-92" class="py-name"><a title="epydoc.markup.epytext.Token.PARA" class="py-name" href="#" onclick="return doclink('link-92', 'PARA', 'link-34');">PARA</a></tt> <tt class="py-op">=</tt> <tt class="py-string">"para"</tt> </tt>
<a name="L613"></a><tt class="py-lineno"> 613</tt> <tt class="py-line"> <tt id="link-93" class="py-name"><a title="epydoc.markup.epytext.Token.LBLOCK" class="py-name" href="#" onclick="return doclink('link-93', 'LBLOCK', 'link-42');">LBLOCK</a></tt> <tt class="py-op">=</tt> <tt class="py-string">"literalblock"</tt> </tt>
<a name="L614"></a><tt class="py-lineno"> 614</tt> <tt class="py-line"> <tt id="link-94" class="py-name"><a title="epydoc.markup.epytext.Token.DTBLOCK" class="py-name" href="#" onclick="return doclink('link-94', 'DTBLOCK', 'link-46');">DTBLOCK</a></tt> <tt class="py-op">=</tt> <tt class="py-string">"doctestblock"</tt> </tt>
<a name="L615"></a><tt class="py-lineno"> 615</tt> <tt class="py-line"> <tt id="link-95" class="py-name"><a title="epydoc.markup.epytext.Token.HEADING" class="py-name" href="#" onclick="return doclink('link-95', 'HEADING', 'link-38');">HEADING</a></tt> <tt class="py-op">=</tt> <tt class="py-string">"heading"</tt> </tt>
<a name="L616"></a><tt class="py-lineno"> 616</tt> <tt class="py-line"> <tt id="link-96" class="py-name"><a title="epydoc.markup.epytext.Token.BULLET" class="py-name" href="#" onclick="return doclink('link-96', 'BULLET', 'link-50');">BULLET</a></tt> <tt class="py-op">=</tt> <tt class="py-string">"bullet"</tt> </tt>
<a name="L617"></a><tt class="py-lineno"> 617</tt> <tt class="py-line"> </tt>
<a name="Token.__init__"></a><div id="Token.__init__-def"><a name="L618"></a><tt class="py-lineno"> 618</tt> <a class="py-toggle" href="#" id="Token.__init__-toggle" onclick="return toggle('Token.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext.Token-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">tag</tt><tt class="py-op">,</tt> <tt class="py-param">startline</tt><tt class="py-op">,</tt> <tt class="py-param">contents</tt><tt class="py-op">,</tt> <tt class="py-param">indent</tt><tt class="py-op">,</tt> <tt class="py-param">level</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
<a name="L619"></a><tt class="py-lineno"> 619</tt> <tt class="py-line"> <tt class="py-param">inline</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="Token.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Token.__init__-expanded"><a name="L620"></a><tt class="py-lineno"> 620</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L621"></a><tt class="py-lineno"> 621</tt> <tt class="py-line"><tt class="py-docstring"> Create a new C{Token}.</tt> </tt>
<a name="L622"></a><tt class="py-lineno"> 622</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L623"></a><tt class="py-lineno"> 623</tt> <tt class="py-line"><tt class="py-docstring"> @param tag: The type of the new C{Token}.</tt> </tt>
<a name="L624"></a><tt class="py-lineno"> 624</tt> <tt class="py-line"><tt class="py-docstring"> @type tag: C{string}</tt> </tt>
<a name="L625"></a><tt class="py-lineno"> 625</tt> <tt class="py-line"><tt class="py-docstring"> @param startline: The line on which the new C{Token} begins.</tt> </tt>
<a name="L626"></a><tt class="py-lineno"> 626</tt> <tt class="py-line"><tt class="py-docstring"> @type startline: C{int}</tt> </tt>
<a name="L627"></a><tt class="py-lineno"> 627</tt> <tt class="py-line"><tt class="py-docstring"> @param contents: The normalized contents of the new C{Token}.</tt> </tt>
<a name="L628"></a><tt class="py-lineno"> 628</tt> <tt class="py-line"><tt class="py-docstring"> @type contents: C{string}</tt> </tt>
<a name="L629"></a><tt class="py-lineno"> 629</tt> <tt class="py-line"><tt class="py-docstring"> @param indent: The indentation of the new C{Token} (in number</tt> </tt>
<a name="L630"></a><tt class="py-lineno"> 630</tt> <tt class="py-line"><tt class="py-docstring"> of leading spaces). A value of C{None} indicates an</tt> </tt>
<a name="L631"></a><tt class="py-lineno"> 631</tt> <tt class="py-line"><tt class="py-docstring"> unknown indentation.</tt> </tt>
<a name="L632"></a><tt class="py-lineno"> 632</tt> <tt class="py-line"><tt class="py-docstring"> @type indent: C{int} or C{None}</tt> </tt>
<a name="L633"></a><tt class="py-lineno"> 633</tt> <tt class="py-line"><tt class="py-docstring"> @param level: The heading-level of this C{Token} if it is a</tt> </tt>
<a name="L634"></a><tt class="py-lineno"> 634</tt> <tt class="py-line"><tt class="py-docstring"> heading; C{None}, otherwise.</tt> </tt>
<a name="L635"></a><tt class="py-lineno"> 635</tt> <tt class="py-line"><tt class="py-docstring"> @type level: C{int} or C{None}</tt> </tt>
<a name="L636"></a><tt class="py-lineno"> 636</tt> <tt class="py-line"><tt class="py-docstring"> @param inline: Is this C{Token} inline as a C{<span>}?.</tt> </tt>
<a name="L637"></a><tt class="py-lineno"> 637</tt> <tt class="py-line"><tt class="py-docstring"> @type inline: C{bool}</tt> </tt>
<a name="L638"></a><tt class="py-lineno"> 638</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L639"></a><tt class="py-lineno"> 639</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-97" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-97', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">=</tt> <tt id="link-98" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-98', 'tag', 'link-13');">tag</a></tt> </tt>
<a name="L640"></a><tt class="py-lineno"> 640</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">startline</tt> <tt class="py-op">=</tt> <tt class="py-name">startline</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 class="py-name">contents</tt> <tt class="py-op">=</tt> <tt class="py-name">contents</tt> </tt>
<a name="L642"></a><tt class="py-lineno"> 642</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">indent</tt> <tt class="py-op">=</tt> <tt class="py-name">indent</tt> </tt>
<a name="L643"></a><tt class="py-lineno"> 643</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">level</tt> <tt class="py-op">=</tt> <tt class="py-name">level</tt> </tt>
<a name="L644"></a><tt class="py-lineno"> 644</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">inline</tt> <tt class="py-op">=</tt> <tt class="py-name">inline</tt> </tt>
</div><a name="L645"></a><tt class="py-lineno"> 645</tt> <tt class="py-line"> </tt>
<a name="Token.__repr__"></a><div id="Token.__repr__-def"><a name="L646"></a><tt class="py-lineno"> 646</tt> <a class="py-toggle" href="#" id="Token.__repr__-toggle" onclick="return toggle('Token.__repr__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext.Token-class.html#__repr__">__repr__</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="Token.__repr__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Token.__repr__-expanded"><a name="L647"></a><tt class="py-lineno"> 647</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L648"></a><tt class="py-lineno"> 648</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{string}</tt> </tt>
<a name="L649"></a><tt class="py-lineno"> 649</tt> <tt class="py-line"><tt class="py-docstring"> @return: the formal representation of this C{Token}.</tt> </tt>
<a name="L650"></a><tt class="py-lineno"> 650</tt> <tt class="py-line"><tt class="py-docstring"> C{Token}s have formal representaitons of the form:: </tt> </tt>
<a name="L651"></a><tt class="py-lineno"> 651</tt> <tt class="py-line"><tt class="py-docstring"> <Token: para at line 12></tt> </tt>
<a name="L652"></a><tt class="py-lineno"> 652</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L653"></a><tt class="py-lineno"> 653</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'<Token: %s at line %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-99" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-99', 'tag', 'link-13');">tag</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">startline</tt><tt class="py-op">)</tt> </tt>
</div><a name="L654"></a><tt class="py-lineno"> 654</tt> <tt class="py-line"> </tt>
<a name="Token.to_dom"></a><div id="Token.to_dom-def"><a name="L655"></a><tt class="py-lineno"> 655</tt> <a class="py-toggle" href="#" id="Token.to_dom-toggle" onclick="return toggle('Token.to_dom');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext.Token-class.html#to_dom">to_dom</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="Token.to_dom-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Token.to_dom-expanded"><a name="L656"></a><tt class="py-lineno"> 656</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L657"></a><tt class="py-lineno"> 657</tt> <tt class="py-line"><tt class="py-docstring"> @return: a DOM representation of this C{Token}.</tt> </tt>
<a name="L658"></a><tt class="py-lineno"> 658</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: L{Element}</tt> </tt>
<a name="L659"></a><tt class="py-lineno"> 659</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L660"></a><tt class="py-lineno"> 660</tt> <tt class="py-line"> <tt class="py-name">e</tt> <tt class="py-op">=</tt> <tt id="link-100" class="py-name"><a title="epydoc.markup.epytext.Element" class="py-name" href="#" onclick="return doclink('link-100', 'Element', 'link-30');">Element</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-101" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-101', 'tag', 'link-13');">tag</a></tt><tt class="py-op">)</tt> </tt>
<a name="L661"></a><tt class="py-lineno"> 661</tt> <tt class="py-line"> <tt class="py-name">e</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">contents</tt><tt class="py-op">)</tt> </tt>
<a name="L662"></a><tt class="py-lineno"> 662</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">e</tt> </tt>
</div></div><a name="L663"></a><tt class="py-lineno"> 663</tt> <tt class="py-line"> </tt>
<a name="L664"></a><tt class="py-lineno"> 664</tt> <tt class="py-line"><tt class="py-comment"># Construct regular expressions for recognizing bullets. These are</tt> </tt>
<a name="L665"></a><tt class="py-lineno"> 665</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># global so they don't have to be reconstructed each time we tokenize</tt> </tt>
<a name="L666"></a><tt class="py-lineno"> 666</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># a docstring.</tt> </tt>
<a name="L667"></a><tt class="py-lineno"> 667</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-name">_ULIST_BULLET</tt> <tt class="py-op">=</tt> <tt class="py-string">'[-]( +|$)'</tt> </tt>
<a name="L668"></a><tt class="py-lineno"> 668</tt> <tt class="py-line"><tt class="py-name">_OLIST_BULLET</tt> <tt class="py-op">=</tt> <tt class="py-string">'(\d+[.])+( +|$)'</tt> </tt>
<a name="L669"></a><tt class="py-lineno"> 669</tt> <tt class="py-line"><tt class="py-name">_FIELD_BULLET</tt> <tt class="py-op">=</tt> <tt class="py-string">'@\w+( [^{}:\n]+)?:'</tt> </tt>
<a name="L670"></a><tt class="py-lineno"> 670</tt> <tt class="py-line"><tt id="link-102" class="py-name" targets="Variable epydoc.markup.epytext._BULLET_RE=epydoc.markup.epytext-module.html#_BULLET_RE"><a title="epydoc.markup.epytext._BULLET_RE" class="py-name" href="#" onclick="return doclink('link-102', '_BULLET_RE', 'link-102');">_BULLET_RE</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-name">_ULIST_BULLET</tt> <tt class="py-op">+</tt> <tt class="py-string">'|'</tt> <tt class="py-op">+</tt> </tt>
<a name="L671"></a><tt class="py-lineno"> 671</tt> <tt class="py-line"> <tt class="py-name">_OLIST_BULLET</tt> <tt class="py-op">+</tt> <tt class="py-string">'|'</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">_FIELD_BULLET</tt><tt class="py-op">)</tt> </tt>
<a name="L673"></a><tt class="py-lineno"> 673</tt> <tt class="py-line"><tt id="link-103" class="py-name" targets="Variable epydoc.markup.epytext._LIST_BULLET_RE=epydoc.markup.epytext-module.html#_LIST_BULLET_RE"><a title="epydoc.markup.epytext._LIST_BULLET_RE" class="py-name" href="#" onclick="return doclink('link-103', '_LIST_BULLET_RE', 'link-103');">_LIST_BULLET_RE</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-name">_ULIST_BULLET</tt> <tt class="py-op">+</tt> <tt class="py-string">'|'</tt> <tt class="py-op">+</tt> <tt class="py-name">_OLIST_BULLET</tt><tt class="py-op">)</tt> </tt>
<a name="L674"></a><tt class="py-lineno"> 674</tt> <tt class="py-line"><tt id="link-104" class="py-name" targets="Variable epydoc.markup.epytext._FIELD_BULLET_RE=epydoc.markup.epytext-module.html#_FIELD_BULLET_RE"><a title="epydoc.markup.epytext._FIELD_BULLET_RE" class="py-name" href="#" onclick="return doclink('link-104', '_FIELD_BULLET_RE', 'link-104');">_FIELD_BULLET_RE</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-name">_FIELD_BULLET</tt><tt class="py-op">)</tt> </tt>
<a name="L675"></a><tt class="py-lineno"> 675</tt> <tt class="py-line"><tt class="py-keyword">del</tt> <tt class="py-name">_ULIST_BULLET</tt><tt class="py-op">,</tt> <tt class="py-name">_OLIST_BULLET</tt><tt class="py-op">,</tt> <tt class="py-name">_FIELD_BULLET</tt> </tt>
<a name="L676"></a><tt class="py-lineno"> 676</tt> <tt class="py-line"> </tt>
<a name="_tokenize_doctest"></a><div id="_tokenize_doctest-def"><a name="L677"></a><tt class="py-lineno"> 677</tt> <a class="py-toggle" href="#" id="_tokenize_doctest-toggle" onclick="return toggle('_tokenize_doctest');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext-module.html#_tokenize_doctest">_tokenize_doctest</a><tt class="py-op">(</tt><tt class="py-param">lines</tt><tt class="py-op">,</tt> <tt class="py-param">start</tt><tt class="py-op">,</tt> <tt class="py-param">block_indent</tt><tt class="py-op">,</tt> <tt class="py-param">tokens</tt><tt class="py-op">,</tt> <tt class="py-param">errors</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_tokenize_doctest-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_tokenize_doctest-expanded"><a name="L678"></a><tt class="py-lineno"> 678</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L679"></a><tt class="py-lineno"> 679</tt> <tt class="py-line"><tt class="py-docstring"> Construct a L{Token} containing the doctest block starting at</tt> </tt>
<a name="L680"></a><tt class="py-lineno"> 680</tt> <tt class="py-line"><tt class="py-docstring"> C{lines[start]}, and append it to C{tokens}. C{block_indent}</tt> </tt>
<a name="L681"></a><tt class="py-lineno"> 681</tt> <tt class="py-line"><tt class="py-docstring"> should be the indentation of the doctest block. Any errors</tt> </tt>
<a name="L682"></a><tt class="py-lineno"> 682</tt> <tt class="py-line"><tt class="py-docstring"> generated while tokenizing the doctest block will be appended to</tt> </tt>
<a name="L683"></a><tt class="py-lineno"> 683</tt> <tt class="py-line"><tt class="py-docstring"> C{errors}.</tt> </tt>
<a name="L684"></a><tt class="py-lineno"> 684</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L685"></a><tt class="py-lineno"> 685</tt> <tt class="py-line"><tt class="py-docstring"> @param lines: The list of lines to be tokenized</tt> </tt>
<a name="L686"></a><tt class="py-lineno"> 686</tt> <tt class="py-line"><tt class="py-docstring"> @param start: The index into C{lines} of the first line of the</tt> </tt>
<a name="L687"></a><tt class="py-lineno"> 687</tt> <tt class="py-line"><tt class="py-docstring"> doctest block to be tokenized.</tt> </tt>
<a name="L688"></a><tt class="py-lineno"> 688</tt> <tt class="py-line"><tt class="py-docstring"> @param block_indent: The indentation of C{lines[start]}. This is</tt> </tt>
<a name="L689"></a><tt class="py-lineno"> 689</tt> <tt class="py-line"><tt class="py-docstring"> the indentation of the doctest block.</tt> </tt>
<a name="L690"></a><tt class="py-lineno"> 690</tt> <tt class="py-line"><tt class="py-docstring"> @param errors: A list where any errors generated during parsing</tt> </tt>
<a name="L691"></a><tt class="py-lineno"> 691</tt> <tt class="py-line"><tt class="py-docstring"> will be stored. If no list is specified, then errors will </tt> </tt>
<a name="L692"></a><tt class="py-lineno"> 692</tt> <tt class="py-line"><tt class="py-docstring"> generate exceptions.</tt> </tt>
<a name="L693"></a><tt class="py-lineno"> 693</tt> <tt class="py-line"><tt class="py-docstring"> @return: The line number of the first line following the doctest</tt> </tt>
<a name="L694"></a><tt class="py-lineno"> 694</tt> <tt class="py-line"><tt class="py-docstring"> block.</tt> </tt>
<a name="L695"></a><tt class="py-lineno"> 695</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L696"></a><tt class="py-lineno"> 696</tt> <tt class="py-line"><tt class="py-docstring"> @type lines: C{list} of C{string}</tt> </tt>
<a name="L697"></a><tt class="py-lineno"> 697</tt> <tt class="py-line"><tt class="py-docstring"> @type start: C{int}</tt> </tt>
<a name="L698"></a><tt class="py-lineno"> 698</tt> <tt class="py-line"><tt class="py-docstring"> @type block_indent: C{int}</tt> </tt>
<a name="L699"></a><tt class="py-lineno"> 699</tt> <tt class="py-line"><tt class="py-docstring"> @type tokens: C{list} of L{Token}</tt> </tt>
<a name="L700"></a><tt class="py-lineno"> 700</tt> <tt class="py-line"><tt class="py-docstring"> @type errors: C{list} of L{ParseError}</tt> </tt>
<a name="L701"></a><tt class="py-lineno"> 701</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{int}</tt> </tt>
<a name="L702"></a><tt class="py-lineno"> 702</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L703"></a><tt class="py-lineno"> 703</tt> <tt class="py-line"> <tt class="py-comment"># If they dedent past block_indent, keep track of the minimum</tt> </tt>
<a name="L704"></a><tt class="py-lineno"> 704</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># indentation. This is used when removing leading indentation</tt> </tt>
<a name="L705"></a><tt class="py-lineno"> 705</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># from the lines of the doctest block.</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">min_indent</tt> <tt class="py-op">=</tt> <tt class="py-name">block_indent</tt> </tt>
<a name="L707"></a><tt class="py-lineno"> 707</tt> <tt class="py-line"> </tt>
<a name="L708"></a><tt class="py-lineno"> 708</tt> <tt class="py-line"> <tt id="link-105" class="py-name" targets="Method epydoc.markup.ParseError.linenum()=epydoc.markup.ParseError-class.html#linenum"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-105', 'linenum', 'link-105');">linenum</a></tt> <tt class="py-op">=</tt> <tt class="py-name">start</tt> <tt class="py-op">+</tt> <tt class="py-number">1</tt> </tt>
<a name="L709"></a><tt class="py-lineno"> 709</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt id="link-106" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-106', 'linenum', 'link-105');">linenum</a></tt> <tt class="py-op"><</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">lines</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L710"></a><tt class="py-lineno"> 710</tt> <tt class="py-line"> <tt class="py-comment"># Find the indentation of this line.</tt> </tt>
<a name="L711"></a><tt class="py-lineno"> 711</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">line</tt> <tt class="py-op">=</tt> <tt class="py-name">lines</tt><tt class="py-op">[</tt><tt id="link-107" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-107', 'linenum', 'link-105');">linenum</a></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">indent</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">line</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>
<a name="L713"></a><tt class="py-lineno"> 713</tt> <tt class="py-line"> </tt>
<a name="L714"></a><tt class="py-lineno"> 714</tt> <tt class="py-line"> <tt class="py-comment"># A blank line ends doctest block.</tt> </tt>
<a name="L715"></a><tt class="py-lineno"> 715</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</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">line</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">break</tt> </tt>
<a name="L716"></a><tt class="py-lineno"> 716</tt> <tt class="py-line"> </tt>
<a name="L717"></a><tt class="py-lineno"> 717</tt> <tt class="py-line"> <tt class="py-comment"># A Dedent past block_indent is an error.</tt> </tt>
<a name="L718"></a><tt class="py-lineno"> 718</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">indent</tt> <tt class="py-op"><</tt> <tt class="py-name">block_indent</tt><tt class="py-op">:</tt> </tt>
<a name="L719"></a><tt class="py-lineno"> 719</tt> <tt class="py-line"> <tt class="py-name">min_indent</tt> <tt class="py-op">=</tt> <tt class="py-name">min</tt><tt class="py-op">(</tt><tt class="py-name">min_indent</tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">)</tt> </tt>
<a name="L720"></a><tt class="py-lineno"> 720</tt> <tt class="py-line"> <tt class="py-name">estr</tt> <tt class="py-op">=</tt> <tt class="py-string">'Improper doctest block indentation.'</tt> </tt>
<a name="L721"></a><tt class="py-lineno"> 721</tt> <tt class="py-line"> <tt class="py-name">errors</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-108" class="py-name" targets="Class epydoc.markup.epytext.TokenizationError=epydoc.markup.epytext.TokenizationError-class.html"><a title="epydoc.markup.epytext.TokenizationError" class="py-name" href="#" onclick="return doclink('link-108', 'TokenizationError', 'link-108');">TokenizationError</a></tt><tt class="py-op">(</tt><tt class="py-name">estr</tt><tt class="py-op">,</tt> <tt id="link-109" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-109', 'linenum', 'link-105');">linenum</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L722"></a><tt class="py-lineno"> 722</tt> <tt class="py-line"> </tt>
<a name="L723"></a><tt class="py-lineno"> 723</tt> <tt class="py-line"> <tt class="py-comment"># Go on to the next line.</tt> </tt>
<a name="L724"></a><tt class="py-lineno"> 724</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-110" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-110', 'linenum', 'link-105');">linenum</a></tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L725"></a><tt class="py-lineno"> 725</tt> <tt class="py-line"> </tt>
<a name="L726"></a><tt class="py-lineno"> 726</tt> <tt class="py-line"> <tt class="py-comment"># Add the token, and return the linenum after the token ends.</tt> </tt>
<a name="L727"></a><tt class="py-lineno"> 727</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">contents</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">line</tt><tt class="py-op">[</tt><tt class="py-name">min_indent</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> <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 class="py-name">start</tt><tt class="py-op">:</tt><tt id="link-111" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-111', 'linenum', 'link-105');">linenum</a></tt><tt class="py-op">]</tt><tt class="py-op">]</tt> </tt>
<a name="L728"></a><tt class="py-lineno"> 728</tt> <tt class="py-line"> <tt class="py-name">contents</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">contents</tt><tt class="py-op">)</tt> </tt>
<a name="L729"></a><tt class="py-lineno"> 729</tt> <tt class="py-line"> <tt class="py-name">tokens</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-112" class="py-name"><a title="epydoc.markup.epytext.Token" class="py-name" href="#" onclick="return doclink('link-112', 'Token', 'link-33');">Token</a></tt><tt class="py-op">(</tt><tt id="link-113" class="py-name"><a title="epydoc.markup.epytext.Token" class="py-name" href="#" onclick="return doclink('link-113', 'Token', 'link-33');">Token</a></tt><tt class="py-op">.</tt><tt id="link-114" class="py-name"><a title="epydoc.markup.epytext.Token.DTBLOCK" class="py-name" href="#" onclick="return doclink('link-114', 'DTBLOCK', 'link-46');">DTBLOCK</a></tt><tt class="py-op">,</tt> <tt class="py-name">start</tt><tt class="py-op">,</tt> <tt class="py-name">contents</tt><tt class="py-op">,</tt> <tt class="py-name">block_indent</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L730"></a><tt class="py-lineno"> 730</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-115" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-115', 'linenum', 'link-105');">linenum</a></tt> </tt>
</div><a name="L731"></a><tt class="py-lineno"> 731</tt> <tt class="py-line"> </tt>
<a name="_tokenize_literal"></a><div id="_tokenize_literal-def"><a name="L732"></a><tt class="py-lineno"> 732</tt> <a class="py-toggle" href="#" id="_tokenize_literal-toggle" onclick="return toggle('_tokenize_literal');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext-module.html#_tokenize_literal">_tokenize_literal</a><tt class="py-op">(</tt><tt class="py-param">lines</tt><tt class="py-op">,</tt> <tt class="py-param">start</tt><tt class="py-op">,</tt> <tt class="py-param">block_indent</tt><tt class="py-op">,</tt> <tt class="py-param">tokens</tt><tt class="py-op">,</tt> <tt class="py-param">errors</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_tokenize_literal-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_tokenize_literal-expanded"><a name="L733"></a><tt class="py-lineno"> 733</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L734"></a><tt class="py-lineno"> 734</tt> <tt class="py-line"><tt class="py-docstring"> Construct a L{Token} containing the literal block starting at</tt> </tt>
<a name="L735"></a><tt class="py-lineno"> 735</tt> <tt class="py-line"><tt class="py-docstring"> C{lines[start]}, and append it to C{tokens}. C{block_indent}</tt> </tt>
<a name="L736"></a><tt class="py-lineno"> 736</tt> <tt class="py-line"><tt class="py-docstring"> should be the indentation of the literal block. Any errors</tt> </tt>
<a name="L737"></a><tt class="py-lineno"> 737</tt> <tt class="py-line"><tt class="py-docstring"> generated while tokenizing the literal block will be appended to</tt> </tt>
<a name="L738"></a><tt class="py-lineno"> 738</tt> <tt class="py-line"><tt class="py-docstring"> C{errors}.</tt> </tt>
<a name="L739"></a><tt class="py-lineno"> 739</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L740"></a><tt class="py-lineno"> 740</tt> <tt class="py-line"><tt class="py-docstring"> @param lines: The list of lines to be tokenized</tt> </tt>
<a name="L741"></a><tt class="py-lineno"> 741</tt> <tt class="py-line"><tt class="py-docstring"> @param start: The index into C{lines} of the first line of the</tt> </tt>
<a name="L742"></a><tt class="py-lineno"> 742</tt> <tt class="py-line"><tt class="py-docstring"> literal block to be tokenized.</tt> </tt>
<a name="L743"></a><tt class="py-lineno"> 743</tt> <tt class="py-line"><tt class="py-docstring"> @param block_indent: The indentation of C{lines[start]}. This is</tt> </tt>
<a name="L744"></a><tt class="py-lineno"> 744</tt> <tt class="py-line"><tt class="py-docstring"> the indentation of the literal block.</tt> </tt>
<a name="L745"></a><tt class="py-lineno"> 745</tt> <tt class="py-line"><tt class="py-docstring"> @param errors: A list of the errors generated by parsing. Any</tt> </tt>
<a name="L746"></a><tt class="py-lineno"> 746</tt> <tt class="py-line"><tt class="py-docstring"> new errors generated while will tokenizing this paragraph</tt> </tt>
<a name="L747"></a><tt class="py-lineno"> 747</tt> <tt class="py-line"><tt class="py-docstring"> will be appended to this list.</tt> </tt>
<a name="L748"></a><tt class="py-lineno"> 748</tt> <tt class="py-line"><tt class="py-docstring"> @return: The line number of the first line following the literal</tt> </tt>
<a name="L749"></a><tt class="py-lineno"> 749</tt> <tt class="py-line"><tt class="py-docstring"> block. </tt> </tt>
<a name="L750"></a><tt class="py-lineno"> 750</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L751"></a><tt class="py-lineno"> 751</tt> <tt class="py-line"><tt class="py-docstring"> @type lines: C{list} of C{string}</tt> </tt>
<a name="L752"></a><tt class="py-lineno"> 752</tt> <tt class="py-line"><tt class="py-docstring"> @type start: C{int}</tt> </tt>
<a name="L753"></a><tt class="py-lineno"> 753</tt> <tt class="py-line"><tt class="py-docstring"> @type block_indent: C{int}</tt> </tt>
<a name="L754"></a><tt class="py-lineno"> 754</tt> <tt class="py-line"><tt class="py-docstring"> @type tokens: C{list} of L{Token}</tt> </tt>
<a name="L755"></a><tt class="py-lineno"> 755</tt> <tt class="py-line"><tt class="py-docstring"> @type errors: C{list} of L{ParseError}</tt> </tt>
<a name="L756"></a><tt class="py-lineno"> 756</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{int}</tt> </tt>
<a name="L757"></a><tt class="py-lineno"> 757</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L758"></a><tt class="py-lineno"> 758</tt> <tt class="py-line"> <tt id="link-116" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-116', 'linenum', 'link-105');">linenum</a></tt> <tt class="py-op">=</tt> <tt class="py-name">start</tt> <tt class="py-op">+</tt> <tt class="py-number">1</tt> </tt>
<a name="L759"></a><tt class="py-lineno"> 759</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt id="link-117" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-117', 'linenum', 'link-105');">linenum</a></tt> <tt class="py-op"><</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">lines</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L760"></a><tt class="py-lineno"> 760</tt> <tt class="py-line"> <tt class="py-comment"># Find the indentation of this line.</tt> </tt>
<a name="L761"></a><tt class="py-lineno"> 761</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">line</tt> <tt class="py-op">=</tt> <tt class="py-name">lines</tt><tt class="py-op">[</tt><tt id="link-118" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-118', 'linenum', 'link-105');">linenum</a></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">indent</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">line</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>
<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"># A Dedent to block_indent ends the literal block.</tt> </tt>
<a name="L765"></a><tt class="py-lineno"> 765</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># (Ignore blank likes, though)</tt> </tt>
<a name="L766"></a><tt class="py-lineno"> 766</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</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">indent</tt> <tt class="py-keyword">and</tt> <tt class="py-name">indent</tt> <tt class="py-op"><=</tt> <tt class="py-name">block_indent</tt><tt class="py-op">:</tt> </tt>
<a name="L767"></a><tt class="py-lineno"> 767</tt> <tt class="py-line"> <tt class="py-keyword">break</tt> </tt>
<a name="L768"></a><tt class="py-lineno"> 768</tt> <tt class="py-line"> </tt>
<a name="L769"></a><tt class="py-lineno"> 769</tt> <tt class="py-line"> <tt class="py-comment"># Go on to the next line.</tt> </tt>
<a name="L770"></a><tt class="py-lineno"> 770</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-119" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-119', 'linenum', 'link-105');">linenum</a></tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L771"></a><tt class="py-lineno"> 771</tt> <tt class="py-line"> </tt>
<a name="L772"></a><tt class="py-lineno"> 772</tt> <tt class="py-line"> <tt class="py-comment"># Add the token, and return the linenum after the token ends.</tt> </tt>
<a name="L773"></a><tt class="py-lineno"> 773</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">contents</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">line</tt><tt class="py-op">[</tt><tt class="py-name">block_indent</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-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 class="py-name">start</tt><tt class="py-op">:</tt><tt id="link-120" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-120', 'linenum', 'link-105');">linenum</a></tt><tt class="py-op">]</tt><tt class="py-op">]</tt> </tt>
<a name="L774"></a><tt class="py-lineno"> 774</tt> <tt class="py-line"> <tt class="py-name">contents</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">contents</tt><tt class="py-op">)</tt> </tt>
<a name="L775"></a><tt class="py-lineno"> 775</tt> <tt class="py-line"> <tt class="py-name">contents</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[ \n]*\n)|(\n[ \n]*\Z)'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">,</tt> <tt class="py-name">contents</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">tokens</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-121" class="py-name"><a title="epydoc.markup.epytext.Token" class="py-name" href="#" onclick="return doclink('link-121', 'Token', 'link-33');">Token</a></tt><tt class="py-op">(</tt><tt id="link-122" class="py-name"><a title="epydoc.markup.epytext.Token" class="py-name" href="#" onclick="return doclink('link-122', 'Token', 'link-33');">Token</a></tt><tt class="py-op">.</tt><tt id="link-123" class="py-name"><a title="epydoc.markup.epytext.Token.LBLOCK" class="py-name" href="#" onclick="return doclink('link-123', 'LBLOCK', 'link-42');">LBLOCK</a></tt><tt class="py-op">,</tt> <tt class="py-name">start</tt><tt class="py-op">,</tt> <tt class="py-name">contents</tt><tt class="py-op">,</tt> <tt class="py-name">block_indent</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L777"></a><tt class="py-lineno"> 777</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-124" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-124', 'linenum', 'link-105');">linenum</a></tt> </tt>
</div><a name="L778"></a><tt class="py-lineno"> 778</tt> <tt class="py-line"> </tt>
<a name="_tokenize_listart"></a><div id="_tokenize_listart-def"><a name="L779"></a><tt class="py-lineno"> 779</tt> <a class="py-toggle" href="#" id="_tokenize_listart-toggle" onclick="return toggle('_tokenize_listart');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext-module.html#_tokenize_listart">_tokenize_listart</a><tt class="py-op">(</tt><tt class="py-param">lines</tt><tt class="py-op">,</tt> <tt class="py-param">start</tt><tt class="py-op">,</tt> <tt class="py-param">bullet_indent</tt><tt class="py-op">,</tt> <tt class="py-param">tokens</tt><tt class="py-op">,</tt> <tt class="py-param">errors</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_tokenize_listart-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_tokenize_listart-expanded"><a name="L780"></a><tt class="py-lineno"> 780</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L781"></a><tt class="py-lineno"> 781</tt> <tt class="py-line"><tt class="py-docstring"> Construct L{Token}s for the bullet and the first paragraph of the</tt> </tt>
<a name="L782"></a><tt class="py-lineno"> 782</tt> <tt class="py-line"><tt class="py-docstring"> list item (or field) starting at C{lines[start]}, and append them</tt> </tt>
<a name="L783"></a><tt class="py-lineno"> 783</tt> <tt class="py-line"><tt class="py-docstring"> to C{tokens}. C{bullet_indent} should be the indentation of the</tt> </tt>
<a name="L784"></a><tt class="py-lineno"> 784</tt> <tt class="py-line"><tt class="py-docstring"> list item. Any errors generated while tokenizing will be</tt> </tt>
<a name="L785"></a><tt class="py-lineno"> 785</tt> <tt class="py-line"><tt class="py-docstring"> appended to C{errors}.</tt> </tt>
<a name="L786"></a><tt class="py-lineno"> 786</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L787"></a><tt class="py-lineno"> 787</tt> <tt class="py-line"><tt class="py-docstring"> @param lines: The list of lines to be tokenized</tt> </tt>
<a name="L788"></a><tt class="py-lineno"> 788</tt> <tt class="py-line"><tt class="py-docstring"> @param start: The index into C{lines} of the first line of the</tt> </tt>
<a name="L789"></a><tt class="py-lineno"> 789</tt> <tt class="py-line"><tt class="py-docstring"> list item to be tokenized.</tt> </tt>
<a name="L790"></a><tt class="py-lineno"> 790</tt> <tt class="py-line"><tt class="py-docstring"> @param bullet_indent: The indentation of C{lines[start]}. This is</tt> </tt>
<a name="L791"></a><tt class="py-lineno"> 791</tt> <tt class="py-line"><tt class="py-docstring"> the indentation of the list item.</tt> </tt>
<a name="L792"></a><tt class="py-lineno"> 792</tt> <tt class="py-line"><tt class="py-docstring"> @param errors: A list of the errors generated by parsing. Any</tt> </tt>
<a name="L793"></a><tt class="py-lineno"> 793</tt> <tt class="py-line"><tt class="py-docstring"> new errors generated while will tokenizing this paragraph</tt> </tt>
<a name="L794"></a><tt class="py-lineno"> 794</tt> <tt class="py-line"><tt class="py-docstring"> will be appended to this list.</tt> </tt>
<a name="L795"></a><tt class="py-lineno"> 795</tt> <tt class="py-line"><tt class="py-docstring"> @return: The line number of the first line following the list</tt> </tt>
<a name="L796"></a><tt class="py-lineno"> 796</tt> <tt class="py-line"><tt class="py-docstring"> item's first paragraph.</tt> </tt>
<a name="L797"></a><tt class="py-lineno"> 797</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L798"></a><tt class="py-lineno"> 798</tt> <tt class="py-line"><tt class="py-docstring"> @type lines: C{list} of C{string}</tt> </tt>
<a name="L799"></a><tt class="py-lineno"> 799</tt> <tt class="py-line"><tt class="py-docstring"> @type start: C{int}</tt> </tt>
<a name="L800"></a><tt class="py-lineno"> 800</tt> <tt class="py-line"><tt class="py-docstring"> @type bullet_indent: C{int}</tt> </tt>
<a name="L801"></a><tt class="py-lineno"> 801</tt> <tt class="py-line"><tt class="py-docstring"> @type tokens: C{list} of L{Token}</tt> </tt>
<a name="L802"></a><tt class="py-lineno"> 802</tt> <tt class="py-line"><tt class="py-docstring"> @type errors: C{list} of L{ParseError}</tt> </tt>
<a name="L803"></a><tt class="py-lineno"> 803</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{int}</tt> </tt>
<a name="L804"></a><tt class="py-lineno"> 804</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L805"></a><tt class="py-lineno"> 805</tt> <tt class="py-line"> <tt id="link-125" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-125', 'linenum', 'link-105');">linenum</a></tt> <tt class="py-op">=</tt> <tt class="py-name">start</tt> <tt class="py-op">+</tt> <tt class="py-number">1</tt> </tt>
<a name="L806"></a><tt class="py-lineno"> 806</tt> <tt class="py-line"> <tt class="py-name">para_indent</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L807"></a><tt class="py-lineno"> 807</tt> <tt class="py-line"> <tt class="py-name">doublecolon</tt> <tt class="py-op">=</tt> <tt class="py-name">lines</tt><tt class="py-op">[</tt><tt class="py-name">start</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">rstrip</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">2</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-string">'::'</tt> </tt>
<a name="L808"></a><tt class="py-lineno"> 808</tt> <tt class="py-line"> </tt>
<a name="L809"></a><tt class="py-lineno"> 809</tt> <tt class="py-line"> <tt class="py-comment"># Get the contents of the bullet.</tt> </tt>
<a name="L810"></a><tt class="py-lineno"> 810</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">para_start</tt> <tt class="py-op">=</tt> <tt id="link-126" class="py-name"><a title="epydoc.markup.epytext._BULLET_RE" class="py-name" href="#" onclick="return doclink('link-126', '_BULLET_RE', 'link-102');">_BULLET_RE</a></tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-name">lines</tt><tt class="py-op">[</tt><tt class="py-name">start</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">bullet_indent</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">end</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L811"></a><tt class="py-lineno"> 811</tt> <tt class="py-line"> <tt class="py-name">bcontents</tt> <tt class="py-op">=</tt> <tt class="py-name">lines</tt><tt class="py-op">[</tt><tt class="py-name">start</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-name">bullet_indent</tt><tt class="py-op">:</tt><tt class="py-name">para_start</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="L812"></a><tt class="py-lineno"> 812</tt> <tt class="py-line"> </tt>
<a name="L813"></a><tt class="py-lineno"> 813</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt id="link-127" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-127', 'linenum', 'link-105');">linenum</a></tt> <tt class="py-op"><</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">lines</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L814"></a><tt class="py-lineno"> 814</tt> <tt class="py-line"> <tt class="py-comment"># Find the indentation of this line.</tt> </tt>
<a name="L815"></a><tt class="py-lineno"> 815</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">line</tt> <tt class="py-op">=</tt> <tt class="py-name">lines</tt><tt class="py-op">[</tt><tt id="link-128" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-128', 'linenum', 'link-105');">linenum</a></tt><tt class="py-op">]</tt> </tt>
<a name="L816"></a><tt class="py-lineno"> 816</tt> <tt class="py-line"> <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">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">line</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>
<a name="L817"></a><tt class="py-lineno"> 817</tt> <tt class="py-line"> </tt>
<a name="L818"></a><tt class="py-lineno"> 818</tt> <tt class="py-line"> <tt class="py-comment"># "::" markers end paragraphs.</tt> </tt>
<a name="L819"></a><tt class="py-lineno"> 819</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">doublecolon</tt><tt class="py-op">:</tt> <tt class="py-keyword">break</tt> </tt>
<a name="L820"></a><tt class="py-lineno"> 820</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">line</tt><tt class="py-op">.</tt><tt class="py-name">rstrip</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">2</tt><tt class="py-op">:</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">doublecolon</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
<a name="L821"></a><tt class="py-lineno"> 821</tt> <tt class="py-line"> </tt>
<a name="L822"></a><tt class="py-lineno"> 822</tt> <tt class="py-line"> <tt class="py-comment"># A blank line ends the token</tt> </tt>
<a name="L823"></a><tt class="py-lineno"> 823</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</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">line</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">break</tt> </tt>
<a name="L824"></a><tt class="py-lineno"> 824</tt> <tt class="py-line"> </tt>
<a name="L825"></a><tt class="py-lineno"> 825</tt> <tt class="py-line"> <tt class="py-comment"># Dedenting past bullet_indent ends the list item.</tt> </tt>
<a name="L826"></a><tt class="py-lineno"> 826</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">indent</tt> <tt class="py-op"><</tt> <tt class="py-name">bullet_indent</tt><tt class="py-op">:</tt> <tt class="py-keyword">break</tt> </tt>
<a name="L827"></a><tt class="py-lineno"> 827</tt> <tt class="py-line"> </tt>
<a name="L828"></a><tt class="py-lineno"> 828</tt> <tt class="py-line"> <tt class="py-comment"># A line beginning with a bullet ends the token.</tt> </tt>
<a name="L829"></a><tt class="py-lineno"> 829</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt id="link-129" class="py-name"><a title="epydoc.markup.epytext._BULLET_RE" class="py-name" href="#" onclick="return doclink('link-129', '_BULLET_RE', 'link-102');">_BULLET_RE</a></tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">break</tt> </tt>
<a name="L830"></a><tt class="py-lineno"> 830</tt> <tt class="py-line"> </tt>
<a name="L831"></a><tt class="py-lineno"> 831</tt> <tt class="py-line"> <tt class="py-comment"># If this is the second line, set the paragraph indentation, or </tt> </tt>
<a name="L832"></a><tt class="py-lineno"> 832</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># end the token, as appropriate.</tt> </tt>
<a name="L833"></a><tt class="py-lineno"> 833</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">para_indent</tt> <tt class="py-op">==</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-name">para_indent</tt> <tt class="py-op">=</tt> <tt class="py-name">indent</tt> </tt>
<a name="L834"></a><tt class="py-lineno"> 834</tt> <tt class="py-line"> </tt>
<a name="L835"></a><tt class="py-lineno"> 835</tt> <tt class="py-line"> <tt class="py-comment"># A change in indentation ends the token</tt> </tt>
<a name="L836"></a><tt class="py-lineno"> 836</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">indent</tt> <tt class="py-op">!=</tt> <tt class="py-name">para_indent</tt><tt class="py-op">:</tt> <tt class="py-keyword">break</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"># Go on to the next line.</tt> </tt>
<a name="L839"></a><tt class="py-lineno"> 839</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-130" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-130', 'linenum', 'link-105');">linenum</a></tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L840"></a><tt class="py-lineno"> 840</tt> <tt class="py-line"> </tt>
<a name="L841"></a><tt class="py-lineno"> 841</tt> <tt class="py-line"> <tt class="py-comment"># Add the bullet token.</tt> </tt>
<a name="L842"></a><tt class="py-lineno"> 842</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">tokens</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-131" class="py-name"><a title="epydoc.markup.epytext.Token" class="py-name" href="#" onclick="return doclink('link-131', 'Token', 'link-33');">Token</a></tt><tt class="py-op">(</tt><tt id="link-132" class="py-name"><a title="epydoc.markup.epytext.Token" class="py-name" href="#" onclick="return doclink('link-132', 'Token', 'link-33');">Token</a></tt><tt class="py-op">.</tt><tt id="link-133" class="py-name"><a title="epydoc.markup.epytext.Token.BULLET" class="py-name" href="#" onclick="return doclink('link-133', 'BULLET', 'link-50');">BULLET</a></tt><tt class="py-op">,</tt> <tt class="py-name">start</tt><tt class="py-op">,</tt> <tt class="py-name">bcontents</tt><tt class="py-op">,</tt> <tt class="py-name">bullet_indent</tt><tt class="py-op">,</tt> </tt>
<a name="L843"></a><tt class="py-lineno"> 843</tt> <tt class="py-line"> <tt class="py-name">inline</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="L844"></a><tt class="py-lineno"> 844</tt> <tt class="py-line"> </tt>
<a name="L845"></a><tt class="py-lineno"> 845</tt> <tt class="py-line"> <tt class="py-comment"># Add the paragraph token.</tt> </tt>
<a name="L846"></a><tt class="py-lineno"> 846</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">pcontents</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">lines</tt><tt class="py-op">[</tt><tt class="py-name">start</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-name">para_start</tt><tt class="py-op">:</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 class="py-op">]</tt> <tt class="py-op">+</tt> </tt>
<a name="L847"></a><tt class="py-lineno"> 847</tt> <tt class="py-line"> <tt class="py-op">[</tt><tt class="py-name">line</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-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 class="py-name">start</tt><tt class="py-op">+</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt id="link-134" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-134', 'linenum', 'link-105');">linenum</a></tt><tt class="py-op">]</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L848"></a><tt class="py-lineno"> 848</tt> <tt class="py-line"> <tt class="py-name">pcontents</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-name">pcontents</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="L849"></a><tt class="py-lineno"> 849</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">pcontents</tt><tt class="py-op">:</tt> </tt>
<a name="L850"></a><tt class="py-lineno"> 850</tt> <tt class="py-line"> <tt class="py-name">tokens</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-135" class="py-name"><a title="epydoc.markup.epytext.Token" class="py-name" href="#" onclick="return doclink('link-135', 'Token', 'link-33');">Token</a></tt><tt class="py-op">(</tt><tt id="link-136" class="py-name"><a title="epydoc.markup.epytext.Token" class="py-name" href="#" onclick="return doclink('link-136', 'Token', 'link-33');">Token</a></tt><tt class="py-op">.</tt><tt id="link-137" class="py-name"><a title="epydoc.markup.epytext.Token.PARA" class="py-name" href="#" onclick="return doclink('link-137', 'PARA', 'link-34');">PARA</a></tt><tt class="py-op">,</tt> <tt class="py-name">start</tt><tt class="py-op">,</tt> <tt class="py-name">pcontents</tt><tt class="py-op">,</tt> <tt class="py-name">para_indent</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">inline</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="L852"></a><tt class="py-lineno"> 852</tt> <tt class="py-line"> </tt>
<a name="L853"></a><tt class="py-lineno"> 853</tt> <tt class="py-line"> <tt class="py-comment"># Return the linenum after the paragraph token ends.</tt> </tt>
<a name="L854"></a><tt class="py-lineno"> 854</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt id="link-138" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-138', 'linenum', 'link-105');">linenum</a></tt> </tt>
</div><a name="L855"></a><tt class="py-lineno"> 855</tt> <tt class="py-line"> </tt>
<a name="_tokenize_para"></a><div id="_tokenize_para-def"><a name="L856"></a><tt class="py-lineno"> 856</tt> <a class="py-toggle" href="#" id="_tokenize_para-toggle" onclick="return toggle('_tokenize_para');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext-module.html#_tokenize_para">_tokenize_para</a><tt class="py-op">(</tt><tt class="py-param">lines</tt><tt class="py-op">,</tt> <tt class="py-param">start</tt><tt class="py-op">,</tt> <tt class="py-param">para_indent</tt><tt class="py-op">,</tt> <tt class="py-param">tokens</tt><tt class="py-op">,</tt> <tt class="py-param">errors</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_tokenize_para-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_tokenize_para-expanded"><a name="L857"></a><tt class="py-lineno"> 857</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L858"></a><tt class="py-lineno"> 858</tt> <tt class="py-line"><tt class="py-docstring"> Construct a L{Token} containing the paragraph starting at</tt> </tt>
<a name="L859"></a><tt class="py-lineno"> 859</tt> <tt class="py-line"><tt class="py-docstring"> C{lines[start]}, and append it to C{tokens}. C{para_indent}</tt> </tt>
<a name="L860"></a><tt class="py-lineno"> 860</tt> <tt class="py-line"><tt class="py-docstring"> should be the indentation of the paragraph . Any errors</tt> </tt>
<a name="L861"></a><tt class="py-lineno"> 861</tt> <tt class="py-line"><tt class="py-docstring"> generated while tokenizing the paragraph will be appended to</tt> </tt>
<a name="L862"></a><tt class="py-lineno"> 862</tt> <tt class="py-line"><tt class="py-docstring"> C{errors}.</tt> </tt>
<a name="L863"></a><tt class="py-lineno"> 863</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L864"></a><tt class="py-lineno"> 864</tt> <tt class="py-line"><tt class="py-docstring"> @param lines: The list of lines to be tokenized</tt> </tt>
<a name="L865"></a><tt class="py-lineno"> 865</tt> <tt class="py-line"><tt class="py-docstring"> @param start: The index into C{lines} of the first line of the</tt> </tt>
<a name="L866"></a><tt class="py-lineno"> 866</tt> <tt class="py-line"><tt class="py-docstring"> paragraph to be tokenized.</tt> </tt>
<a name="L867"></a><tt class="py-lineno"> 867</tt> <tt class="py-line"><tt class="py-docstring"> @param para_indent: The indentation of C{lines[start]}. This is</tt> </tt>
<a name="L868"></a><tt class="py-lineno"> 868</tt> <tt class="py-line"><tt class="py-docstring"> the indentation of the paragraph.</tt> </tt>
<a name="L869"></a><tt class="py-lineno"> 869</tt> <tt class="py-line"><tt class="py-docstring"> @param errors: A list of the errors generated by parsing. Any</tt> </tt>
<a name="L870"></a><tt class="py-lineno"> 870</tt> <tt class="py-line"><tt class="py-docstring"> new errors generated while will tokenizing this paragraph</tt> </tt>
<a name="L871"></a><tt class="py-lineno"> 871</tt> <tt class="py-line"><tt class="py-docstring"> will be appended to this list.</tt> </tt>
<a name="L872"></a><tt class="py-lineno"> 872</tt> <tt class="py-line"><tt class="py-docstring"> @return: The line number of the first line following the</tt> </tt>
<a name="L873"></a><tt class="py-lineno"> 873</tt> <tt class="py-line"><tt class="py-docstring"> paragraph. </tt> </tt>
<a name="L874"></a><tt class="py-lineno"> 874</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L875"></a><tt class="py-lineno"> 875</tt> <tt class="py-line"><tt class="py-docstring"> @type lines: C{list} of C{string}</tt> </tt>
<a name="L876"></a><tt class="py-lineno"> 876</tt> <tt class="py-line"><tt class="py-docstring"> @type start: C{int}</tt> </tt>
<a name="L877"></a><tt class="py-lineno"> 877</tt> <tt class="py-line"><tt class="py-docstring"> @type para_indent: C{int}</tt> </tt>
<a name="L878"></a><tt class="py-lineno"> 878</tt> <tt class="py-line"><tt class="py-docstring"> @type tokens: C{list} of L{Token}</tt> </tt>
<a name="L879"></a><tt class="py-lineno"> 879</tt> <tt class="py-line"><tt class="py-docstring"> @type errors: C{list} of L{ParseError}</tt> </tt>
<a name="L880"></a><tt class="py-lineno"> 880</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{int}</tt> </tt>
<a name="L881"></a><tt class="py-lineno"> 881</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L882"></a><tt class="py-lineno"> 882</tt> <tt class="py-line"> <tt id="link-139" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-139', 'linenum', 'link-105');">linenum</a></tt> <tt class="py-op">=</tt> <tt class="py-name">start</tt> <tt class="py-op">+</tt> <tt class="py-number">1</tt> </tt>
<a name="L883"></a><tt class="py-lineno"> 883</tt> <tt class="py-line"> <tt class="py-name">doublecolon</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L884"></a><tt class="py-lineno"> 884</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt id="link-140" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-140', 'linenum', 'link-105');">linenum</a></tt> <tt class="py-op"><</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">lines</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L885"></a><tt class="py-lineno"> 885</tt> <tt class="py-line"> <tt class="py-comment"># Find the indentation of this line.</tt> </tt>
<a name="L886"></a><tt class="py-lineno"> 886</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">line</tt> <tt class="py-op">=</tt> <tt class="py-name">lines</tt><tt class="py-op">[</tt><tt id="link-141" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-141', 'linenum', 'link-105');">linenum</a></tt><tt class="py-op">]</tt> </tt>
<a name="L887"></a><tt class="py-lineno"> 887</tt> <tt class="py-line"> <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">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">line</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>
<a name="L888"></a><tt class="py-lineno"> 888</tt> <tt class="py-line"> </tt>
<a name="L889"></a><tt class="py-lineno"> 889</tt> <tt class="py-line"> <tt class="py-comment"># "::" markers end paragraphs.</tt> </tt>
<a name="L890"></a><tt class="py-lineno"> 890</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">doublecolon</tt><tt class="py-op">:</tt> <tt class="py-keyword">break</tt> </tt>
<a name="L891"></a><tt class="py-lineno"> 891</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">line</tt><tt class="py-op">.</tt><tt class="py-name">rstrip</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">2</tt><tt class="py-op">:</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">doublecolon</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
<a name="L892"></a><tt class="py-lineno"> 892</tt> <tt class="py-line"> </tt>
<a name="L893"></a><tt class="py-lineno"> 893</tt> <tt class="py-line"> <tt class="py-comment"># Blank lines end paragraphs</tt> </tt>
<a name="L894"></a><tt class="py-lineno"> 894</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</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">line</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">break</tt> </tt>
<a name="L895"></a><tt class="py-lineno"> 895</tt> <tt class="py-line"> </tt>
<a name="L896"></a><tt class="py-lineno"> 896</tt> <tt class="py-line"> <tt class="py-comment"># Indentation changes end paragraphs</tt> </tt>
<a name="L897"></a><tt class="py-lineno"> 897</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">indent</tt> <tt class="py-op">!=</tt> <tt class="py-name">para_indent</tt><tt class="py-op">:</tt> <tt class="py-keyword">break</tt> </tt>
<a name="L898"></a><tt class="py-lineno"> 898</tt> <tt class="py-line"> </tt>
<a name="L899"></a><tt class="py-lineno"> 899</tt> <tt class="py-line"> <tt class="py-comment"># List bullets end paragraphs</tt> </tt>
<a name="L900"></a><tt class="py-lineno"> 900</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt id="link-142" class="py-name"><a title="epydoc.markup.epytext._BULLET_RE" class="py-name" href="#" onclick="return doclink('link-142', '_BULLET_RE', 'link-102');">_BULLET_RE</a></tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">break</tt> </tt>
<a name="L901"></a><tt class="py-lineno"> 901</tt> <tt class="py-line"> </tt>
<a name="L902"></a><tt class="py-lineno"> 902</tt> <tt class="py-line"> <tt class="py-comment"># Check for mal-formatted field items.</tt> </tt>
<a name="L903"></a><tt class="py-lineno"> 903</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">line</tt><tt class="py-op">[</tt><tt class="py-name">indent</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-string">'@'</tt><tt class="py-op">:</tt> </tt>
<a name="L904"></a><tt class="py-lineno"> 904</tt> <tt class="py-line"> <tt class="py-name">estr</tt> <tt class="py-op">=</tt> <tt class="py-string">"Possible mal-formatted field item."</tt> </tt>
<a name="L905"></a><tt class="py-lineno"> 905</tt> <tt class="py-line"> <tt class="py-name">errors</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-143" class="py-name"><a title="epydoc.markup.epytext.TokenizationError" class="py-name" href="#" onclick="return doclink('link-143', 'TokenizationError', 'link-108');">TokenizationError</a></tt><tt class="py-op">(</tt><tt class="py-name">estr</tt><tt class="py-op">,</tt> <tt id="link-144" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-144', 'linenum', 'link-105');">linenum</a></tt><tt class="py-op">,</tt> <tt id="link-145" class="py-name"><a title="epydoc.markup.ParseError.is_fatal" class="py-name" href="#" onclick="return doclink('link-145', 'is_fatal', 'link-56');">is_fatal</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="L906"></a><tt class="py-lineno"> 906</tt> <tt class="py-line"> </tt>
<a name="L907"></a><tt class="py-lineno"> 907</tt> <tt class="py-line"> <tt class="py-comment"># Go on to the next line.</tt> </tt>
<a name="L908"></a><tt class="py-lineno"> 908</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-146" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-146', 'linenum', 'link-105');">linenum</a></tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L909"></a><tt class="py-lineno"> 909</tt> <tt class="py-line"> </tt>
<a name="L910"></a><tt class="py-lineno"> 910</tt> <tt class="py-line"> <tt class="py-name">contents</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">line</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-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 class="py-name">start</tt><tt class="py-op">:</tt><tt id="link-147" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-147', 'linenum', 'link-105');">linenum</a></tt><tt class="py-op">]</tt><tt class="py-op">]</tt> </tt>
<a name="L911"></a><tt class="py-lineno"> 911</tt> <tt class="py-line"> </tt>
<a name="L912"></a><tt class="py-lineno"> 912</tt> <tt class="py-line"> <tt class="py-comment"># Does this token look like a heading?</tt> </tt>
<a name="L913"></a><tt class="py-lineno"> 913</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</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">contents</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-keyword">or</tt> </tt>
<a name="L914"></a><tt class="py-lineno"> 914</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">contents</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-keyword">not</tt> <tt class="py-keyword">in</tt> <tt id="link-148" class="py-name"><a title="epydoc.markup.epytext._HEADING_CHARS" class="py-name" href="#" onclick="return doclink('link-148', '_HEADING_CHARS', 'link-18');">_HEADING_CHARS</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L915"></a><tt class="py-lineno"> 915</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">abs</tt><tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">contents</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 class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">contents</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-op">></tt> <tt class="py-number">5</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L916"></a><tt class="py-lineno"> 916</tt> <tt class="py-line"> <tt class="py-name">looks_like_heading</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L917"></a><tt class="py-lineno"> 917</tt> <tt class="py-line"> <tt class="py-keyword">else</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">looks_like_heading</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
<a name="L919"></a><tt class="py-lineno"> 919</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">char</tt> <tt class="py-keyword">in</tt> <tt class="py-name">contents</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="L920"></a><tt class="py-lineno"> 920</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">char</tt> <tt class="py-op">!=</tt> <tt class="py-name">contents</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>
<a name="L921"></a><tt class="py-lineno"> 921</tt> <tt class="py-line"> <tt class="py-name">looks_like_heading</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L922"></a><tt class="py-lineno"> 922</tt> <tt class="py-line"> <tt class="py-keyword">break</tt> </tt>
<a name="L923"></a><tt class="py-lineno"> 923</tt> <tt class="py-line"> </tt>
<a name="L924"></a><tt class="py-lineno"> 924</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">looks_like_heading</tt><tt class="py-op">:</tt> </tt>
<a name="L925"></a><tt class="py-lineno"> 925</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">contents</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 class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">contents</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="L926"></a><tt class="py-lineno"> 926</tt> <tt class="py-line"> <tt class="py-name">estr</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">"Possible heading typo: the number of "</tt><tt class="py-op">+</tt> </tt>
<a name="L927"></a><tt class="py-lineno"> 927</tt> <tt class="py-line"> <tt class="py-string">"underline characters must match the "</tt><tt class="py-op">+</tt> </tt>
<a name="L928"></a><tt class="py-lineno"> 928</tt> <tt class="py-line"> <tt class="py-string">"number of heading characters."</tt><tt class="py-op">)</tt> </tt>
<a name="L929"></a><tt class="py-lineno"> 929</tt> <tt class="py-line"> <tt class="py-name">errors</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-149" class="py-name"><a title="epydoc.markup.epytext.TokenizationError" class="py-name" href="#" onclick="return doclink('link-149', 'TokenizationError', 'link-108');">TokenizationError</a></tt><tt class="py-op">(</tt><tt class="py-name">estr</tt><tt class="py-op">,</tt> <tt class="py-name">start</tt><tt class="py-op">,</tt> <tt id="link-150" class="py-name"><a title="epydoc.markup.ParseError.is_fatal" class="py-name" href="#" onclick="return doclink('link-150', 'is_fatal', 'link-56');">is_fatal</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="L930"></a><tt class="py-lineno"> 930</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L931"></a><tt class="py-lineno"> 931</tt> <tt class="py-line"> <tt class="py-name">level</tt> <tt class="py-op">=</tt> <tt id="link-151" class="py-name"><a title="epydoc.markup.epytext._HEADING_CHARS" class="py-name" href="#" onclick="return doclink('link-151', '_HEADING_CHARS', 'link-18');">_HEADING_CHARS</a></tt><tt class="py-op">.</tt><tt class="py-name">index</tt><tt class="py-op">(</tt><tt class="py-name">contents</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>
<a name="L932"></a><tt class="py-lineno"> 932</tt> <tt class="py-line"> <tt class="py-name">tokens</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-152" class="py-name"><a title="epydoc.markup.epytext.Token" class="py-name" href="#" onclick="return doclink('link-152', 'Token', 'link-33');">Token</a></tt><tt class="py-op">(</tt><tt id="link-153" class="py-name"><a title="epydoc.markup.epytext.Token" class="py-name" href="#" onclick="return doclink('link-153', 'Token', 'link-33');">Token</a></tt><tt class="py-op">.</tt><tt id="link-154" class="py-name"><a title="epydoc.markup.epytext.Token.HEADING" class="py-name" href="#" onclick="return doclink('link-154', 'HEADING', 'link-38');">HEADING</a></tt><tt class="py-op">,</tt> <tt class="py-name">start</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">contents</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">para_indent</tt><tt class="py-op">,</tt> <tt class="py-name">level</tt><tt class="py-op">)</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">return</tt> <tt class="py-name">start</tt><tt class="py-op">+</tt><tt class="py-number">2</tt> </tt>
<a name="L935"></a><tt class="py-lineno"> 935</tt> <tt class="py-line"> </tt>
<a name="L936"></a><tt class="py-lineno"> 936</tt> <tt class="py-line"> <tt class="py-comment"># Add the paragraph token, and return the linenum after it ends.</tt> </tt>
<a name="L937"></a><tt class="py-lineno"> 937</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">contents</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-name">contents</tt><tt class="py-op">)</tt> </tt>
<a name="L938"></a><tt class="py-lineno"> 938</tt> <tt class="py-line"> <tt class="py-name">tokens</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-155" class="py-name"><a title="epydoc.markup.epytext.Token" class="py-name" href="#" onclick="return doclink('link-155', 'Token', 'link-33');">Token</a></tt><tt class="py-op">(</tt><tt id="link-156" class="py-name"><a title="epydoc.markup.epytext.Token" class="py-name" href="#" onclick="return doclink('link-156', 'Token', 'link-33');">Token</a></tt><tt class="py-op">.</tt><tt id="link-157" class="py-name"><a title="epydoc.markup.epytext.Token.PARA" class="py-name" href="#" onclick="return doclink('link-157', 'PARA', 'link-34');">PARA</a></tt><tt class="py-op">,</tt> <tt class="py-name">start</tt><tt class="py-op">,</tt> <tt class="py-name">contents</tt><tt class="py-op">,</tt> <tt class="py-name">para_indent</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L939"></a><tt class="py-lineno"> 939</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-158" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-158', 'linenum', 'link-105');">linenum</a></tt> </tt>
</div><a name="L940"></a><tt class="py-lineno"> 940</tt> <tt class="py-line"> </tt>
<a name="_tokenize"></a><div id="_tokenize-def"><a name="L941"></a><tt class="py-lineno"> 941</tt> <a class="py-toggle" href="#" id="_tokenize-toggle" onclick="return toggle('_tokenize');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext-module.html#_tokenize">_tokenize</a><tt class="py-op">(</tt><tt class="py-param">str</tt><tt class="py-op">,</tt> <tt class="py-param">errors</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_tokenize-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_tokenize-expanded"><a name="L942"></a><tt class="py-lineno"> 942</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L943"></a><tt class="py-lineno"> 943</tt> <tt class="py-line"><tt class="py-docstring"> Split a given formatted docstring into an ordered list of</tt> </tt>
<a name="L944"></a><tt class="py-lineno"> 944</tt> <tt class="py-line"><tt class="py-docstring"> C{Token}s, according to the epytext markup rules.</tt> </tt>
<a name="L945"></a><tt class="py-lineno"> 945</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L946"></a><tt class="py-lineno"> 946</tt> <tt class="py-line"><tt class="py-docstring"> @param str: The epytext string</tt> </tt>
<a name="L947"></a><tt class="py-lineno"> 947</tt> <tt class="py-line"><tt class="py-docstring"> @type str: C{string}</tt> </tt>
<a name="L948"></a><tt class="py-lineno"> 948</tt> <tt class="py-line"><tt class="py-docstring"> @param errors: A list where any errors generated during parsing</tt> </tt>
<a name="L949"></a><tt class="py-lineno"> 949</tt> <tt class="py-line"><tt class="py-docstring"> will be stored. If no list is specified, then errors will </tt> </tt>
<a name="L950"></a><tt class="py-lineno"> 950</tt> <tt class="py-line"><tt class="py-docstring"> generate exceptions.</tt> </tt>
<a name="L951"></a><tt class="py-lineno"> 951</tt> <tt class="py-line"><tt class="py-docstring"> @type errors: C{list} of L{ParseError}</tt> </tt>
<a name="L952"></a><tt class="py-lineno"> 952</tt> <tt class="py-line"><tt class="py-docstring"> @return: a list of the C{Token}s that make up the given string.</tt> </tt>
<a name="L953"></a><tt class="py-lineno"> 953</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{list} of L{Token}</tt> </tt>
<a name="L954"></a><tt class="py-lineno"> 954</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L955"></a><tt class="py-lineno"> 955</tt> <tt class="py-line"> <tt class="py-name">tokens</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L956"></a><tt class="py-lineno"> 956</tt> <tt class="py-line"> <tt class="py-name">lines</tt> <tt class="py-op">=</tt> <tt class="py-name">str</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="L957"></a><tt class="py-lineno"> 957</tt> <tt class="py-line"> </tt>
<a name="L958"></a><tt class="py-lineno"> 958</tt> <tt class="py-line"> <tt class="py-comment"># Scan through the lines, determining what @type of token we're</tt> </tt>
<a name="L959"></a><tt class="py-lineno"> 959</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># dealing with, and tokenizing it, as appropriate.</tt> </tt>
<a name="L960"></a><tt class="py-lineno"> 960</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-159" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-159', 'linenum', 'link-105');">linenum</a></tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L961"></a><tt class="py-lineno"> 961</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt id="link-160" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-160', 'linenum', 'link-105');">linenum</a></tt> <tt class="py-op"><</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">lines</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L962"></a><tt class="py-lineno"> 962</tt> <tt class="py-line"> <tt class="py-comment"># Get the current line and its indentation.</tt> </tt>
<a name="L963"></a><tt class="py-lineno"> 963</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">line</tt> <tt class="py-op">=</tt> <tt class="py-name">lines</tt><tt class="py-op">[</tt><tt id="link-161" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-161', 'linenum', 'link-105');">linenum</a></tt><tt class="py-op">]</tt> </tt>
<a name="L964"></a><tt class="py-lineno"> 964</tt> <tt class="py-line"> <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">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">line</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>
<a name="L965"></a><tt class="py-lineno"> 965</tt> <tt class="py-line"> </tt>
<a name="L966"></a><tt class="py-lineno"> 966</tt> <tt class="py-line"> <tt class="py-keyword">if</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">line</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L967"></a><tt class="py-lineno"> 967</tt> <tt class="py-line"> <tt class="py-comment"># Ignore blank lines.</tt> </tt>
<a name="L968"></a><tt class="py-lineno"> 968</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-162" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-162', 'linenum', 'link-105');">linenum</a></tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L969"></a><tt class="py-lineno"> 969</tt> <tt class="py-line"> <tt class="py-keyword">continue</tt> </tt>
<a name="L970"></a><tt class="py-lineno"> 970</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">line</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 class="py-number">4</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-string">'>>> '</tt><tt class="py-op">:</tt> </tt>
<a name="L971"></a><tt class="py-lineno"> 971</tt> <tt class="py-line"> <tt class="py-comment"># blocks starting with ">>> " are doctest block tokens.</tt> </tt>
<a name="L972"></a><tt class="py-lineno"> 972</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-163" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-163', 'linenum', 'link-105');">linenum</a></tt> <tt class="py-op">=</tt> <tt id="link-164" class="py-name" targets="Function epydoc.markup.epytext._tokenize_doctest()=epydoc.markup.epytext-module.html#_tokenize_doctest"><a title="epydoc.markup.epytext._tokenize_doctest" class="py-name" href="#" onclick="return doclink('link-164', '_tokenize_doctest', 'link-164');">_tokenize_doctest</a></tt><tt class="py-op">(</tt><tt class="py-name">lines</tt><tt class="py-op">,</tt> <tt id="link-165" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-165', 'linenum', 'link-105');">linenum</a></tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">,</tt> </tt>
<a name="L973"></a><tt class="py-lineno"> 973</tt> <tt class="py-line"> <tt class="py-name">tokens</tt><tt class="py-op">,</tt> <tt class="py-name">errors</tt><tt class="py-op">)</tt> </tt>
<a name="L974"></a><tt class="py-lineno"> 974</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt id="link-166" class="py-name"><a title="epydoc.markup.epytext._BULLET_RE" class="py-name" href="#" onclick="return doclink('link-166', '_BULLET_RE', 'link-102');">_BULLET_RE</a></tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L975"></a><tt class="py-lineno"> 975</tt> <tt class="py-line"> <tt class="py-comment"># blocks starting with a bullet are LI start tokens.</tt> </tt>
<a name="L976"></a><tt class="py-lineno"> 976</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-167" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-167', 'linenum', 'link-105');">linenum</a></tt> <tt class="py-op">=</tt> <tt id="link-168" class="py-name" targets="Function epydoc.markup.epytext._tokenize_listart()=epydoc.markup.epytext-module.html#_tokenize_listart"><a title="epydoc.markup.epytext._tokenize_listart" class="py-name" href="#" onclick="return doclink('link-168', '_tokenize_listart', 'link-168');">_tokenize_listart</a></tt><tt class="py-op">(</tt><tt class="py-name">lines</tt><tt class="py-op">,</tt> <tt id="link-169" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-169', 'linenum', 'link-105');">linenum</a></tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">,</tt> </tt>
<a name="L977"></a><tt class="py-lineno"> 977</tt> <tt class="py-line"> <tt class="py-name">tokens</tt><tt class="py-op">,</tt> <tt class="py-name">errors</tt><tt class="py-op">)</tt> </tt>
<a name="L978"></a><tt class="py-lineno"> 978</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">tokens</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">indent</tt> <tt class="py-op">!=</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L979"></a><tt class="py-lineno"> 979</tt> <tt class="py-line"> <tt class="py-name">indent</tt> <tt class="py-op">=</tt> <tt class="py-name">tokens</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">indent</tt> </tt>
<a name="L980"></a><tt class="py-lineno"> 980</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L981"></a><tt class="py-lineno"> 981</tt> <tt class="py-line"> <tt class="py-comment"># Check for mal-formatted field items.</tt> </tt>
<a name="L982"></a><tt class="py-lineno"> 982</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">line</tt><tt class="py-op">[</tt><tt class="py-name">indent</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-string">'@'</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">estr</tt> <tt class="py-op">=</tt> <tt class="py-string">"Possible mal-formatted field item."</tt> </tt>
<a name="L984"></a><tt class="py-lineno"> 984</tt> <tt class="py-line"> <tt class="py-name">errors</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-170" class="py-name"><a title="epydoc.markup.epytext.TokenizationError" class="py-name" href="#" onclick="return doclink('link-170', 'TokenizationError', 'link-108');">TokenizationError</a></tt><tt class="py-op">(</tt><tt class="py-name">estr</tt><tt class="py-op">,</tt> <tt id="link-171" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-171', 'linenum', 'link-105');">linenum</a></tt><tt class="py-op">,</tt> <tt id="link-172" class="py-name"><a title="epydoc.markup.ParseError.is_fatal" class="py-name" href="#" onclick="return doclink('link-172', 'is_fatal', 'link-56');">is_fatal</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="L985"></a><tt class="py-lineno"> 985</tt> <tt class="py-line"> </tt>
<a name="L986"></a><tt class="py-lineno"> 986</tt> <tt class="py-line"> <tt class="py-comment"># anything else is either a paragraph or a heading.</tt> </tt>
<a name="L987"></a><tt class="py-lineno"> 987</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-173" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-173', 'linenum', 'link-105');">linenum</a></tt> <tt class="py-op">=</tt> <tt id="link-174" class="py-name" targets="Function epydoc.markup.epytext._tokenize_para()=epydoc.markup.epytext-module.html#_tokenize_para"><a title="epydoc.markup.epytext._tokenize_para" class="py-name" href="#" onclick="return doclink('link-174', '_tokenize_para', 'link-174');">_tokenize_para</a></tt><tt class="py-op">(</tt><tt class="py-name">lines</tt><tt class="py-op">,</tt> <tt id="link-175" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-175', 'linenum', 'link-105');">linenum</a></tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">,</tt> <tt class="py-name">tokens</tt><tt class="py-op">,</tt> <tt class="py-name">errors</tt><tt class="py-op">)</tt> </tt>
<a name="L988"></a><tt class="py-lineno"> 988</tt> <tt class="py-line"> </tt>
<a name="L989"></a><tt class="py-lineno"> 989</tt> <tt class="py-line"> <tt class="py-comment"># Paragraph tokens ending in '::' initiate literal blocks.</tt> </tt>
<a name="L990"></a><tt class="py-lineno"> 990</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">tokens</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 id="link-176" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-176', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt id="link-177" class="py-name"><a title="epydoc.markup.epytext.Token" class="py-name" href="#" onclick="return doclink('link-177', 'Token', 'link-33');">Token</a></tt><tt class="py-op">.</tt><tt id="link-178" class="py-name"><a title="epydoc.markup.epytext.Token.PARA" class="py-name" href="#" onclick="return doclink('link-178', 'PARA', 'link-34');">PARA</a></tt> <tt class="py-keyword">and</tt> </tt>
<a name="L991"></a><tt class="py-lineno"> 991</tt> <tt class="py-line"> <tt class="py-name">tokens</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">contents</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-op">==</tt> <tt class="py-string">'::'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L992"></a><tt class="py-lineno"> 992</tt> <tt class="py-line"> <tt class="py-name">tokens</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">contents</tt> <tt class="py-op">=</tt> <tt class="py-name">tokens</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">contents</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="L993"></a><tt class="py-lineno"> 993</tt> <tt class="py-line"> <tt id="link-179" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-179', 'linenum', 'link-105');">linenum</a></tt> <tt class="py-op">=</tt> <tt id="link-180" class="py-name" targets="Function epydoc.markup.epytext._tokenize_literal()=epydoc.markup.epytext-module.html#_tokenize_literal"><a title="epydoc.markup.epytext._tokenize_literal" class="py-name" href="#" onclick="return doclink('link-180', '_tokenize_literal', 'link-180');">_tokenize_literal</a></tt><tt class="py-op">(</tt><tt class="py-name">lines</tt><tt class="py-op">,</tt> <tt id="link-181" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-181', 'linenum', 'link-105');">linenum</a></tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">,</tt> <tt class="py-name">tokens</tt><tt class="py-op">,</tt> <tt class="py-name">errors</tt><tt class="py-op">)</tt> </tt>
<a name="L994"></a><tt class="py-lineno"> 994</tt> <tt class="py-line"> </tt>
<a name="L995"></a><tt class="py-lineno"> 995</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">tokens</tt> </tt>
</div><a name="L996"></a><tt class="py-lineno"> 996</tt> <tt class="py-line"> </tt>
<a name="L997"></a><tt class="py-lineno"> 997</tt> <tt class="py-line"> </tt>
<a name="L998"></a><tt class="py-lineno"> 998</tt> <tt class="py-line"><tt class="py-comment">##################################################</tt> </tt>
<a name="L999"></a><tt class="py-lineno"> 999</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## Inline markup ("colorizing")</tt> </tt>
<a name="L1000"></a><tt class="py-lineno">1000</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">##################################################</tt> </tt>
<a name="L1001"></a><tt class="py-lineno">1001</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L1002"></a><tt class="py-lineno">1002</tt> <tt class="py-line"><tt class="py-comment"># Assorted regular expressions used for colorizing.</tt> </tt>
<a name="L1003"></a><tt class="py-lineno">1003</tt> <tt class="py-line"><tt class="py-comment"></tt><tt id="link-182" class="py-name" targets="Variable epydoc.markup.epytext._BRACE_RE=epydoc.markup.epytext-module.html#_BRACE_RE"><a title="epydoc.markup.epytext._BRACE_RE" class="py-name" href="#" onclick="return doclink('link-182', '_BRACE_RE', 'link-182');">_BRACE_RE</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">'{|}'</tt><tt class="py-op">)</tt> </tt>
<a name="L1004"></a><tt class="py-lineno">1004</tt> <tt class="py-line"><tt id="link-183" class="py-name" targets="Variable epydoc.markup.epytext._TARGET_RE=epydoc.markup.epytext-module.html#_TARGET_RE"><a title="epydoc.markup.epytext._TARGET_RE" class="py-name" href="#" onclick="return doclink('link-183', '_TARGET_RE', 'link-183');">_TARGET_RE</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">'^(.*?)\s*<(?:URI:|URL:)?([^<>]+)>$'</tt><tt class="py-op">)</tt> </tt>
<a name="L1005"></a><tt class="py-lineno">1005</tt> <tt class="py-line"> </tt>
<a name="_colorize"></a><div id="_colorize-def"><a name="L1006"></a><tt class="py-lineno">1006</tt> <a class="py-toggle" href="#" id="_colorize-toggle" onclick="return toggle('_colorize');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext-module.html#_colorize">_colorize</a><tt class="py-op">(</tt><tt class="py-param">doc</tt><tt class="py-op">,</tt> <tt class="py-param">token</tt><tt class="py-op">,</tt> <tt class="py-param">errors</tt><tt class="py-op">,</tt> <tt class="py-param">tagName</tt><tt class="py-op">=</tt><tt class="py-string">'para'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_colorize-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_colorize-expanded"><a name="L1007"></a><tt class="py-lineno">1007</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1008"></a><tt class="py-lineno">1008</tt> <tt class="py-line"><tt class="py-docstring"> Given a string containing the contents of a paragraph, produce a</tt> </tt>
<a name="L1009"></a><tt class="py-lineno">1009</tt> <tt class="py-line"><tt class="py-docstring"> DOM C{Element} encoding that paragraph. Colorized regions are</tt> </tt>
<a name="L1010"></a><tt class="py-lineno">1010</tt> <tt class="py-line"><tt class="py-docstring"> represented using DOM C{Element}s, and text is represented using</tt> </tt>
<a name="L1011"></a><tt class="py-lineno">1011</tt> <tt class="py-line"><tt class="py-docstring"> DOM C{Text}s.</tt> </tt>
<a name="L1012"></a><tt class="py-lineno">1012</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1013"></a><tt class="py-lineno">1013</tt> <tt class="py-line"><tt class="py-docstring"> @param errors: A list of errors. Any newly generated errors will</tt> </tt>
<a name="L1014"></a><tt class="py-lineno">1014</tt> <tt class="py-line"><tt class="py-docstring"> be appended to this list.</tt> </tt>
<a name="L1015"></a><tt class="py-lineno">1015</tt> <tt class="py-line"><tt class="py-docstring"> @type errors: C{list} of C{string}</tt> </tt>
<a name="L1016"></a><tt class="py-lineno">1016</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1017"></a><tt class="py-lineno">1017</tt> <tt class="py-line"><tt class="py-docstring"> @param tagName: The element tag for the DOM C{Element} that should</tt> </tt>
<a name="L1018"></a><tt class="py-lineno">1018</tt> <tt class="py-line"><tt class="py-docstring"> be generated.</tt> </tt>
<a name="L1019"></a><tt class="py-lineno">1019</tt> <tt class="py-line"><tt class="py-docstring"> @type tagName: C{string}</tt> </tt>
<a name="L1020"></a><tt class="py-lineno">1020</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1021"></a><tt class="py-lineno">1021</tt> <tt class="py-line"><tt class="py-docstring"> @return: a DOM C{Element} encoding the given paragraph.</tt> </tt>
<a name="L1022"></a><tt class="py-lineno">1022</tt> <tt class="py-line"><tt class="py-docstring"> @returntype: C{Element}</tt> </tt>
<a name="L1023"></a><tt class="py-lineno">1023</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1024"></a><tt class="py-lineno">1024</tt> <tt class="py-line"> <tt class="py-name">str</tt> <tt class="py-op">=</tt> <tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">contents</tt> </tt>
<a name="L1025"></a><tt class="py-lineno">1025</tt> <tt class="py-line"> <tt id="link-184" class="py-name"><a title="epydoc.markup.ParseError.linenum" class="py-name" href="#" onclick="return doclink('link-184', 'linenum', 'link-105');">linenum</a></tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L1026"></a><tt class="py-lineno">1026</tt> <tt class="py-line"> </tt>
<a name="L1027"></a><tt class="py-lineno">1027</tt> <tt class="py-line"> <tt class="py-comment"># Maintain a stack of DOM elements, containing the ancestors of</tt> </tt>
<a name="L1028"></a><tt class="py-lineno">1028</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># the text currently being analyzed. New elements are pushed when </tt> </tt>
<a name="L1029"></a><tt class="py-lineno">1029</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># "{" is encountered, and old elements are popped when "}" is</tt> </tt>
<a name="L1030"></a><tt class="py-lineno">1030</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># encountered. </tt> </tt>
<a name="L1031"></a><tt class="py-lineno">1031</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">stack</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt id="link-185" class="py-name"><a title="epydoc.markup.epytext.Element" class="py-name" href="#" onclick="return doclink('link-185', 'Element', 'link-30');">Element</a></tt><tt class="py-op">(</tt><tt class="py-name">tagName</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L1032"></a><tt class="py-lineno">1032</tt> <tt class="py-line"> </tt>
<a name="L1033"></a><tt class="py-lineno">1033</tt> <tt class="py-line"> <tt class="py-comment"># This is just used to make error-reporting friendlier. It's a</tt> </tt>
<a name="L1034"></a><tt class="py-lineno">1034</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># stack parallel to "stack" containing the index of each element's </tt> </tt>
<a name="L1035"></a><tt class="py-lineno">1035</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># open brace.</tt> </tt>
<a name="L1036"></a><tt class="py-lineno">1036</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">openbrace_stack</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="L1037"></a><tt class="py-lineno">1037</tt> <tt class="py-line"> </tt>
<a name="L1038"></a><tt class="py-lineno">1038</tt> <tt class="py-line"> <tt class="py-comment"># Process the string, scanning for '{' and '}'s. start is the</tt> </tt>
<a name="L1039"></a><tt class="py-lineno">1039</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># index of the first unprocessed character. Each time through the</tt> </tt>
<a name="L1040"></a><tt class="py-lineno">1040</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># loop, we process the text from the first unprocessed character</tt> </tt>
<a name="L1041"></a><tt class="py-lineno">1041</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># to the next open or close brace.</tt> </tt>
<a name="L1042"></a><tt class="py-lineno">1042</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">start</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L1043"></a><tt class="py-lineno">1043</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt class="py-number">1</tt><tt class="py-op">:</tt> </tt>
<a name="L1044"></a><tt class="py-lineno">1044</tt> <tt class="py-line"> <tt class="py-name">match</tt> <tt class="py-op">=</tt> <tt id="link-186" class="py-name"><a title="epydoc.markup.epytext._BRACE_RE" class="py-name" href="#" onclick="return doclink('link-186', '_BRACE_RE', 'link-182');">_BRACE_RE</a></tt><tt class="py-op">.</tt><tt class="py-name">search</tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">,</tt> <tt class="py-name">start</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">match</tt> <tt class="py-op">==</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-keyword">break</tt> </tt>
<a name="L1046"></a><tt class="py-lineno">1046</tt> <tt class="py-line"> <tt class="py-name">end</tt> <tt class="py-op">=</tt> <tt class="py-name">match</tt><tt class="py-op">.</tt><tt class="py-name">start</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>
<a name="L1048"></a><tt class="py-lineno">1048</tt> <tt class="py-line"> <tt class="py-comment"># Open braces start new colorizing elements. When preceeded</tt> </tt>
<a name="L1049"></a><tt class="py-lineno">1049</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># by a capital letter, they specify a colored region, as</tt> </tt>
<a name="L1050"></a><tt class="py-lineno">1050</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># defined by the _COLORIZING_TAGS dictionary. Otherwise, </tt> </tt>
<a name="L1051"></a><tt class="py-lineno">1051</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># use a special "literal braces" element (with tag "litbrace"),</tt> </tt>
<a name="L1052"></a><tt class="py-lineno">1052</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># and convert them to literal braces once we find the matching </tt> </tt>
<a name="L1053"></a><tt class="py-lineno">1053</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># close-brace.</tt> </tt>
<a name="L1054"></a><tt class="py-lineno">1054</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">match</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-string">'{'</tt><tt class="py-op">:</tt> </tt>
<a name="L1055"></a><tt class="py-lineno">1055</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">end</tt><tt class="py-op">></tt><tt class="py-number">0</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-string">'A'</tt> <tt class="py-op"><=</tt> <tt class="py-name">str</tt><tt class="py-op">[</tt><tt class="py-name">end</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-string">'Z'</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">if</tt> <tt class="py-op">(</tt><tt class="py-name">end</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">start</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">stack</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">children</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">[</tt><tt class="py-name">start</tt><tt class="py-op">:</tt><tt class="py-name">end</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="L1058"></a><tt class="py-lineno">1058</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">str</tt><tt class="py-op">[</tt><tt class="py-name">end</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt id="link-187" class="py-name"><a title="epydoc.markup.epytext._COLORIZING_TAGS" class="py-name" href="#" onclick="return doclink('link-187', '_COLORIZING_TAGS', 'link-27');">_COLORIZING_TAGS</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1059"></a><tt class="py-lineno">1059</tt> <tt class="py-line"> <tt class="py-name">estr</tt> <tt class="py-op">=</tt> <tt class="py-string">"Unknown inline markup tag."</tt> </tt>
<a name="L1060"></a><tt class="py-lineno">1060</tt> <tt class="py-line"> <tt class="py-name">errors</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-188" class="py-name" targets="Class epydoc.markup.epytext.ColorizingError=epydoc.markup.epytext.ColorizingError-class.html"><a title="epydoc.markup.epytext.ColorizingError" class="py-name" href="#" onclick="return doclink('link-188', 'ColorizingError', 'link-188');">ColorizingError</a></tt><tt class="py-op">(</tt><tt class="py-name">estr</tt><tt class="py-op">,</tt> <tt class="py-name">token</tt><tt class="py-op">,</tt> <tt class="py-name">end</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="L1061"></a><tt class="py-lineno">1061</tt> <tt class="py-line"> <tt class="py-name">stack</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-189" class="py-name"><a title="epydoc.markup.epytext.Element" class="py-name" href="#" onclick="return doclink('link-189', 'Element', 'link-30');">Element</a></tt><tt class="py-op">(</tt><tt class="py-string">'unknown'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1062"></a><tt class="py-lineno">1062</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1063"></a><tt class="py-lineno">1063</tt> <tt class="py-line"> <tt id="link-190" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-190', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">=</tt> <tt id="link-191" class="py-name"><a title="epydoc.markup.epytext._COLORIZING_TAGS" class="py-name" href="#" onclick="return doclink('link-191', '_COLORIZING_TAGS', 'link-27');">_COLORIZING_TAGS</a></tt><tt class="py-op">[</tt><tt class="py-name">str</tt><tt class="py-op">[</tt><tt class="py-name">end</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="L1064"></a><tt class="py-lineno">1064</tt> <tt class="py-line"> <tt class="py-name">stack</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-192" class="py-name"><a title="epydoc.markup.epytext.Element" class="py-name" href="#" onclick="return doclink('link-192', 'Element', 'link-30');">Element</a></tt><tt class="py-op">(</tt><tt id="link-193" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-193', 'tag', 'link-13');">tag</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1065"></a><tt class="py-lineno">1065</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1066"></a><tt class="py-lineno">1066</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">end</tt> <tt class="py-op">></tt> <tt class="py-name">start</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">stack</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">children</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">[</tt><tt class="py-name">start</tt><tt class="py-op">:</tt><tt class="py-name">end</tt><tt class="py-op">]</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">stack</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-194" class="py-name"><a title="epydoc.markup.epytext.Element" class="py-name" href="#" onclick="return doclink('link-194', 'Element', 'link-30');">Element</a></tt><tt class="py-op">(</tt><tt class="py-string">'litbrace'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1069"></a><tt class="py-lineno">1069</tt> <tt class="py-line"> <tt class="py-name">openbrace_stack</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">end</tt><tt class="py-op">)</tt> </tt>
<a name="L1070"></a><tt class="py-lineno">1070</tt> <tt class="py-line"> <tt class="py-name">stack</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-name">children</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">stack</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="L1071"></a><tt class="py-lineno">1071</tt> <tt class="py-line"> </tt>
<a name="L1072"></a><tt class="py-lineno">1072</tt> <tt class="py-line"> <tt class="py-comment"># Close braces end colorizing elements.</tt> </tt>
<a name="L1073"></a><tt class="py-lineno">1073</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-name">match</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-string">'}'</tt><tt class="py-op">:</tt> </tt>
<a name="L1074"></a><tt class="py-lineno">1074</tt> <tt class="py-line"> <tt class="py-comment"># Check for (and ignore) unbalanced braces.</tt> </tt>
<a name="L1075"></a><tt class="py-lineno">1075</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">stack</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="L1076"></a><tt class="py-lineno">1076</tt> <tt class="py-line"> <tt class="py-name">estr</tt> <tt class="py-op">=</tt> <tt class="py-string">"Unbalanced '}'."</tt> </tt>
<a name="L1077"></a><tt class="py-lineno">1077</tt> <tt class="py-line"> <tt class="py-name">errors</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-195" class="py-name"><a title="epydoc.markup.epytext.ColorizingError" class="py-name" href="#" onclick="return doclink('link-195', 'ColorizingError', 'link-188');">ColorizingError</a></tt><tt class="py-op">(</tt><tt class="py-name">estr</tt><tt class="py-op">,</tt> <tt class="py-name">token</tt><tt class="py-op">,</tt> <tt class="py-name">end</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1078"></a><tt class="py-lineno">1078</tt> <tt class="py-line"> <tt class="py-name">start</tt> <tt class="py-op">=</tt> <tt class="py-name">end</tt> <tt class="py-op">+</tt> <tt class="py-number">1</tt> </tt>
<a name="L1079"></a><tt class="py-lineno">1079</tt> <tt class="py-line"> <tt class="py-keyword">continue</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"># Add any remaining text.</tt> </tt>
<a name="L1082"></a><tt class="py-lineno">1082</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">end</tt> <tt class="py-op">></tt> <tt class="py-name">start</tt><tt class="py-op">:</tt> </tt>
<a name="L1083"></a><tt class="py-lineno">1083</tt> <tt class="py-line"> <tt class="py-name">stack</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">children</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">[</tt><tt class="py-name">start</tt><tt class="py-op">:</tt><tt class="py-name">end</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"># Special handling for symbols:</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">if</tt> <tt class="py-name">stack</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 id="link-196" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-196', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'symbol'</tt><tt class="py-op">:</tt> </tt>
<a name="L1087"></a><tt class="py-lineno">1087</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">stack</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">children</tt><tt class="py-op">)</tt> <tt class="py-op">!=</tt> <tt class="py-number">1</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L1088"></a><tt class="py-lineno">1088</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">stack</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">children</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">basestring</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1089"></a><tt class="py-lineno">1089</tt> <tt class="py-line"> <tt class="py-name">estr</tt> <tt class="py-op">=</tt> <tt class="py-string">"Invalid symbol code."</tt> </tt>
<a name="L1090"></a><tt class="py-lineno">1090</tt> <tt class="py-line"> <tt class="py-name">errors</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-197" class="py-name"><a title="epydoc.markup.epytext.ColorizingError" class="py-name" href="#" onclick="return doclink('link-197', 'ColorizingError', 'link-188');">ColorizingError</a></tt><tt class="py-op">(</tt><tt class="py-name">estr</tt><tt class="py-op">,</tt> <tt class="py-name">token</tt><tt class="py-op">,</tt> <tt class="py-name">end</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1091"></a><tt class="py-lineno">1091</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1092"></a><tt class="py-lineno">1092</tt> <tt class="py-line"> <tt class="py-name">symb</tt> <tt class="py-op">=</tt> <tt class="py-name">stack</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">children</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L1093"></a><tt class="py-lineno">1093</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">symb</tt> <tt class="py-keyword">in</tt> <tt id="link-198" class="py-name"><a title="epydoc.markup.epytext._SYMBOLS" class="py-name" href="#" onclick="return doclink('link-198', '_SYMBOLS', 'link-21');">_SYMBOLS</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1094"></a><tt class="py-lineno">1094</tt> <tt class="py-line"> <tt class="py-comment"># It's a symbol</tt> </tt>
<a name="L1095"></a><tt class="py-lineno">1095</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">stack</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-name">children</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 id="link-199" class="py-name"><a title="epydoc.markup.epytext.Element" class="py-name" href="#" onclick="return doclink('link-199', 'Element', 'link-30');">Element</a></tt><tt class="py-op">(</tt><tt class="py-string">'symbol'</tt><tt class="py-op">,</tt> <tt class="py-name">symb</tt><tt class="py-op">)</tt> </tt>
<a name="L1096"></a><tt class="py-lineno">1096</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1097"></a><tt class="py-lineno">1097</tt> <tt class="py-line"> <tt class="py-name">estr</tt> <tt class="py-op">=</tt> <tt class="py-string">"Invalid symbol code."</tt> </tt>
<a name="L1098"></a><tt class="py-lineno">1098</tt> <tt class="py-line"> <tt class="py-name">errors</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-200" class="py-name"><a title="epydoc.markup.epytext.ColorizingError" class="py-name" href="#" onclick="return doclink('link-200', 'ColorizingError', 'link-188');">ColorizingError</a></tt><tt class="py-op">(</tt><tt class="py-name">estr</tt><tt class="py-op">,</tt> <tt class="py-name">token</tt><tt class="py-op">,</tt> <tt class="py-name">end</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>
<a name="L1100"></a><tt class="py-lineno">1100</tt> <tt class="py-line"> <tt class="py-comment"># Special handling for escape elements:</tt> </tt>
<a name="L1101"></a><tt class="py-lineno">1101</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">stack</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 id="link-201" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-201', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'escape'</tt><tt class="py-op">:</tt> </tt>
<a name="L1102"></a><tt class="py-lineno">1102</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">stack</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">children</tt><tt class="py-op">)</tt> <tt class="py-op">!=</tt> <tt class="py-number">1</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L1103"></a><tt class="py-lineno">1103</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">stack</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">children</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">basestring</tt><tt class="py-op">)</tt><tt class="py-op">)</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">estr</tt> <tt class="py-op">=</tt> <tt class="py-string">"Invalid escape code."</tt> </tt>
<a name="L1105"></a><tt class="py-lineno">1105</tt> <tt class="py-line"> <tt class="py-name">errors</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-202" class="py-name"><a title="epydoc.markup.epytext.ColorizingError" class="py-name" href="#" onclick="return doclink('link-202', 'ColorizingError', 'link-188');">ColorizingError</a></tt><tt class="py-op">(</tt><tt class="py-name">estr</tt><tt class="py-op">,</tt> <tt class="py-name">token</tt><tt class="py-op">,</tt> <tt class="py-name">end</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-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1107"></a><tt class="py-lineno">1107</tt> <tt class="py-line"> <tt class="py-name">escp</tt> <tt class="py-op">=</tt> <tt class="py-name">stack</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">children</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L1108"></a><tt class="py-lineno">1108</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">escp</tt> <tt class="py-keyword">in</tt> <tt id="link-203" class="py-name"><a title="epydoc.markup.epytext._ESCAPES" class="py-name" href="#" onclick="return doclink('link-203', '_ESCAPES', 'link-19');">_ESCAPES</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1109"></a><tt class="py-lineno">1109</tt> <tt class="py-line"> <tt class="py-comment"># It's an escape from _ESCPAES</tt> </tt>
<a name="L1110"></a><tt class="py-lineno">1110</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">stack</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-name">children</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 id="link-204" class="py-name"><a title="epydoc.markup.epytext._ESCAPES" class="py-name" href="#" onclick="return doclink('link-204', '_ESCAPES', 'link-19');">_ESCAPES</a></tt><tt class="py-op">[</tt><tt class="py-name">escp</tt><tt class="py-op">]</tt> </tt>
<a name="L1111"></a><tt class="py-lineno">1111</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">escp</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="L1112"></a><tt class="py-lineno">1112</tt> <tt class="py-line"> <tt class="py-comment"># It's a single-character escape (eg E{.})</tt> </tt>
<a name="L1113"></a><tt class="py-lineno">1113</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">stack</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-name">children</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">escp</tt> </tt>
<a name="L1114"></a><tt class="py-lineno">1114</tt> <tt class="py-line"> <tt class="py-keyword">else</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">estr</tt> <tt class="py-op">=</tt> <tt class="py-string">"Invalid escape code."</tt> </tt>
<a name="L1116"></a><tt class="py-lineno">1116</tt> <tt class="py-line"> <tt class="py-name">errors</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-205" class="py-name"><a title="epydoc.markup.epytext.ColorizingError" class="py-name" href="#" onclick="return doclink('link-205', 'ColorizingError', 'link-188');">ColorizingError</a></tt><tt class="py-op">(</tt><tt class="py-name">estr</tt><tt class="py-op">,</tt> <tt class="py-name">token</tt><tt class="py-op">,</tt> <tt class="py-name">end</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1117"></a><tt class="py-lineno">1117</tt> <tt class="py-line"> </tt>
<a name="L1118"></a><tt class="py-lineno">1118</tt> <tt class="py-line"> <tt class="py-comment"># Special handling for literal braces elements:</tt> </tt>
<a name="L1119"></a><tt class="py-lineno">1119</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">stack</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 id="link-206" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-206', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'litbrace'</tt><tt class="py-op">:</tt> </tt>
<a name="L1120"></a><tt class="py-lineno">1120</tt> <tt class="py-line"> <tt class="py-name">stack</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-name">children</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-op">[</tt><tt class="py-string">'{'</tt><tt class="py-op">]</tt> <tt class="py-op">+</tt> <tt class="py-name">stack</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">children</tt> <tt class="py-op">+</tt> <tt class="py-op">[</tt><tt class="py-string">'}'</tt><tt class="py-op">]</tt> </tt>
<a name="L1121"></a><tt class="py-lineno">1121</tt> <tt class="py-line"> </tt>
<a name="L1122"></a><tt class="py-lineno">1122</tt> <tt class="py-line"> <tt class="py-comment"># Special handling for graphs:</tt> </tt>
<a name="L1123"></a><tt class="py-lineno">1123</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">stack</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 id="link-207" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-207', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'graph'</tt><tt class="py-op">:</tt> </tt>
<a name="L1124"></a><tt class="py-lineno">1124</tt> <tt class="py-line"> <tt id="link-208" class="py-name" targets="Function epydoc.markup.epytext._colorize_graph()=epydoc.markup.epytext-module.html#_colorize_graph"><a title="epydoc.markup.epytext._colorize_graph" class="py-name" href="#" onclick="return doclink('link-208', '_colorize_graph', 'link-208');">_colorize_graph</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-name">stack</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">token</tt><tt class="py-op">,</tt> <tt class="py-name">end</tt><tt class="py-op">,</tt> <tt class="py-name">errors</tt><tt class="py-op">)</tt> </tt>
<a name="L1125"></a><tt class="py-lineno">1125</tt> <tt class="py-line"> </tt>
<a name="L1126"></a><tt class="py-lineno">1126</tt> <tt class="py-line"> <tt class="py-comment"># Special handling for link-type elements:</tt> </tt>
<a name="L1127"></a><tt class="py-lineno">1127</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">stack</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 id="link-209" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-209', 'tag', 'link-13');">tag</a></tt> <tt class="py-keyword">in</tt> <tt id="link-210" class="py-name"><a title="epydoc.markup.epytext._LINK_COLORIZING_TAGS" class="py-name" href="#" onclick="return doclink('link-210', '_LINK_COLORIZING_TAGS', 'link-28');">_LINK_COLORIZING_TAGS</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1128"></a><tt class="py-lineno">1128</tt> <tt class="py-line"> <tt id="link-211" class="py-name" targets="Function epydoc.markup.epytext._colorize_link()=epydoc.markup.epytext-module.html#_colorize_link"><a title="epydoc.markup.epytext._colorize_link" class="py-name" href="#" onclick="return doclink('link-211', '_colorize_link', 'link-211');">_colorize_link</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-name">stack</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">token</tt><tt class="py-op">,</tt> <tt class="py-name">end</tt><tt class="py-op">,</tt> <tt class="py-name">errors</tt><tt class="py-op">)</tt> </tt>
<a name="L1129"></a><tt class="py-lineno">1129</tt> <tt class="py-line"> </tt>
<a name="L1130"></a><tt class="py-lineno">1130</tt> <tt class="py-line"> <tt class="py-comment"># Pop the completed element.</tt> </tt>
<a name="L1131"></a><tt class="py-lineno">1131</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">openbrace_stack</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="L1132"></a><tt class="py-lineno">1132</tt> <tt class="py-line"> <tt class="py-name">stack</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="L1133"></a><tt class="py-lineno">1133</tt> <tt class="py-line"> </tt>
<a name="L1134"></a><tt class="py-lineno">1134</tt> <tt class="py-line"> <tt class="py-name">start</tt> <tt class="py-op">=</tt> <tt class="py-name">end</tt><tt class="py-op">+</tt><tt class="py-number">1</tt> </tt>
<a name="L1135"></a><tt class="py-lineno">1135</tt> <tt class="py-line"> </tt>
<a name="L1136"></a><tt class="py-lineno">1136</tt> <tt class="py-line"> <tt class="py-comment"># Add any final text.</tt> </tt>
<a name="L1137"></a><tt class="py-lineno">1137</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">start</tt> <tt class="py-op"><</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">str</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">stack</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">children</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">[</tt><tt class="py-name">start</tt><tt class="py-op">:</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L1139"></a><tt class="py-lineno">1139</tt> <tt class="py-line"> </tt>
<a name="L1140"></a><tt class="py-lineno">1140</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">stack</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="L1141"></a><tt class="py-lineno">1141</tt> <tt class="py-line"> <tt class="py-name">estr</tt> <tt class="py-op">=</tt> <tt class="py-string">"Unbalanced '{'."</tt> </tt>
<a name="L1142"></a><tt class="py-lineno">1142</tt> <tt class="py-line"> <tt class="py-name">errors</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-212" class="py-name"><a title="epydoc.markup.epytext.ColorizingError" class="py-name" href="#" onclick="return doclink('link-212', 'ColorizingError', 'link-188');">ColorizingError</a></tt><tt class="py-op">(</tt><tt class="py-name">estr</tt><tt class="py-op">,</tt> <tt class="py-name">token</tt><tt class="py-op">,</tt> <tt class="py-name">openbrace_stack</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="L1143"></a><tt class="py-lineno">1143</tt> <tt class="py-line"> </tt>
<a name="L1144"></a><tt class="py-lineno">1144</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">stack</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
</div><a name="L1145"></a><tt class="py-lineno">1145</tt> <tt class="py-line"> </tt>
<a name="L1146"></a><tt class="py-lineno">1146</tt> <tt class="py-line"><tt id="link-213" class="py-name" targets="Variable epydoc.cli.GRAPH_TYPES=epydoc.cli-module.html#GRAPH_TYPES,Variable epydoc.markup.epytext.GRAPH_TYPES=epydoc.markup.epytext-module.html#GRAPH_TYPES"><a title="epydoc.cli.GRAPH_TYPES
epydoc.markup.epytext.GRAPH_TYPES" class="py-name" href="#" onclick="return doclink('link-213', 'GRAPH_TYPES', 'link-213');">GRAPH_TYPES</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">'classtree'</tt><tt class="py-op">,</tt> <tt class="py-string">'packagetree'</tt><tt class="py-op">,</tt> <tt class="py-string">'importgraph'</tt><tt class="py-op">,</tt> <tt class="py-string">'callgraph'</tt><tt class="py-op">]</tt> </tt>
<a name="L1147"></a><tt class="py-lineno">1147</tt> <tt class="py-line"> </tt>
<a name="_colorize_graph"></a><div id="_colorize_graph-def"><a name="L1148"></a><tt class="py-lineno">1148</tt> <a class="py-toggle" href="#" id="_colorize_graph-toggle" onclick="return toggle('_colorize_graph');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext-module.html#_colorize_graph">_colorize_graph</a><tt class="py-op">(</tt><tt class="py-param">doc</tt><tt class="py-op">,</tt> <tt class="py-param">graph</tt><tt class="py-op">,</tt> <tt class="py-param">token</tt><tt class="py-op">,</tt> <tt class="py-param">end</tt><tt class="py-op">,</tt> <tt class="py-param">errors</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_colorize_graph-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_colorize_graph-expanded"><a name="L1149"></a><tt class="py-lineno">1149</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1150"></a><tt class="py-lineno">1150</tt> <tt class="py-line"><tt class="py-docstring"> Eg::</tt> </tt>
<a name="L1151"></a><tt class="py-lineno">1151</tt> <tt class="py-line"><tt class="py-docstring"> G{classtree}</tt> </tt>
<a name="L1152"></a><tt class="py-lineno">1152</tt> <tt class="py-line"><tt class="py-docstring"> G{classtree x, y, z}</tt> </tt>
<a name="L1153"></a><tt class="py-lineno">1153</tt> <tt class="py-line"><tt class="py-docstring"> G{importgraph}</tt> </tt>
<a name="L1154"></a><tt class="py-lineno">1154</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1155"></a><tt class="py-lineno">1155</tt> <tt class="py-line"> <tt class="py-name">bad_graph_spec</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L1156"></a><tt class="py-lineno">1156</tt> <tt class="py-line"> </tt>
<a name="L1157"></a><tt class="py-lineno">1157</tt> <tt class="py-line"> <tt class="py-name">children</tt> <tt class="py-op">=</tt> <tt id="link-214" 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-214', 'graph', 'link-214');">graph</a></tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L1158"></a><tt class="py-lineno">1158</tt> <tt class="py-line"> <tt id="link-215" class="py-name"><a title="epydoc.markup.restructuredtext.dotgraph.graph" class="py-name" href="#" onclick="return doclink('link-215', 'graph', 'link-214');">graph</a></tt><tt class="py-op">.</tt><tt class="py-name">children</tt> <tt class="py-op">=</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>
<a name="L1160"></a><tt class="py-lineno">1160</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">children</tt><tt class="py-op">)</tt> <tt class="py-op">!=</tt> <tt class="py-number">1</tt> <tt class="py-keyword">or</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">children</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">basestring</tt><tt class="py-op">)</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">bad_graph_spec</tt> <tt class="py-op">=</tt> <tt class="py-string">"Bad graph specification"</tt> </tt>
<a name="L1162"></a><tt class="py-lineno">1162</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1163"></a><tt class="py-lineno">1163</tt> <tt class="py-line"> <tt class="py-name">pieces</tt> <tt class="py-op">=</tt> <tt class="py-name">children</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">split</tt><tt class="py-op">(</tt><tt class="py-name">None</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">graphtype</tt> <tt class="py-op">=</tt> <tt class="py-name">pieces</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">replace</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-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-name">lower</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1165"></a><tt class="py-lineno">1165</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">graphtype</tt> <tt class="py-keyword">in</tt> <tt id="link-216" class="py-name"><a title="epydoc.cli.GRAPH_TYPES
epydoc.markup.epytext.GRAPH_TYPES" class="py-name" href="#" onclick="return doclink('link-216', 'GRAPH_TYPES', 'link-213');">GRAPH_TYPES</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1166"></a><tt class="py-lineno">1166</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">pieces</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">2</tt><tt class="py-op">:</tt> </tt>
<a name="L1167"></a><tt class="py-lineno">1167</tt> <tt class="py-line"> <tt class="py-keyword">if</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'\s*:?\s*([\w\.]+\s*,?\s*)*'</tt><tt class="py-op">,</tt> <tt class="py-name">pieces</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="L1168"></a><tt class="py-lineno">1168</tt> <tt class="py-line"> <tt class="py-name">args</tt> <tt class="py-op">=</tt> <tt class="py-name">pieces</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">replace</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-op">.</tt><tt class="py-name">replace</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-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1169"></a><tt class="py-lineno">1169</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1170"></a><tt class="py-lineno">1170</tt> <tt class="py-line"> <tt class="py-name">bad_graph_spec</tt> <tt class="py-op">=</tt> <tt class="py-string">"Bad graph arg list"</tt> </tt>
<a name="L1171"></a><tt class="py-lineno">1171</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1172"></a><tt class="py-lineno">1172</tt> <tt class="py-line"> <tt class="py-name">args</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L1173"></a><tt class="py-lineno">1173</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1174"></a><tt class="py-lineno">1174</tt> <tt class="py-line"> <tt class="py-name">bad_graph_spec</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">"Bad graph type %s -- use one of %s"</tt> <tt class="py-op">%</tt> </tt>
<a name="L1175"></a><tt class="py-lineno">1175</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">pieces</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-string">', '</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt id="link-217" class="py-name"><a title="epydoc.cli.GRAPH_TYPES
epydoc.markup.epytext.GRAPH_TYPES" class="py-name" href="#" onclick="return doclink('link-217', 'GRAPH_TYPES', 'link-213');">GRAPH_TYPES</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1176"></a><tt class="py-lineno">1176</tt> <tt class="py-line"> </tt>
<a name="L1177"></a><tt class="py-lineno">1177</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">bad_graph_spec</tt><tt class="py-op">:</tt> </tt>
<a name="L1178"></a><tt class="py-lineno">1178</tt> <tt class="py-line"> <tt class="py-name">errors</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-218" class="py-name"><a title="epydoc.markup.epytext.ColorizingError" class="py-name" href="#" onclick="return doclink('link-218', 'ColorizingError', 'link-188');">ColorizingError</a></tt><tt class="py-op">(</tt><tt class="py-name">bad_graph_spec</tt><tt class="py-op">,</tt> <tt class="py-name">token</tt><tt class="py-op">,</tt> <tt class="py-name">end</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1179"></a><tt class="py-lineno">1179</tt> <tt class="py-line"> <tt id="link-219" class="py-name"><a title="epydoc.markup.restructuredtext.dotgraph.graph" class="py-name" href="#" onclick="return doclink('link-219', 'graph', 'link-214');">graph</a></tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">'none'</tt><tt class="py-op">)</tt> </tt>
<a name="L1180"></a><tt class="py-lineno">1180</tt> <tt class="py-line"> <tt id="link-220" class="py-name"><a title="epydoc.markup.restructuredtext.dotgraph.graph" class="py-name" href="#" onclick="return doclink('link-220', 'graph', 'link-214');">graph</a></tt><tt class="py-op">.</tt><tt class="py-name">children</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>
<a name="L1181"></a><tt class="py-lineno">1181</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
<a name="L1182"></a><tt class="py-lineno">1182</tt> <tt class="py-line"> </tt>
<a name="L1183"></a><tt class="py-lineno">1183</tt> <tt class="py-line"> <tt id="link-221" class="py-name"><a title="epydoc.markup.restructuredtext.dotgraph.graph" class="py-name" href="#" onclick="return doclink('link-221', 'graph', 'link-214');">graph</a></tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">graphtype</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">for</tt> <tt id="link-222" 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-222', 'arg', 'link-222');">arg</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">args</tt><tt class="py-op">:</tt> </tt>
<a name="L1185"></a><tt class="py-lineno">1185</tt> <tt class="py-line"> <tt id="link-223" class="py-name"><a title="epydoc.markup.restructuredtext.dotgraph.graph" class="py-name" href="#" onclick="return doclink('link-223', 'graph', 'link-214');">graph</a></tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-224" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-224', 'arg', 'link-222');">arg</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L1186"></a><tt class="py-lineno">1186</tt> <tt class="py-line"> </tt>
<a name="_colorize_link"></a><div id="_colorize_link-def"><a name="L1187"></a><tt class="py-lineno">1187</tt> <a class="py-toggle" href="#" id="_colorize_link-toggle" onclick="return toggle('_colorize_link');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext-module.html#_colorize_link">_colorize_link</a><tt class="py-op">(</tt><tt class="py-param">doc</tt><tt class="py-op">,</tt> <tt class="py-param">link</tt><tt class="py-op">,</tt> <tt class="py-param">token</tt><tt class="py-op">,</tt> <tt class="py-param">end</tt><tt class="py-op">,</tt> <tt class="py-param">errors</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_colorize_link-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_colorize_link-expanded"><a name="L1188"></a><tt class="py-lineno">1188</tt> <tt class="py-line"> <tt id="link-225" 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-225', 'variables', 'link-225');">variables</a></tt> <tt class="py-op">=</tt> <tt id="link-226" class="py-name" targets="Method epydoc.docwriter.dotgraph.DotGraph.link()=epydoc.docwriter.dotgraph.DotGraph-class.html#link"><a title="epydoc.docwriter.dotgraph.DotGraph.link" class="py-name" href="#" onclick="return doclink('link-226', 'link', 'link-226');">link</a></tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L1189"></a><tt class="py-lineno">1189</tt> <tt class="py-line"> </tt>
<a name="L1190"></a><tt class="py-lineno">1190</tt> <tt class="py-line"> <tt class="py-comment"># If the last child isn't text, we know it's bad.</tt> </tt>
<a name="L1191"></a><tt class="py-lineno">1191</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-227" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-227', 'variables', 'link-225');">variables</a></tt><tt class="py-op">)</tt><tt class="py-op">==</tt><tt class="py-number">0</tt> <tt class="py-keyword">or</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt id="link-228" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-228', 'variables', 'link-225');">variables</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">basestring</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1192"></a><tt class="py-lineno">1192</tt> <tt class="py-line"> <tt class="py-name">estr</tt> <tt class="py-op">=</tt> <tt class="py-string">"Bad %s target."</tt> <tt class="py-op">%</tt> <tt id="link-229" class="py-name"><a title="epydoc.docwriter.dotgraph.DotGraph.link" class="py-name" href="#" onclick="return doclink('link-229', 'link', 'link-226');">link</a></tt><tt class="py-op">.</tt><tt id="link-230" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-230', 'tag', 'link-13');">tag</a></tt> </tt>
<a name="L1193"></a><tt class="py-lineno">1193</tt> <tt class="py-line"> <tt class="py-name">errors</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-231" class="py-name"><a title="epydoc.markup.epytext.ColorizingError" class="py-name" href="#" onclick="return doclink('link-231', 'ColorizingError', 'link-188');">ColorizingError</a></tt><tt class="py-op">(</tt><tt class="py-name">estr</tt><tt class="py-op">,</tt> <tt class="py-name">token</tt><tt class="py-op">,</tt> <tt class="py-name">end</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1194"></a><tt class="py-lineno">1194</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
<a name="L1195"></a><tt class="py-lineno">1195</tt> <tt class="py-line"> </tt>
<a name="L1196"></a><tt class="py-lineno">1196</tt> <tt class="py-line"> <tt class="py-comment"># Did they provide an explicit target?</tt> </tt>
<a name="L1197"></a><tt class="py-lineno">1197</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">match2</tt> <tt class="py-op">=</tt> <tt id="link-232" class="py-name"><a title="epydoc.markup.epytext._TARGET_RE" class="py-name" href="#" onclick="return doclink('link-232', '_TARGET_RE', 'link-183');">_TARGET_RE</a></tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt id="link-233" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-233', 'variables', 'link-225');">variables</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="L1198"></a><tt class="py-lineno">1198</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">match2</tt><tt class="py-op">:</tt> </tt>
<a name="L1199"></a><tt class="py-lineno">1199</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">text</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-name">match2</tt><tt class="py-op">.</tt><tt class="py-name">groups</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1200"></a><tt class="py-lineno">1200</tt> <tt class="py-line"> <tt id="link-234" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-234', 'variables', 'link-225');">variables</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">text</tt> </tt>
<a name="L1201"></a><tt class="py-lineno">1201</tt> <tt class="py-line"> <tt class="py-comment"># Can we extract an implicit target?</tt> </tt>
<a name="L1202"></a><tt class="py-lineno">1202</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-235" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-235', 'variables', 'link-225');">variables</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="L1203"></a><tt class="py-lineno">1203</tt> <tt class="py-line"> <tt class="py-name">target</tt> <tt class="py-op">=</tt> <tt id="link-236" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-236', 'variables', 'link-225');">variables</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L1204"></a><tt class="py-lineno">1204</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1205"></a><tt class="py-lineno">1205</tt> <tt class="py-line"> <tt class="py-name">estr</tt> <tt class="py-op">=</tt> <tt class="py-string">"Bad %s target."</tt> <tt class="py-op">%</tt> <tt id="link-237" class="py-name"><a title="epydoc.docwriter.dotgraph.DotGraph.link" class="py-name" href="#" onclick="return doclink('link-237', 'link', 'link-226');">link</a></tt><tt class="py-op">.</tt><tt id="link-238" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-238', 'tag', 'link-13');">tag</a></tt> </tt>
<a name="L1206"></a><tt class="py-lineno">1206</tt> <tt class="py-line"> <tt class="py-name">errors</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-239" class="py-name"><a title="epydoc.markup.epytext.ColorizingError" class="py-name" href="#" onclick="return doclink('link-239', 'ColorizingError', 'link-188');">ColorizingError</a></tt><tt class="py-op">(</tt><tt class="py-name">estr</tt><tt class="py-op">,</tt> <tt class="py-name">token</tt><tt class="py-op">,</tt> <tt class="py-name">end</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1207"></a><tt class="py-lineno">1207</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
<a name="L1208"></a><tt class="py-lineno">1208</tt> <tt class="py-line"> </tt>
<a name="L1209"></a><tt class="py-lineno">1209</tt> <tt class="py-line"> <tt class="py-comment"># Construct the name element.</tt> </tt>
<a name="L1210"></a><tt class="py-lineno">1210</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">name_elt</tt> <tt class="py-op">=</tt> <tt id="link-240" class="py-name"><a title="epydoc.markup.epytext.Element" class="py-name" href="#" onclick="return doclink('link-240', 'Element', 'link-30');">Element</a></tt><tt class="py-op">(</tt><tt class="py-string">'name'</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt id="link-241" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-241', 'variables', 'link-225');">variables</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1211"></a><tt class="py-lineno">1211</tt> <tt class="py-line"> </tt>
<a name="L1212"></a><tt class="py-lineno">1212</tt> <tt class="py-line"> <tt class="py-comment"># Clean up the target. For URIs, assume http or mailto if they</tt> </tt>
<a name="L1213"></a><tt class="py-lineno">1213</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># don't specify (no relative urls)</tt> </tt>
<a name="L1214"></a><tt class="py-lineno">1214</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">target</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">''</tt><tt class="py-op">,</tt> <tt class="py-name">target</tt><tt class="py-op">)</tt> </tt>
<a name="L1215"></a><tt class="py-lineno">1215</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-242" class="py-name"><a title="epydoc.docwriter.dotgraph.DotGraph.link" class="py-name" href="#" onclick="return doclink('link-242', 'link', 'link-226');">link</a></tt><tt class="py-op">.</tt><tt id="link-243" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-243', 'tag', 'link-13');">tag</a></tt><tt class="py-op">==</tt><tt class="py-string">'uri'</tt><tt class="py-op">:</tt> </tt>
<a name="L1216"></a><tt class="py-lineno">1216</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</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'\w+:'</tt><tt class="py-op">,</tt> <tt class="py-name">target</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1217"></a><tt class="py-lineno">1217</tt> <tt class="py-line"> <tt class="py-keyword">if</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'\w+@(\w+)(\.\w+)*'</tt><tt class="py-op">,</tt> <tt class="py-name">target</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1218"></a><tt class="py-lineno">1218</tt> <tt class="py-line"> <tt class="py-name">target</tt> <tt class="py-op">=</tt> <tt class="py-string">'mailto:'</tt> <tt class="py-op">+</tt> <tt class="py-name">target</tt> </tt>
<a name="L1219"></a><tt class="py-lineno">1219</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1220"></a><tt class="py-lineno">1220</tt> <tt class="py-line"> <tt class="py-name">target</tt> <tt class="py-op">=</tt> <tt class="py-string">'http://'</tt><tt class="py-op">+</tt><tt class="py-name">target</tt> </tt>
<a name="L1221"></a><tt class="py-lineno">1221</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt id="link-244" class="py-name"><a title="epydoc.docwriter.dotgraph.DotGraph.link" class="py-name" href="#" onclick="return doclink('link-244', 'link', 'link-226');">link</a></tt><tt class="py-op">.</tt><tt id="link-245" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-245', 'tag', 'link-13');">tag</a></tt><tt class="py-op">==</tt><tt class="py-string">'link'</tt><tt class="py-op">:</tt> </tt>
<a name="L1222"></a><tt class="py-lineno">1222</tt> <tt class="py-line"> <tt class="py-comment"># Remove arg lists for functions (e.g., L{_colorize_link()})</tt> </tt>
<a name="L1223"></a><tt class="py-lineno">1223</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">target</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'\(.*\)$'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">,</tt> <tt class="py-name">target</tt><tt class="py-op">)</tt> </tt>
<a name="L1224"></a><tt class="py-lineno">1224</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</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'^[a-zA-Z_]\w*(\.[a-zA-Z_]\w*)*$'</tt><tt class="py-op">,</tt> <tt class="py-name">target</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1225"></a><tt class="py-lineno">1225</tt> <tt class="py-line"> <tt class="py-name">estr</tt> <tt class="py-op">=</tt> <tt class="py-string">"Bad link target."</tt> </tt>
<a name="L1226"></a><tt class="py-lineno">1226</tt> <tt class="py-line"> <tt class="py-name">errors</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-246" class="py-name"><a title="epydoc.markup.epytext.ColorizingError" class="py-name" href="#" onclick="return doclink('link-246', 'ColorizingError', 'link-188');">ColorizingError</a></tt><tt class="py-op">(</tt><tt class="py-name">estr</tt><tt class="py-op">,</tt> <tt class="py-name">token</tt><tt class="py-op">,</tt> <tt class="py-name">end</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1227"></a><tt class="py-lineno">1227</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
<a name="L1228"></a><tt class="py-lineno">1228</tt> <tt class="py-line"> </tt>
<a name="L1229"></a><tt class="py-lineno">1229</tt> <tt class="py-line"> <tt class="py-comment"># Construct the target element.</tt> </tt>
<a name="L1230"></a><tt class="py-lineno">1230</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">target_elt</tt> <tt class="py-op">=</tt> <tt id="link-247" class="py-name"><a title="epydoc.markup.epytext.Element" class="py-name" href="#" onclick="return doclink('link-247', 'Element', 'link-30');">Element</a></tt><tt class="py-op">(</tt><tt class="py-string">'target'</tt><tt class="py-op">,</tt> <tt class="py-name">target</tt><tt class="py-op">)</tt> </tt>
<a name="L1231"></a><tt class="py-lineno">1231</tt> <tt class="py-line"> </tt>
<a name="L1232"></a><tt class="py-lineno">1232</tt> <tt class="py-line"> <tt class="py-comment"># Add them to the link element.</tt> </tt>
<a name="L1233"></a><tt class="py-lineno">1233</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-248" class="py-name"><a title="epydoc.docwriter.dotgraph.DotGraph.link" class="py-name" href="#" onclick="return doclink('link-248', 'link', 'link-226');">link</a></tt><tt class="py-op">.</tt><tt class="py-name">children</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">name_elt</tt><tt class="py-op">,</tt> <tt class="py-name">target_elt</tt><tt class="py-op">]</tt> </tt>
</div><a name="L1234"></a><tt class="py-lineno">1234</tt> <tt class="py-line"> </tt>
<a name="L1235"></a><tt class="py-lineno">1235</tt> <tt class="py-line"><tt class="py-comment">##################################################</tt> </tt>
<a name="L1236"></a><tt class="py-lineno">1236</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## Formatters</tt> </tt>
<a name="L1237"></a><tt class="py-lineno">1237</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">##################################################</tt> </tt>
<a name="L1238"></a><tt class="py-lineno">1238</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="to_epytext"></a><div id="to_epytext-def"><a name="L1239"></a><tt class="py-lineno">1239</tt> <a class="py-toggle" href="#" id="to_epytext-toggle" onclick="return toggle('to_epytext');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext-module.html#to_epytext">to_epytext</a><tt class="py-op">(</tt><tt class="py-param">tree</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-param">seclevel</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="to_epytext-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="to_epytext-expanded"><a name="L1240"></a><tt class="py-lineno">1240</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1241"></a><tt class="py-lineno">1241</tt> <tt class="py-line"><tt class="py-docstring"> Convert a DOM document encoding epytext back to an epytext string.</tt> </tt>
<a name="L1242"></a><tt class="py-lineno">1242</tt> <tt class="py-line"><tt class="py-docstring"> This is the inverse operation from L{parse}. I.e., assuming there</tt> </tt>
<a name="L1243"></a><tt class="py-lineno">1243</tt> <tt class="py-line"><tt class="py-docstring"> are no errors, the following is true:</tt> </tt>
<a name="L1244"></a><tt class="py-lineno">1244</tt> <tt class="py-line"><tt class="py-docstring"> - C{parse(to_epytext(tree)) == tree}</tt> </tt>
<a name="L1245"></a><tt class="py-lineno">1245</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1246"></a><tt class="py-lineno">1246</tt> <tt class="py-line"><tt class="py-docstring"> The inverse is true, except that whitespace, line wrapping, and</tt> </tt>
<a name="L1247"></a><tt class="py-lineno">1247</tt> <tt class="py-line"><tt class="py-docstring"> character escaping may be done differently.</tt> </tt>
<a name="L1248"></a><tt class="py-lineno">1248</tt> <tt class="py-line"><tt class="py-docstring"> - C{to_epytext(parse(str)) == str} (approximately)</tt> </tt>
<a name="L1249"></a><tt class="py-lineno">1249</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1250"></a><tt class="py-lineno">1250</tt> <tt class="py-line"><tt class="py-docstring"> @param tree: A DOM document encoding of an epytext string.</tt> </tt>
<a name="L1251"></a><tt class="py-lineno">1251</tt> <tt class="py-line"><tt class="py-docstring"> @type tree: C{Element}</tt> </tt>
<a name="L1252"></a><tt class="py-lineno">1252</tt> <tt class="py-line"><tt class="py-docstring"> @param indent: The indentation for the string representation of</tt> </tt>
<a name="L1253"></a><tt class="py-lineno">1253</tt> <tt class="py-line"><tt class="py-docstring"> C{tree}. Each line of the returned string will begin with</tt> </tt>
<a name="L1254"></a><tt class="py-lineno">1254</tt> <tt class="py-line"><tt class="py-docstring"> C{indent} space characters.</tt> </tt>
<a name="L1255"></a><tt class="py-lineno">1255</tt> <tt class="py-line"><tt class="py-docstring"> @type indent: C{int}</tt> </tt>
<a name="L1256"></a><tt class="py-lineno">1256</tt> <tt class="py-line"><tt class="py-docstring"> @param seclevel: The section level that C{tree} appears at. This</tt> </tt>
<a name="L1257"></a><tt class="py-lineno">1257</tt> <tt class="py-line"><tt class="py-docstring"> is used to generate section headings.</tt> </tt>
<a name="L1258"></a><tt class="py-lineno">1258</tt> <tt class="py-line"><tt class="py-docstring"> @type seclevel: C{int}</tt> </tt>
<a name="L1259"></a><tt class="py-lineno">1259</tt> <tt class="py-line"><tt class="py-docstring"> @return: The epytext string corresponding to C{tree}.</tt> </tt>
<a name="L1260"></a><tt class="py-lineno">1260</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{string}</tt> </tt>
<a name="L1261"></a><tt class="py-lineno">1261</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1262"></a><tt class="py-lineno">1262</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">tree</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="L1263"></a><tt class="py-lineno">1263</tt> <tt class="py-line"> <tt class="py-name">str</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'\{'</tt><tt class="py-op">,</tt> <tt class="py-string">'\0'</tt><tt class="py-op">,</tt> <tt class="py-name">tree</tt><tt class="py-op">)</tt> </tt>
<a name="L1264"></a><tt class="py-lineno">1264</tt> <tt class="py-line"> <tt class="py-name">str</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'\}'</tt><tt class="py-op">,</tt> <tt class="py-string">'\1'</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
<a name="L1265"></a><tt class="py-lineno">1265</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">str</tt> </tt>
<a name="L1266"></a><tt class="py-lineno">1266</tt> <tt class="py-line"> </tt>
<a name="L1267"></a><tt class="py-lineno">1267</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-249" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-249', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'epytext'</tt><tt class="py-op">:</tt> <tt class="py-name">indent</tt> <tt class="py-op">-=</tt> <tt class="py-number">2</tt> </tt>
<a name="L1268"></a><tt class="py-lineno">1268</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-250" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-250', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'section'</tt><tt class="py-op">:</tt> <tt class="py-name">seclevel</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L1269"></a><tt class="py-lineno">1269</tt> <tt class="py-line"> <tt id="link-251" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-251', 'variables', 'link-225');">variables</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt id="link-252" class="py-name" targets="Function epydoc.markup.epytext.to_epytext()=epydoc.markup.epytext-module.html#to_epytext"><a title="epydoc.markup.epytext.to_epytext" class="py-name" href="#" onclick="return doclink('link-252', 'to_epytext', 'link-252');">to_epytext</a></tt><tt class="py-op">(</tt><tt class="py-name">c</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-name">seclevel</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">c</tt> <tt class="py-keyword">in</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">]</tt> </tt>
<a name="L1270"></a><tt class="py-lineno">1270</tt> <tt class="py-line"> <tt class="py-name">childstr</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 id="link-253" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-253', 'variables', 'link-225');">variables</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1271"></a><tt class="py-lineno">1271</tt> <tt class="py-line"> </tt>
<a name="L1272"></a><tt class="py-lineno">1272</tt> <tt class="py-line"> <tt class="py-comment"># Clean up for literal blocks (add the double "::" back)</tt> </tt>
<a name="L1273"></a><tt class="py-lineno">1273</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">childstr</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">':(\s*)\2'</tt><tt class="py-op">,</tt> <tt class="py-string">'::\\1'</tt><tt class="py-op">,</tt> <tt class="py-name">childstr</tt><tt class="py-op">)</tt> </tt>
<a name="L1274"></a><tt class="py-lineno">1274</tt> <tt class="py-line"> </tt>
<a name="L1275"></a><tt class="py-lineno">1275</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-254" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-254', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'para'</tt><tt class="py-op">:</tt> </tt>
<a name="L1276"></a><tt class="py-lineno">1276</tt> <tt class="py-line"> <tt class="py-name">str</tt> <tt class="py-op">=</tt> <tt id="link-255" class="py-name"><a title="epydoc.util.wordwrap" class="py-name" href="#" onclick="return doclink('link-255', 'wordwrap', 'link-5');">wordwrap</a></tt><tt class="py-op">(</tt><tt class="py-name">childstr</tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">)</tt><tt class="py-op">+</tt><tt class="py-string">'\n'</tt> </tt>
<a name="L1277"></a><tt class="py-lineno">1277</tt> <tt class="py-line"> <tt class="py-name">str</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'((^|\n)\s*\d+)\.'</tt><tt class="py-op">,</tt> <tt class="py-string">r'\1E{.}'</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
<a name="L1278"></a><tt class="py-lineno">1278</tt> <tt class="py-line"> <tt class="py-name">str</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'((^|\n)\s*)-'</tt><tt class="py-op">,</tt> <tt class="py-string">r'\1E{-}'</tt><tt class="py-op">,</tt> <tt class="py-name">str</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">str</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'((^|\n)\s*)@'</tt><tt class="py-op">,</tt> <tt class="py-string">r'\1E{@}'</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
<a name="L1280"></a><tt class="py-lineno">1280</tt> <tt class="py-line"> <tt class="py-name">str</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*($|\n))'</tt><tt class="py-op">,</tt> <tt class="py-string">r'E{:}E{:}\1'</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
<a name="L1281"></a><tt class="py-lineno">1281</tt> <tt class="py-line"> <tt class="py-name">str</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">'\0'</tt><tt class="py-op">,</tt> <tt class="py-string">'E{lb}'</tt><tt class="py-op">,</tt> <tt class="py-name">str</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">str</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">'\1'</tt><tt class="py-op">,</tt> <tt class="py-string">'E{rb}'</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
<a name="L1283"></a><tt class="py-lineno">1283</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">str</tt> </tt>
<a name="L1284"></a><tt class="py-lineno">1284</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-256" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-256', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'li'</tt><tt class="py-op">:</tt> </tt>
<a name="L1285"></a><tt class="py-lineno">1285</tt> <tt class="py-line"> <tt class="py-name">bullet</tt> <tt class="py-op">=</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">attribs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'bullet'</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-string">'-'</tt> </tt>
<a name="L1286"></a><tt class="py-lineno">1286</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">indent</tt><tt class="py-op">*</tt><tt class="py-string">' '</tt><tt class="py-op">+</tt> <tt class="py-name">bullet</tt> <tt class="py-op">+</tt> <tt class="py-string">' '</tt> <tt class="py-op">+</tt> <tt class="py-name">childstr</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="L1287"></a><tt class="py-lineno">1287</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-257" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-257', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'heading'</tt><tt class="py-op">:</tt> </tt>
<a name="L1288"></a><tt class="py-lineno">1288</tt> <tt class="py-line"> <tt class="py-name">str</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">'\0'</tt><tt class="py-op">,</tt> <tt class="py-string">'E{lb}'</tt><tt class="py-op">,</tt><tt class="py-name">childstr</tt><tt class="py-op">)</tt> </tt>
<a name="L1289"></a><tt class="py-lineno">1289</tt> <tt class="py-line"> <tt class="py-name">str</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">'\1'</tt><tt class="py-op">,</tt> <tt class="py-string">'E{rb}'</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
<a name="L1290"></a><tt class="py-lineno">1290</tt> <tt class="py-line"> <tt class="py-name">uline</tt> <tt class="py-op">=</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">childstr</tt><tt class="py-op">)</tt><tt class="py-op">*</tt><tt id="link-258" class="py-name"><a title="epydoc.markup.epytext._HEADING_CHARS" class="py-name" href="#" onclick="return doclink('link-258', '_HEADING_CHARS', 'link-18');">_HEADING_CHARS</a></tt><tt class="py-op">[</tt><tt class="py-name">seclevel</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt>
<a name="L1291"></a><tt class="py-lineno">1291</tt> <tt class="py-line"> <tt class="py-keyword">return</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-op">*</tt><tt class="py-string">' '</tt> <tt class="py-op">+</tt> <tt class="py-name">str</tt> <tt class="py-op">+</tt> <tt class="py-string">'\n'</tt> <tt class="py-op">+</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-op">*</tt><tt class="py-string">' '</tt><tt class="py-op">+</tt><tt class="py-name">uline</tt><tt class="py-op">+</tt><tt class="py-string">'\n'</tt> </tt>
<a name="L1292"></a><tt class="py-lineno">1292</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-259" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-259', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'doctestblock'</tt><tt class="py-op">:</tt> </tt>
<a name="L1293"></a><tt class="py-lineno">1293</tt> <tt class="py-line"> <tt class="py-name">str</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">'\0'</tt><tt class="py-op">,</tt> <tt class="py-string">'{'</tt><tt class="py-op">,</tt> <tt class="py-name">childstr</tt><tt class="py-op">)</tt> </tt>
<a name="L1294"></a><tt class="py-lineno">1294</tt> <tt class="py-line"> <tt class="py-name">str</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">'\1'</tt><tt class="py-op">,</tt> <tt class="py-string">'}'</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
<a name="L1295"></a><tt class="py-lineno">1295</tt> <tt class="py-line"> <tt class="py-name">lines</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">indent</tt><tt class="py-op">*</tt><tt class="py-string">' '</tt><tt class="py-op">+</tt><tt class="py-name">line</tt> <tt class="py-keyword">for</tt> <tt class="py-name">line</tt> <tt class="py-keyword">in</tt> <tt class="py-name">str</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-op">]</tt> </tt>
<a name="L1296"></a><tt class="py-lineno">1296</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-name">lines</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-string">'\n\n'</tt> </tt>
<a name="L1297"></a><tt class="py-lineno">1297</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-260" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-260', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'literalblock'</tt><tt class="py-op">:</tt> </tt>
<a name="L1298"></a><tt class="py-lineno">1298</tt> <tt class="py-line"> <tt class="py-name">str</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">'\0'</tt><tt class="py-op">,</tt> <tt class="py-string">'{'</tt><tt class="py-op">,</tt> <tt class="py-name">childstr</tt><tt class="py-op">)</tt> </tt>
<a name="L1299"></a><tt class="py-lineno">1299</tt> <tt class="py-line"> <tt class="py-name">str</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">'\1'</tt><tt class="py-op">,</tt> <tt class="py-string">'}'</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
<a name="L1300"></a><tt class="py-lineno">1300</tt> <tt class="py-line"> <tt class="py-name">lines</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">(</tt><tt class="py-name">indent</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-string">' '</tt><tt class="py-op">+</tt><tt class="py-name">line</tt> <tt class="py-keyword">for</tt> <tt class="py-name">line</tt> <tt class="py-keyword">in</tt> <tt class="py-name">str</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-op">]</tt> </tt>
<a name="L1301"></a><tt class="py-lineno">1301</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'\2'</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">lines</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-string">'\n\n'</tt> </tt>
<a name="L1302"></a><tt class="py-lineno">1302</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-261" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-261', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'field'</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">numargs</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L1304"></a><tt class="py-lineno">1304</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">[</tt><tt class="py-name">numargs</tt><tt class="py-op">+</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-262" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-262', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'arg'</tt><tt class="py-op">:</tt> <tt class="py-name">numargs</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L1305"></a><tt class="py-lineno">1305</tt> <tt class="py-line"> <tt id="link-263" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-263', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">=</tt> <tt id="link-264" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-264', 'variables', 'link-225');">variables</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L1306"></a><tt class="py-lineno">1306</tt> <tt class="py-line"> <tt class="py-name">args</tt> <tt class="py-op">=</tt> <tt id="link-265" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-265', 'variables', 'link-225');">variables</a></tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-number">1</tt><tt class="py-op">+</tt><tt class="py-name">numargs</tt><tt class="py-op">]</tt> </tt>
<a name="L1307"></a><tt class="py-lineno">1307</tt> <tt class="py-line"> <tt id="link-266" class="py-name" targets="Method epydoc.markup.Field.body()=epydoc.markup.Field-class.html#body"><a title="epydoc.markup.Field.body" class="py-name" href="#" onclick="return doclink('link-266', 'body', 'link-266');">body</a></tt> <tt class="py-op">=</tt> <tt id="link-267" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-267', 'variables', 'link-225');">variables</a></tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">+</tt><tt class="py-name">numargs</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L1308"></a><tt class="py-lineno">1308</tt> <tt class="py-line"> <tt class="py-name">str</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-name">indent</tt><tt class="py-op">)</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 id="link-268" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-268', 'variables', 'link-225');">variables</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L1309"></a><tt class="py-lineno">1309</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">args</tt><tt class="py-op">:</tt> <tt class="py-name">str</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-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-string">')'</tt> </tt>
<a name="L1310"></a><tt class="py-lineno">1310</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-string">':\n'</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 id="link-269" class="py-name"><a title="epydoc.markup.Field.body" class="py-name" href="#" onclick="return doclink('link-269', 'body', 'link-266');">body</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1311"></a><tt class="py-lineno">1311</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-270" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-270', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'target'</tt><tt class="py-op">:</tt> </tt>
<a name="L1312"></a><tt class="py-lineno">1312</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">childstr</tt> </tt>
<a name="L1313"></a><tt class="py-lineno">1313</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-271" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-271', 'tag', 'link-13');">tag</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-string">'fieldlist'</tt><tt class="py-op">,</tt> <tt class="py-string">'tag'</tt><tt class="py-op">,</tt> <tt class="py-string">'arg'</tt><tt class="py-op">,</tt> <tt class="py-string">'epytext'</tt><tt class="py-op">,</tt> </tt>
<a name="L1314"></a><tt class="py-lineno">1314</tt> <tt class="py-line"> <tt class="py-string">'section'</tt><tt class="py-op">,</tt> <tt class="py-string">'olist'</tt><tt class="py-op">,</tt> <tt class="py-string">'ulist'</tt><tt class="py-op">,</tt> <tt class="py-string">'name'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1315"></a><tt class="py-lineno">1315</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">childstr</tt> </tt>
<a name="L1316"></a><tt class="py-lineno">1316</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-272" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-272', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'symbol'</tt><tt class="py-op">:</tt> </tt>
<a name="L1317"></a><tt class="py-lineno">1317</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'E{%s}'</tt> <tt class="py-op">%</tt> <tt class="py-name">childstr</tt> </tt>
<a name="L1318"></a><tt class="py-lineno">1318</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-273" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-273', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'graph'</tt><tt class="py-op">:</tt> </tt>
<a name="L1319"></a><tt class="py-lineno">1319</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'G{%s}'</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 id="link-274" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-274', 'variables', 'link-225');">variables</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1320"></a><tt class="py-lineno">1320</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1321"></a><tt class="py-lineno">1321</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt id="link-275" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-275', 'tag', 'link-13');">tag</a></tt><tt class="py-op">,</tt> <tt id="link-276" 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-276', 'name', 'link-276');">name</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt id="link-277" class="py-name"><a title="epydoc.markup.epytext._COLORIZING_TAGS" class="py-name" href="#" onclick="return doclink('link-277', '_COLORIZING_TAGS', 'link-27');">_COLORIZING_TAGS</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="L1322"></a><tt class="py-lineno">1322</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-278" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-278', 'name', 'link-276');">name</a></tt> <tt class="py-op">==</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-279" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-279', 'tag', 'link-13');">tag</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1323"></a><tt class="py-lineno">1323</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 id="link-280" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-280', 'tag', 'link-13');">tag</a></tt><tt class="py-op">,</tt> <tt class="py-name">childstr</tt><tt class="py-op">)</tt> </tt>
<a name="L1324"></a><tt class="py-lineno">1324</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">'Unknown DOM element %r'</tt> <tt class="py-op">%</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-281" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-281', 'tag', 'link-13');">tag</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L1325"></a><tt class="py-lineno">1325</tt> <tt class="py-line"> </tt>
<a name="L1326"></a><tt class="py-lineno">1326</tt> <tt class="py-line"><tt id="link-282" class="py-name" targets="Variable epydoc.markup.epytext.SYMBOL_TO_PLAINTEXT=epydoc.markup.epytext-module.html#SYMBOL_TO_PLAINTEXT"><a title="epydoc.markup.epytext.SYMBOL_TO_PLAINTEXT" class="py-name" href="#" onclick="return doclink('link-282', 'SYMBOL_TO_PLAINTEXT', 'link-282');">SYMBOL_TO_PLAINTEXT</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
<a name="L1327"></a><tt class="py-lineno">1327</tt> <tt class="py-line"> <tt class="py-string">'crarr'</tt><tt class="py-op">:</tt> <tt class="py-string">'\\'</tt><tt class="py-op">,</tt> </tt>
<a name="L1328"></a><tt class="py-lineno">1328</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt>
<a name="L1329"></a><tt class="py-lineno">1329</tt> <tt class="py-line"> </tt>
<a name="to_plaintext"></a><div id="to_plaintext-def"><a name="L1330"></a><tt class="py-lineno">1330</tt> <a class="py-toggle" href="#" id="to_plaintext-toggle" onclick="return toggle('to_plaintext');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext-module.html#to_plaintext">to_plaintext</a><tt class="py-op">(</tt><tt class="py-param">tree</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-param">seclevel</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="to_plaintext-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="to_plaintext-expanded"><a name="L1331"></a><tt class="py-lineno">1331</tt> <tt class="py-line"> <tt class="py-docstring">""" </tt> </tt>
<a name="L1332"></a><tt class="py-lineno">1332</tt> <tt class="py-line"><tt class="py-docstring"> Convert a DOM document encoding epytext to a string representation.</tt> </tt>
<a name="L1333"></a><tt class="py-lineno">1333</tt> <tt class="py-line"><tt class="py-docstring"> This representation is similar to the string generated by</tt> </tt>
<a name="L1334"></a><tt class="py-lineno">1334</tt> <tt class="py-line"><tt class="py-docstring"> C{to_epytext}, but C{to_plaintext} removes inline markup, prints</tt> </tt>
<a name="L1335"></a><tt class="py-lineno">1335</tt> <tt class="py-line"><tt class="py-docstring"> escaped characters in unescaped form, etc.</tt> </tt>
<a name="L1336"></a><tt class="py-lineno">1336</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1337"></a><tt class="py-lineno">1337</tt> <tt class="py-line"><tt class="py-docstring"> @param tree: A DOM document encoding of an epytext string.</tt> </tt>
<a name="L1338"></a><tt class="py-lineno">1338</tt> <tt class="py-line"><tt class="py-docstring"> @type tree: C{Element}</tt> </tt>
<a name="L1339"></a><tt class="py-lineno">1339</tt> <tt class="py-line"><tt class="py-docstring"> @param indent: The indentation for the string representation of</tt> </tt>
<a name="L1340"></a><tt class="py-lineno">1340</tt> <tt class="py-line"><tt class="py-docstring"> C{tree}. Each line of the returned string will begin with</tt> </tt>
<a name="L1341"></a><tt class="py-lineno">1341</tt> <tt class="py-line"><tt class="py-docstring"> C{indent} space characters.</tt> </tt>
<a name="L1342"></a><tt class="py-lineno">1342</tt> <tt class="py-line"><tt class="py-docstring"> @type indent: C{int}</tt> </tt>
<a name="L1343"></a><tt class="py-lineno">1343</tt> <tt class="py-line"><tt class="py-docstring"> @param seclevel: The section level that C{tree} appears at. This</tt> </tt>
<a name="L1344"></a><tt class="py-lineno">1344</tt> <tt class="py-line"><tt class="py-docstring"> is used to generate section headings.</tt> </tt>
<a name="L1345"></a><tt class="py-lineno">1345</tt> <tt class="py-line"><tt class="py-docstring"> @type seclevel: C{int}</tt> </tt>
<a name="L1346"></a><tt class="py-lineno">1346</tt> <tt class="py-line"><tt class="py-docstring"> @return: The epytext string corresponding to C{tree}.</tt> </tt>
<a name="L1347"></a><tt class="py-lineno">1347</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{string}</tt> </tt>
<a name="L1348"></a><tt class="py-lineno">1348</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1349"></a><tt class="py-lineno">1349</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">tree</tt><tt class="py-op">,</tt> <tt class="py-name">basestring</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">tree</tt> </tt>
<a name="L1350"></a><tt class="py-lineno">1350</tt> <tt class="py-line"> </tt>
<a name="L1351"></a><tt class="py-lineno">1351</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-283" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-283', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'section'</tt><tt class="py-op">:</tt> <tt class="py-name">seclevel</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L1352"></a><tt class="py-lineno">1352</tt> <tt class="py-line"> </tt>
<a name="L1353"></a><tt class="py-lineno">1353</tt> <tt class="py-line"> <tt class="py-comment"># Figure out the child indent level.</tt> </tt>
<a name="L1354"></a><tt class="py-lineno">1354</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-284" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-284', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'epytext'</tt><tt class="py-op">:</tt> <tt class="py-name">cindent</tt> <tt class="py-op">=</tt> <tt class="py-name">indent</tt> </tt>
<a name="L1355"></a><tt class="py-lineno">1355</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-285" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-285', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'li'</tt> <tt class="py-keyword">and</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">attribs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'bullet'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1356"></a><tt class="py-lineno">1356</tt> <tt class="py-line"> <tt class="py-name">cindent</tt> <tt class="py-op">=</tt> <tt class="py-name">indent</tt> <tt class="py-op">+</tt> <tt class="py-number">1</tt> <tt class="py-op">+</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">attribs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'bullet'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1357"></a><tt class="py-lineno">1357</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1358"></a><tt class="py-lineno">1358</tt> <tt class="py-line"> <tt class="py-name">cindent</tt> <tt class="py-op">=</tt> <tt class="py-name">indent</tt> <tt class="py-op">+</tt> <tt class="py-number">2</tt> </tt>
<a name="L1359"></a><tt class="py-lineno">1359</tt> <tt class="py-line"> <tt id="link-286" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-286', 'variables', 'link-225');">variables</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt id="link-287" 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-287', 'to_plaintext', 'link-287');">to_plaintext</a></tt><tt class="py-op">(</tt><tt class="py-name">c</tt><tt class="py-op">,</tt> <tt class="py-name">cindent</tt><tt class="py-op">,</tt> <tt class="py-name">seclevel</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">c</tt> <tt class="py-keyword">in</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">]</tt> </tt>
<a name="L1360"></a><tt class="py-lineno">1360</tt> <tt class="py-line"> <tt class="py-name">childstr</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 id="link-288" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-288', 'variables', 'link-225');">variables</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1361"></a><tt class="py-lineno">1361</tt> <tt class="py-line"> </tt>
<a name="L1362"></a><tt class="py-lineno">1362</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-289" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-289', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'para'</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">return</tt> <tt id="link-290" class="py-name"><a title="epydoc.util.wordwrap" class="py-name" href="#" onclick="return doclink('link-290', 'wordwrap', 'link-5');">wordwrap</a></tt><tt class="py-op">(</tt><tt class="py-name">childstr</tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">)</tt><tt class="py-op">+</tt><tt class="py-string">'\n'</tt> </tt>
<a name="L1364"></a><tt class="py-lineno">1364</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-291" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-291', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'li'</tt><tt class="py-op">:</tt> </tt>
<a name="L1365"></a><tt class="py-lineno">1365</tt> <tt class="py-line"> <tt class="py-comment"># We should be able to use getAttribute here; but there's no</tt> </tt>
<a name="L1366"></a><tt class="py-lineno">1366</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># convenient way to test if an element has an attribute..</tt> </tt>
<a name="L1367"></a><tt class="py-lineno">1367</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">bullet</tt> <tt class="py-op">=</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">attribs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'bullet'</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-string">'-'</tt> </tt>
<a name="L1368"></a><tt class="py-lineno">1368</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">indent</tt><tt class="py-op">*</tt><tt class="py-string">' '</tt> <tt class="py-op">+</tt> <tt class="py-name">bullet</tt> <tt class="py-op">+</tt> <tt class="py-string">' '</tt> <tt class="py-op">+</tt> <tt class="py-name">childstr</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="L1369"></a><tt class="py-lineno">1369</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-292" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-292', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'heading'</tt><tt class="py-op">:</tt> </tt>
<a name="L1370"></a><tt class="py-lineno">1370</tt> <tt class="py-line"> <tt class="py-name">uline</tt> <tt class="py-op">=</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">childstr</tt><tt class="py-op">)</tt><tt class="py-op">*</tt><tt id="link-293" class="py-name"><a title="epydoc.markup.epytext._HEADING_CHARS" class="py-name" href="#" onclick="return doclink('link-293', '_HEADING_CHARS', 'link-18');">_HEADING_CHARS</a></tt><tt class="py-op">[</tt><tt class="py-name">seclevel</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt>
<a name="L1371"></a><tt class="py-lineno">1371</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</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-op">*</tt><tt class="py-string">' '</tt> <tt class="py-op">+</tt> <tt class="py-name">childstr</tt> <tt class="py-op">+</tt> <tt class="py-string">'\n'</tt> <tt class="py-op">+</tt> </tt>
<a name="L1372"></a><tt class="py-lineno">1372</tt> <tt class="py-line"> <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-op">*</tt><tt class="py-string">' '</tt> <tt class="py-op">+</tt> <tt class="py-name">uline</tt> <tt class="py-op">+</tt> <tt class="py-string">'\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1373"></a><tt class="py-lineno">1373</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-294" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-294', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'doctestblock'</tt><tt class="py-op">:</tt> </tt>
<a name="L1374"></a><tt class="py-lineno">1374</tt> <tt class="py-line"> <tt class="py-name">lines</tt> <tt class="py-op">=</tt> <tt class="py-op">[</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-op">*</tt><tt class="py-string">' '</tt><tt class="py-op">+</tt><tt class="py-name">line</tt> <tt class="py-keyword">for</tt> <tt class="py-name">line</tt> <tt class="py-keyword">in</tt> <tt class="py-name">childstr</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-op">]</tt> </tt>
<a name="L1375"></a><tt class="py-lineno">1375</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-name">lines</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-string">'\n\n'</tt> </tt>
<a name="L1376"></a><tt class="py-lineno">1376</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-295" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-295', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'literalblock'</tt><tt class="py-op">:</tt> </tt>
<a name="L1377"></a><tt class="py-lineno">1377</tt> <tt class="py-line"> <tt class="py-name">lines</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">(</tt><tt class="py-name">indent</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-string">' '</tt><tt class="py-op">+</tt><tt class="py-name">line</tt> <tt class="py-keyword">for</tt> <tt class="py-name">line</tt> <tt class="py-keyword">in</tt> <tt class="py-name">childstr</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-op">]</tt> </tt>
<a name="L1378"></a><tt class="py-lineno">1378</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-name">lines</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-string">'\n\n'</tt> </tt>
<a name="L1379"></a><tt class="py-lineno">1379</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-296" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-296', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'fieldlist'</tt><tt class="py-op">:</tt> </tt>
<a name="L1380"></a><tt class="py-lineno">1380</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">childstr</tt> </tt>
<a name="L1381"></a><tt class="py-lineno">1381</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-297" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-297', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'field'</tt><tt class="py-op">:</tt> </tt>
<a name="L1382"></a><tt class="py-lineno">1382</tt> <tt class="py-line"> <tt class="py-name">numargs</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L1383"></a><tt class="py-lineno">1383</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">[</tt><tt class="py-name">numargs</tt><tt class="py-op">+</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-298" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-298', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'arg'</tt><tt class="py-op">:</tt> <tt class="py-name">numargs</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L1384"></a><tt class="py-lineno">1384</tt> <tt class="py-line"> <tt id="link-299" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-299', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">=</tt> <tt id="link-300" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-300', 'variables', 'link-225');">variables</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L1385"></a><tt class="py-lineno">1385</tt> <tt class="py-line"> <tt class="py-name">args</tt> <tt class="py-op">=</tt> <tt id="link-301" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-301', 'variables', 'link-225');">variables</a></tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-number">1</tt><tt class="py-op">+</tt><tt class="py-name">numargs</tt><tt class="py-op">]</tt> </tt>
<a name="L1386"></a><tt class="py-lineno">1386</tt> <tt class="py-line"> <tt id="link-302" class="py-name"><a title="epydoc.markup.Field.body" class="py-name" href="#" onclick="return doclink('link-302', 'body', 'link-266');">body</a></tt> <tt class="py-op">=</tt> <tt id="link-303" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-303', 'variables', 'link-225');">variables</a></tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">+</tt><tt class="py-name">numargs</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L1387"></a><tt class="py-lineno">1387</tt> <tt class="py-line"> <tt class="py-name">str</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-name">indent</tt><tt class="py-op">)</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 id="link-304" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-304', 'variables', 'link-225');">variables</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L1388"></a><tt class="py-lineno">1388</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">args</tt><tt class="py-op">:</tt> <tt class="py-name">str</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-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-string">')'</tt> </tt>
<a name="L1389"></a><tt class="py-lineno">1389</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-string">':\n'</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 id="link-305" class="py-name"><a title="epydoc.markup.Field.body" class="py-name" href="#" onclick="return doclink('link-305', 'body', 'link-266');">body</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1390"></a><tt class="py-lineno">1390</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-306" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-306', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'uri'</tt><tt class="py-op">:</tt> </tt>
<a name="L1391"></a><tt class="py-lineno">1391</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-307" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-307', 'variables', 'link-225');">variables</a></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-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">'Bad URI '</tt><tt class="py-op">)</tt> </tt>
<a name="L1392"></a><tt class="py-lineno">1392</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt id="link-308" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-308', 'variables', 'link-225');">variables</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt id="link-309" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-309', 'variables', 'link-225');">variables</a></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-keyword">return</tt> <tt class="py-string">'<%s>'</tt> <tt class="py-op">%</tt> <tt id="link-310" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-310', 'variables', 'link-225');">variables</a></tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt>
<a name="L1393"></a><tt class="py-lineno">1393</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-string">'%r<%s>'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt id="link-311" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-311', 'variables', 'link-225');">variables</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt id="link-312" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-312', 'variables', 'link-225');">variables</a></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="L1394"></a><tt class="py-lineno">1394</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-313" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-313', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'link'</tt><tt class="py-op">:</tt> </tt>
<a name="L1395"></a><tt class="py-lineno">1395</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-314" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-314', 'variables', 'link-225');">variables</a></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-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">'Bad Link'</tt><tt class="py-op">)</tt> </tt>
<a name="L1396"></a><tt class="py-lineno">1396</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'%s'</tt> <tt class="py-op">%</tt> <tt id="link-315" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-315', 'variables', 'link-225');">variables</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L1397"></a><tt class="py-lineno">1397</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-316" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-316', 'tag', 'link-13');">tag</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-string">'olist'</tt><tt class="py-op">,</tt> <tt class="py-string">'ulist'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1398"></a><tt class="py-lineno">1398</tt> <tt class="py-line"> <tt class="py-comment"># [xx] always use condensed lists.</tt> </tt>
<a name="L1399"></a><tt class="py-lineno">1399</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">## Use a condensed list if each list item is 1 line long.</tt> </tt>
<a name="L1400"></a><tt class="py-lineno">1400</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#for child in variables:</tt> </tt>
<a name="L1401"></a><tt class="py-lineno">1401</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># if child.count('\n') > 2: return childstr</tt> </tt>
<a name="L1402"></a><tt class="py-lineno">1402</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt class="py-name">childstr</tt><tt class="py-op">.</tt><tt class="py-name">replace</tt><tt class="py-op">(</tt><tt class="py-string">'\n\n'</tt><tt class="py-op">,</tt> <tt class="py-string">'\n'</tt><tt class="py-op">)</tt><tt class="py-op">+</tt><tt class="py-string">'\n'</tt> </tt>
<a name="L1403"></a><tt class="py-lineno">1403</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-317" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-317', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'symbol'</tt><tt class="py-op">:</tt> </tt>
<a name="L1404"></a><tt class="py-lineno">1404</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'%s'</tt> <tt class="py-op">%</tt> <tt id="link-318" class="py-name"><a title="epydoc.markup.epytext.SYMBOL_TO_PLAINTEXT" class="py-name" href="#" onclick="return doclink('link-318', 'SYMBOL_TO_PLAINTEXT', 'link-282');">SYMBOL_TO_PLAINTEXT</a></tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-name">childstr</tt><tt class="py-op">,</tt> <tt class="py-name">childstr</tt><tt class="py-op">)</tt> </tt>
<a name="L1405"></a><tt class="py-lineno">1405</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-319" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-319', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'graph'</tt><tt class="py-op">:</tt> </tt>
<a name="L1406"></a><tt class="py-lineno">1406</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'<<%s graph: %s>>'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt id="link-320" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-320', 'variables', 'link-225');">variables</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-string">', '</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt id="link-321" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-321', 'variables', 'link-225');">variables</a></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-op">)</tt> </tt>
<a name="L1407"></a><tt class="py-lineno">1407</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1408"></a><tt class="py-lineno">1408</tt> <tt class="py-line"> <tt class="py-comment"># Assume that anything else can be passed through.</tt> </tt>
<a name="L1409"></a><tt class="py-lineno">1409</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt class="py-name">childstr</tt> </tt>
</div><a name="L1410"></a><tt class="py-lineno">1410</tt> <tt class="py-line"> </tt>
<a name="to_debug"></a><div id="to_debug-def"><a name="L1411"></a><tt class="py-lineno">1411</tt> <a class="py-toggle" href="#" id="to_debug-toggle" onclick="return toggle('to_debug');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext-module.html#to_debug">to_debug</a><tt class="py-op">(</tt><tt class="py-param">tree</tt><tt class="py-op">,</tt> <tt class="py-param">indent</tt><tt class="py-op">=</tt><tt class="py-number">4</tt><tt class="py-op">,</tt> <tt class="py-param">seclevel</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="to_debug-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="to_debug-expanded"><a name="L1412"></a><tt class="py-lineno">1412</tt> <tt class="py-line"> <tt class="py-docstring">""" </tt> </tt>
<a name="L1413"></a><tt class="py-lineno">1413</tt> <tt class="py-line"><tt class="py-docstring"> Convert a DOM document encoding epytext back to an epytext string,</tt> </tt>
<a name="L1414"></a><tt class="py-lineno">1414</tt> <tt class="py-line"><tt class="py-docstring"> annotated with extra debugging information. This function is</tt> </tt>
<a name="L1415"></a><tt class="py-lineno">1415</tt> <tt class="py-line"><tt class="py-docstring"> similar to L{to_epytext}, but it adds explicit information about</tt> </tt>
<a name="L1416"></a><tt class="py-lineno">1416</tt> <tt class="py-line"><tt class="py-docstring"> where different blocks begin, along the left margin.</tt> </tt>
<a name="L1417"></a><tt class="py-lineno">1417</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1418"></a><tt class="py-lineno">1418</tt> <tt class="py-line"><tt class="py-docstring"> @param tree: A DOM document encoding of an epytext string.</tt> </tt>
<a name="L1419"></a><tt class="py-lineno">1419</tt> <tt class="py-line"><tt class="py-docstring"> @type tree: C{Element}</tt> </tt>
<a name="L1420"></a><tt class="py-lineno">1420</tt> <tt class="py-line"><tt class="py-docstring"> @param indent: The indentation for the string representation of</tt> </tt>
<a name="L1421"></a><tt class="py-lineno">1421</tt> <tt class="py-line"><tt class="py-docstring"> C{tree}. Each line of the returned string will begin with</tt> </tt>
<a name="L1422"></a><tt class="py-lineno">1422</tt> <tt class="py-line"><tt class="py-docstring"> C{indent} space characters.</tt> </tt>
<a name="L1423"></a><tt class="py-lineno">1423</tt> <tt class="py-line"><tt class="py-docstring"> @type indent: C{int}</tt> </tt>
<a name="L1424"></a><tt class="py-lineno">1424</tt> <tt class="py-line"><tt class="py-docstring"> @param seclevel: The section level that C{tree} appears at. This</tt> </tt>
<a name="L1425"></a><tt class="py-lineno">1425</tt> <tt class="py-line"><tt class="py-docstring"> is used to generate section headings.</tt> </tt>
<a name="L1426"></a><tt class="py-lineno">1426</tt> <tt class="py-line"><tt class="py-docstring"> @type seclevel: C{int}</tt> </tt>
<a name="L1427"></a><tt class="py-lineno">1427</tt> <tt class="py-line"><tt class="py-docstring"> @return: The epytext string corresponding to C{tree}.</tt> </tt>
<a name="L1428"></a><tt class="py-lineno">1428</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{string}</tt> </tt>
<a name="L1429"></a><tt class="py-lineno">1429</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1430"></a><tt class="py-lineno">1430</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">tree</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="L1431"></a><tt class="py-lineno">1431</tt> <tt class="py-line"> <tt class="py-name">str</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'\{'</tt><tt class="py-op">,</tt> <tt class="py-string">'\0'</tt><tt class="py-op">,</tt> <tt class="py-name">tree</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">str</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'\}'</tt><tt class="py-op">,</tt> <tt class="py-string">'\1'</tt><tt class="py-op">,</tt> <tt class="py-name">str</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">return</tt> <tt class="py-name">str</tt> </tt>
<a name="L1434"></a><tt class="py-lineno">1434</tt> <tt class="py-line"> </tt>
<a name="L1435"></a><tt class="py-lineno">1435</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-322" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-322', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'section'</tt><tt class="py-op">:</tt> <tt class="py-name">seclevel</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L1436"></a><tt class="py-lineno">1436</tt> <tt class="py-line"> <tt id="link-323" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-323', 'variables', 'link-225');">variables</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt id="link-324" class="py-name" targets="Function epydoc.markup.epytext.to_debug()=epydoc.markup.epytext-module.html#to_debug"><a title="epydoc.markup.epytext.to_debug" class="py-name" href="#" onclick="return doclink('link-324', 'to_debug', 'link-324');">to_debug</a></tt><tt class="py-op">(</tt><tt class="py-name">c</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-name">seclevel</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">c</tt> <tt class="py-keyword">in</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">]</tt> </tt>
<a name="L1437"></a><tt class="py-lineno">1437</tt> <tt class="py-line"> <tt class="py-name">childstr</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 id="link-325" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-325', 'variables', 'link-225');">variables</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1438"></a><tt class="py-lineno">1438</tt> <tt class="py-line"> </tt>
<a name="L1439"></a><tt class="py-lineno">1439</tt> <tt class="py-line"> <tt class="py-comment"># Clean up for literal blocks (add the double "::" back)</tt> </tt>
<a name="L1440"></a><tt class="py-lineno">1440</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">childstr</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">':( *\n \|\n)\2'</tt><tt class="py-op">,</tt> <tt class="py-string">'::\\1'</tt><tt class="py-op">,</tt> <tt class="py-name">childstr</tt><tt class="py-op">)</tt> </tt>
<a name="L1441"></a><tt class="py-lineno">1441</tt> <tt class="py-line"> </tt>
<a name="L1442"></a><tt class="py-lineno">1442</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-326" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-326', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'para'</tt><tt class="py-op">:</tt> </tt>
<a name="L1443"></a><tt class="py-lineno">1443</tt> <tt class="py-line"> <tt class="py-name">str</tt> <tt class="py-op">=</tt> <tt id="link-327" class="py-name"><a title="epydoc.util.wordwrap" class="py-name" href="#" onclick="return doclink('link-327', 'wordwrap', 'link-5');">wordwrap</a></tt><tt class="py-op">(</tt><tt class="py-name">childstr</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 class="py-number">69</tt><tt class="py-op">)</tt><tt class="py-op">+</tt><tt class="py-string">'\n'</tt> </tt>
<a name="L1444"></a><tt class="py-lineno">1444</tt> <tt class="py-line"> <tt class="py-name">str</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'((^|\n)\s*\d+)\.'</tt><tt class="py-op">,</tt> <tt class="py-string">r'\1E{.}'</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
<a name="L1445"></a><tt class="py-lineno">1445</tt> <tt class="py-line"> <tt class="py-name">str</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'((^|\n)\s*)-'</tt><tt class="py-op">,</tt> <tt class="py-string">r'\1E{-}'</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
<a name="L1446"></a><tt class="py-lineno">1446</tt> <tt class="py-line"> <tt class="py-name">str</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'((^|\n)\s*)@'</tt><tt class="py-op">,</tt> <tt class="py-string">r'\1E{@}'</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
<a name="L1447"></a><tt class="py-lineno">1447</tt> <tt class="py-line"> <tt class="py-name">str</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*($|\n))'</tt><tt class="py-op">,</tt> <tt class="py-string">r'E{:}E{:}\1'</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
<a name="L1448"></a><tt class="py-lineno">1448</tt> <tt class="py-line"> <tt class="py-name">str</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">'\0'</tt><tt class="py-op">,</tt> <tt class="py-string">'E{lb}'</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
<a name="L1449"></a><tt class="py-lineno">1449</tt> <tt class="py-line"> <tt class="py-name">str</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">'\1'</tt><tt class="py-op">,</tt> <tt class="py-string">'E{rb}'</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
<a name="L1450"></a><tt class="py-lineno">1450</tt> <tt class="py-line"> <tt class="py-name">lines</tt> <tt class="py-op">=</tt> <tt class="py-name">str</tt><tt class="py-op">.</tt><tt class="py-name">rstrip</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>
<a name="L1451"></a><tt class="py-lineno">1451</tt> <tt class="py-line"> <tt class="py-name">lines</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-string">' P>|'</tt> <tt class="py-op">+</tt> <tt class="py-name">lines</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L1452"></a><tt class="py-lineno">1452</tt> <tt class="py-line"> <tt class="py-name">lines</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-op">[</tt><tt class="py-string">' |'</tt><tt class="py-op">+</tt><tt class="py-name">l</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-number">1</tt><tt class="py-op">:</tt><tt class="py-op">]</tt><tt class="py-op">]</tt> </tt>
<a name="L1453"></a><tt class="py-lineno">1453</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-name">lines</tt><tt class="py-op">)</tt><tt class="py-op">+</tt><tt class="py-string">'\n |\n'</tt> </tt>
<a name="L1454"></a><tt class="py-lineno">1454</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-328" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-328', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'li'</tt><tt class="py-op">:</tt> </tt>
<a name="L1455"></a><tt class="py-lineno">1455</tt> <tt class="py-line"> <tt class="py-name">bullet</tt> <tt class="py-op">=</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">attribs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'bullet'</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-string">'-'</tt> </tt>
<a name="L1456"></a><tt class="py-lineno">1456</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">' LI>|'</tt><tt class="py-op">+</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 class="py-op">*</tt><tt class="py-string">' '</tt><tt class="py-op">+</tt> <tt class="py-name">bullet</tt> <tt class="py-op">+</tt> <tt class="py-string">' '</tt> <tt class="py-op">+</tt> <tt class="py-name">childstr</tt><tt class="py-op">[</tt><tt class="py-number">6</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="L1457"></a><tt class="py-lineno">1457</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-329" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-329', 'tag', 'link-13');">tag</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-string">'olist'</tt><tt class="py-op">,</tt> <tt class="py-string">'ulist'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1458"></a><tt class="py-lineno">1458</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'LIST>|'</tt><tt class="py-op">+</tt><tt class="py-op">(</tt><tt class="py-name">indent</tt><tt class="py-op">-</tt><tt class="py-number">4</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">childstr</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-op">]</tt> </tt>
<a name="L1459"></a><tt class="py-lineno">1459</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-330" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-330', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'heading'</tt><tt class="py-op">:</tt> </tt>
<a name="L1460"></a><tt class="py-lineno">1460</tt> <tt class="py-line"> <tt class="py-name">str</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">'\0'</tt><tt class="py-op">,</tt> <tt class="py-string">'E{lb}'</tt><tt class="py-op">,</tt> <tt class="py-name">childstr</tt><tt class="py-op">)</tt> </tt>
<a name="L1461"></a><tt class="py-lineno">1461</tt> <tt class="py-line"> <tt class="py-name">str</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">'\1'</tt><tt class="py-op">,</tt> <tt class="py-string">'E{rb}'</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
<a name="L1462"></a><tt class="py-lineno">1462</tt> <tt class="py-line"> <tt class="py-name">uline</tt> <tt class="py-op">=</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">childstr</tt><tt class="py-op">)</tt><tt class="py-op">*</tt><tt id="link-331" class="py-name"><a title="epydoc.markup.epytext._HEADING_CHARS" class="py-name" href="#" onclick="return doclink('link-331', '_HEADING_CHARS', 'link-18');">_HEADING_CHARS</a></tt><tt class="py-op">[</tt><tt class="py-name">seclevel</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt>
<a name="L1463"></a><tt class="py-lineno">1463</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-string">'SEC'</tt><tt class="py-op">+</tt><tt class="py-op">`</tt><tt class="py-name">seclevel</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">indent</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">' '</tt> <tt class="py-op">+</tt> <tt class="py-name">str</tt> <tt class="py-op">+</tt> <tt class="py-string">'\n'</tt> <tt class="py-op">+</tt> </tt>
<a name="L1464"></a><tt class="py-lineno">1464</tt> <tt class="py-line"> <tt class="py-string">' |'</tt><tt class="py-op">+</tt><tt class="py-op">(</tt><tt class="py-name">indent</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">' '</tt> <tt class="py-op">+</tt> <tt class="py-name">uline</tt> <tt class="py-op">+</tt> <tt class="py-string">'\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1465"></a><tt class="py-lineno">1465</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-332" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-332', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'doctestblock'</tt><tt class="py-op">:</tt> </tt>
<a name="L1466"></a><tt class="py-lineno">1466</tt> <tt class="py-line"> <tt class="py-name">str</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">'\0'</tt><tt class="py-op">,</tt> <tt class="py-string">'{'</tt><tt class="py-op">,</tt> <tt class="py-name">childstr</tt><tt class="py-op">)</tt> </tt>
<a name="L1467"></a><tt class="py-lineno">1467</tt> <tt class="py-line"> <tt class="py-name">str</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">'\1'</tt><tt class="py-op">,</tt> <tt class="py-string">'}'</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
<a name="L1468"></a><tt class="py-lineno">1468</tt> <tt class="py-line"> <tt class="py-name">lines</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">indent</tt><tt class="py-op">-</tt><tt class="py-number">4</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">line</tt> <tt class="py-keyword">for</tt> <tt class="py-name">line</tt> <tt class="py-keyword">in</tt> <tt class="py-name">str</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-op">]</tt> </tt>
<a name="L1469"></a><tt class="py-lineno">1469</tt> <tt class="py-line"> <tt class="py-name">lines</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-string">'DTST>'</tt><tt class="py-op">+</tt><tt class="py-name">lines</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">5</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L1470"></a><tt class="py-lineno">1470</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-name">lines</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-string">'\n |\n'</tt> </tt>
<a name="L1471"></a><tt class="py-lineno">1471</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-333" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-333', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'literalblock'</tt><tt class="py-op">:</tt> </tt>
<a name="L1472"></a><tt class="py-lineno">1472</tt> <tt class="py-line"> <tt class="py-name">str</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">'\0'</tt><tt class="py-op">,</tt> <tt class="py-string">'{'</tt><tt class="py-op">,</tt> <tt class="py-name">childstr</tt><tt class="py-op">)</tt> </tt>
<a name="L1473"></a><tt class="py-lineno">1473</tt> <tt class="py-line"> <tt class="py-name">str</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">'\1'</tt><tt class="py-op">,</tt> <tt class="py-string">'}'</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
<a name="L1474"></a><tt class="py-lineno">1474</tt> <tt class="py-line"> <tt class="py-name">lines</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">indent</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">' '</tt><tt class="py-op">+</tt><tt class="py-name">line</tt> <tt class="py-keyword">for</tt> <tt class="py-name">line</tt> <tt class="py-keyword">in</tt> <tt class="py-name">str</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-op">]</tt> </tt>
<a name="L1475"></a><tt class="py-lineno">1475</tt> <tt class="py-line"> <tt class="py-name">lines</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-string">' LIT>'</tt><tt class="py-op">+</tt><tt class="py-name">lines</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">5</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L1476"></a><tt class="py-lineno">1476</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'\2'</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">lines</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-string">'\n |\n'</tt> </tt>
<a name="L1477"></a><tt class="py-lineno">1477</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-334" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-334', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'field'</tt><tt class="py-op">:</tt> </tt>
<a name="L1478"></a><tt class="py-lineno">1478</tt> <tt class="py-line"> <tt class="py-name">numargs</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L1479"></a><tt class="py-lineno">1479</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">[</tt><tt class="py-name">numargs</tt><tt class="py-op">+</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-335" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-335', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'arg'</tt><tt class="py-op">:</tt> <tt class="py-name">numargs</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L1480"></a><tt class="py-lineno">1480</tt> <tt class="py-line"> <tt id="link-336" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-336', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">=</tt> <tt id="link-337" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-337', 'variables', 'link-225');">variables</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L1481"></a><tt class="py-lineno">1481</tt> <tt class="py-line"> <tt class="py-name">args</tt> <tt class="py-op">=</tt> <tt id="link-338" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-338', 'variables', 'link-225');">variables</a></tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-number">1</tt><tt class="py-op">+</tt><tt class="py-name">numargs</tt><tt class="py-op">]</tt> </tt>
<a name="L1482"></a><tt class="py-lineno">1482</tt> <tt class="py-line"> <tt id="link-339" class="py-name"><a title="epydoc.markup.Field.body" class="py-name" href="#" onclick="return doclink('link-339', 'body', 'link-266');">body</a></tt> <tt class="py-op">=</tt> <tt id="link-340" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-340', 'variables', 'link-225');">variables</a></tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">+</tt><tt class="py-name">numargs</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L1483"></a><tt class="py-lineno">1483</tt> <tt class="py-line"> <tt class="py-name">str</tt> <tt class="py-op">=</tt> <tt class="py-string">' FLD>|'</tt><tt class="py-op">+</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 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 id="link-341" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-341', 'variables', 'link-225');">variables</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L1484"></a><tt class="py-lineno">1484</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">args</tt><tt class="py-op">:</tt> <tt class="py-name">str</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-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-string">')'</tt> </tt>
<a name="L1485"></a><tt class="py-lineno">1485</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-string">':\n'</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 id="link-342" class="py-name"><a title="epydoc.markup.Field.body" class="py-name" href="#" onclick="return doclink('link-342', 'body', 'link-266');">body</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1486"></a><tt class="py-lineno">1486</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-343" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-343', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'target'</tt><tt class="py-op">:</tt> </tt>
<a name="L1487"></a><tt class="py-lineno">1487</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">childstr</tt> </tt>
<a name="L1488"></a><tt class="py-lineno">1488</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-344" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-344', 'tag', 'link-13');">tag</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-string">'fieldlist'</tt><tt class="py-op">,</tt> <tt class="py-string">'tag'</tt><tt class="py-op">,</tt> <tt class="py-string">'arg'</tt><tt class="py-op">,</tt> <tt class="py-string">'epytext'</tt><tt class="py-op">,</tt> </tt>
<a name="L1489"></a><tt class="py-lineno">1489</tt> <tt class="py-line"> <tt class="py-string">'section'</tt><tt class="py-op">,</tt> <tt class="py-string">'olist'</tt><tt class="py-op">,</tt> <tt class="py-string">'ulist'</tt><tt class="py-op">,</tt> <tt class="py-string">'name'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1490"></a><tt class="py-lineno">1490</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">childstr</tt> </tt>
<a name="L1491"></a><tt class="py-lineno">1491</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-345" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-345', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'symbol'</tt><tt class="py-op">:</tt> </tt>
<a name="L1492"></a><tt class="py-lineno">1492</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'E{%s}'</tt> <tt class="py-op">%</tt> <tt class="py-name">childstr</tt> </tt>
<a name="L1493"></a><tt class="py-lineno">1493</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-346" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-346', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'graph'</tt><tt class="py-op">:</tt> </tt>
<a name="L1494"></a><tt class="py-lineno">1494</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'G{%s}'</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 id="link-347" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-347', 'variables', 'link-225');">variables</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1495"></a><tt class="py-lineno">1495</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1496"></a><tt class="py-lineno">1496</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt id="link-348" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-348', 'tag', 'link-13');">tag</a></tt><tt class="py-op">,</tt> <tt id="link-349" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-349', 'name', 'link-276');">name</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt id="link-350" class="py-name"><a title="epydoc.markup.epytext._COLORIZING_TAGS" class="py-name" href="#" onclick="return doclink('link-350', '_COLORIZING_TAGS', 'link-27');">_COLORIZING_TAGS</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="L1497"></a><tt class="py-lineno">1497</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-351" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-351', 'name', 'link-276');">name</a></tt> <tt class="py-op">==</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-352" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-352', 'tag', 'link-13');">tag</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1498"></a><tt class="py-lineno">1498</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 id="link-353" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-353', 'tag', 'link-13');">tag</a></tt><tt class="py-op">,</tt> <tt class="py-name">childstr</tt><tt class="py-op">)</tt> </tt>
<a name="L1499"></a><tt class="py-lineno">1499</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">'Unknown DOM element %r'</tt> <tt class="py-op">%</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-354" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-354', 'tag', 'link-13');">tag</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L1500"></a><tt class="py-lineno">1500</tt> <tt class="py-line"> </tt>
<a name="L1501"></a><tt class="py-lineno">1501</tt> <tt class="py-line"><tt class="py-comment">##################################################</tt> </tt>
<a name="L1502"></a><tt class="py-lineno">1502</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## Top-Level Wrapper function</tt> </tt>
<a name="L1503"></a><tt class="py-lineno">1503</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">##################################################</tt> </tt>
<a name="pparse"></a><div id="pparse-def"><a name="L1504"></a><tt class="py-lineno">1504</tt> <a class="py-toggle" href="#" id="pparse-toggle" onclick="return toggle('pparse');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext-module.html#pparse">pparse</a><tt class="py-op">(</tt><tt class="py-param">str</tt><tt class="py-op">,</tt> <tt class="py-param">show_warnings</tt><tt class="py-op">=</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-param">show_errors</tt><tt class="py-op">=</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-param">stream</tt><tt class="py-op">=</tt><tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">stderr</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="pparse-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="pparse-expanded"><a name="L1505"></a><tt class="py-lineno">1505</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1506"></a><tt class="py-lineno">1506</tt> <tt class="py-line"><tt class="py-docstring"> Pretty-parse the string. This parses the string, and catches any</tt> </tt>
<a name="L1507"></a><tt class="py-lineno">1507</tt> <tt class="py-line"><tt class="py-docstring"> warnings or errors produced. Any warnings and errors are</tt> </tt>
<a name="L1508"></a><tt class="py-lineno">1508</tt> <tt class="py-line"><tt class="py-docstring"> displayed, and the resulting DOM parse structure is returned.</tt> </tt>
<a name="L1509"></a><tt class="py-lineno">1509</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1510"></a><tt class="py-lineno">1510</tt> <tt class="py-line"><tt class="py-docstring"> @param str: The string to parse.</tt> </tt>
<a name="L1511"></a><tt class="py-lineno">1511</tt> <tt class="py-line"><tt class="py-docstring"> @type str: C{string}</tt> </tt>
<a name="L1512"></a><tt class="py-lineno">1512</tt> <tt class="py-line"><tt class="py-docstring"> @param show_warnings: Whether or not to display non-fatal errors</tt> </tt>
<a name="L1513"></a><tt class="py-lineno">1513</tt> <tt class="py-line"><tt class="py-docstring"> generated by parsing C{str}.</tt> </tt>
<a name="L1514"></a><tt class="py-lineno">1514</tt> <tt class="py-line"><tt class="py-docstring"> @type show_warnings: C{boolean}</tt> </tt>
<a name="L1515"></a><tt class="py-lineno">1515</tt> <tt class="py-line"><tt class="py-docstring"> @param show_errors: Whether or not to display fatal errors </tt> </tt>
<a name="L1516"></a><tt class="py-lineno">1516</tt> <tt class="py-line"><tt class="py-docstring"> generated by parsing C{str}.</tt> </tt>
<a name="L1517"></a><tt class="py-lineno">1517</tt> <tt class="py-line"><tt class="py-docstring"> @type show_errors: C{boolean}</tt> </tt>
<a name="L1518"></a><tt class="py-lineno">1518</tt> <tt class="py-line"><tt class="py-docstring"> @param stream: The stream that warnings and errors should be</tt> </tt>
<a name="L1519"></a><tt class="py-lineno">1519</tt> <tt class="py-line"><tt class="py-docstring"> written to.</tt> </tt>
<a name="L1520"></a><tt class="py-lineno">1520</tt> <tt class="py-line"><tt class="py-docstring"> @type stream: C{stream}</tt> </tt>
<a name="L1521"></a><tt class="py-lineno">1521</tt> <tt class="py-line"><tt class="py-docstring"> @return: a DOM document encoding the contents of C{str}.</tt> </tt>
<a name="L1522"></a><tt class="py-lineno">1522</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{Element}</tt> </tt>
<a name="L1523"></a><tt class="py-lineno">1523</tt> <tt class="py-line"><tt class="py-docstring"> @raise SyntaxError: If any fatal errors were encountered.</tt> </tt>
<a name="L1524"></a><tt class="py-lineno">1524</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1525"></a><tt class="py-lineno">1525</tt> <tt class="py-line"> <tt class="py-name">errors</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L1526"></a><tt class="py-lineno">1526</tt> <tt class="py-line"> <tt class="py-name">confused</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L1527"></a><tt class="py-lineno">1527</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L1528"></a><tt class="py-lineno">1528</tt> <tt class="py-line"> <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt id="link-355" class="py-name" targets="Function epydoc.markup.epytext.parse()=epydoc.markup.epytext-module.html#parse,Function epydoc.markup.parse()=epydoc.markup-module.html#parse"><a title="epydoc.markup.epytext.parse
epydoc.markup.parse" class="py-name" href="#" onclick="return doclink('link-355', 'parse', 'link-355');">parse</a></tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">,</tt> <tt class="py-name">errors</tt><tt class="py-op">)</tt> </tt>
<a name="L1529"></a><tt class="py-lineno">1529</tt> <tt class="py-line"> <tt class="py-name">warnings</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">e</tt> <tt class="py-keyword">for</tt> <tt class="py-name">e</tt> <tt class="py-keyword">in</tt> <tt class="py-name">errors</tt> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">e</tt><tt class="py-op">.</tt><tt id="link-356" class="py-name"><a title="epydoc.markup.ParseError.is_fatal" class="py-name" href="#" onclick="return doclink('link-356', 'is_fatal', 'link-56');">is_fatal</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L1530"></a><tt class="py-lineno">1530</tt> <tt class="py-line"> <tt class="py-name">errors</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">e</tt> <tt class="py-keyword">for</tt> <tt class="py-name">e</tt> <tt class="py-keyword">in</tt> <tt class="py-name">errors</tt> <tt class="py-keyword">if</tt> <tt class="py-name">e</tt><tt class="py-op">.</tt><tt id="link-357" class="py-name"><a title="epydoc.markup.ParseError.is_fatal" class="py-name" href="#" onclick="return doclink('link-357', 'is_fatal', 'link-56');">is_fatal</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L1531"></a><tt class="py-lineno">1531</tt> <tt class="py-line"> <tt class="py-keyword">except</tt><tt class="py-op">:</tt> </tt>
<a name="L1532"></a><tt class="py-lineno">1532</tt> <tt class="py-line"> <tt class="py-name">confused</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
<a name="L1533"></a><tt class="py-lineno">1533</tt> <tt class="py-line"> </tt>
<a name="L1534"></a><tt class="py-lineno">1534</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">show_warnings</tt><tt class="py-op">:</tt> <tt class="py-name">warnings</tt> <tt class="py-op">=</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 class="py-name">warnings</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="L1536"></a><tt class="py-lineno">1536</tt> <tt class="py-line"> <tt class="py-name">errors</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="L1537"></a><tt class="py-lineno">1537</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">warnings</tt><tt class="py-op">:</tt> </tt>
<a name="L1538"></a><tt class="py-lineno">1538</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> <tt class="py-op">>></tt><tt class="py-name">stream</tt><tt class="py-op">,</tt> <tt class="py-string">'='</tt><tt class="py-op">*</tt><tt class="py-name">SCRWIDTH</tt> </tt>
<a name="L1539"></a><tt class="py-lineno">1539</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> <tt class="py-op">>></tt><tt class="py-name">stream</tt><tt class="py-op">,</tt> <tt class="py-string">"WARNINGS"</tt> </tt>
<a name="L1540"></a><tt class="py-lineno">1540</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> <tt class="py-op">>></tt><tt class="py-name">stream</tt><tt class="py-op">,</tt> <tt class="py-string">'-'</tt><tt class="py-op">*</tt><tt class="py-name">SCRWIDTH</tt> </tt>
<a name="L1541"></a><tt class="py-lineno">1541</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-358" 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-358', 'warning', 'link-358');">warning</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">warnings</tt><tt class="py-op">:</tt> </tt>
<a name="L1542"></a><tt class="py-lineno">1542</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> <tt class="py-op">>></tt><tt class="py-name">stream</tt><tt class="py-op">,</tt> <tt id="link-359" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-359', 'warning', 'link-358');">warning</a></tt><tt class="py-op">.</tt><tt class="py-name">as_warning</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1543"></a><tt class="py-lineno">1543</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> <tt class="py-op">>></tt><tt class="py-name">stream</tt><tt class="py-op">,</tt> <tt class="py-string">'='</tt><tt class="py-op">*</tt><tt class="py-name">SCRWIDTH</tt> </tt>
<a name="L1544"></a><tt class="py-lineno">1544</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">errors</tt> <tt class="py-keyword">and</tt> <tt class="py-name">show_errors</tt><tt class="py-op">:</tt> </tt>
<a name="L1545"></a><tt class="py-lineno">1545</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">warnings</tt><tt class="py-op">:</tt> <tt class="py-keyword">print</tt> <tt class="py-op">>></tt><tt class="py-name">stream</tt><tt class="py-op">,</tt> <tt class="py-string">'='</tt><tt class="py-op">*</tt><tt class="py-name">SCRWIDTH</tt> </tt>
<a name="L1546"></a><tt class="py-lineno">1546</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> <tt class="py-op">>></tt><tt class="py-name">stream</tt><tt class="py-op">,</tt> <tt class="py-string">"ERRORS"</tt> </tt>
<a name="L1547"></a><tt class="py-lineno">1547</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> <tt class="py-op">>></tt><tt class="py-name">stream</tt><tt class="py-op">,</tt> <tt class="py-string">'-'</tt><tt class="py-op">*</tt><tt class="py-name">SCRWIDTH</tt> </tt>
<a name="L1548"></a><tt class="py-lineno">1548</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-360" 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-360', 'error', 'link-360');">error</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">errors</tt><tt class="py-op">:</tt> </tt>
<a name="L1549"></a><tt class="py-lineno">1549</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> <tt class="py-op">>></tt><tt class="py-name">stream</tt><tt class="py-op">,</tt> <tt id="link-361" class="py-name"><a title="epydoc.log.error" class="py-name" href="#" onclick="return doclink('link-361', 'error', 'link-360');">error</a></tt> </tt>
<a name="L1550"></a><tt class="py-lineno">1550</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> <tt class="py-op">>></tt><tt class="py-name">stream</tt><tt class="py-op">,</tt> <tt class="py-string">'='</tt><tt class="py-op">*</tt><tt class="py-name">SCRWIDTH</tt> </tt>
<a name="L1551"></a><tt class="py-lineno">1551</tt> <tt class="py-line"> </tt>
<a name="L1552"></a><tt class="py-lineno">1552</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">confused</tt><tt class="py-op">:</tt> <tt class="py-keyword">raise</tt> </tt>
<a name="L1553"></a><tt class="py-lineno">1553</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">errors</tt><tt class="py-op">:</tt> <tt class="py-keyword">raise</tt> <tt class="py-name">SyntaxError</tt><tt class="py-op">(</tt><tt class="py-string">'Encountered Errors'</tt><tt class="py-op">)</tt> </tt>
<a name="L1554"></a><tt class="py-lineno">1554</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">val</tt> </tt>
</div><a name="L1555"></a><tt class="py-lineno">1555</tt> <tt class="py-line"> </tt>
<a name="L1556"></a><tt class="py-lineno">1556</tt> <tt class="py-line"><tt class="py-comment">##################################################</tt> </tt>
<a name="L1557"></a><tt class="py-lineno">1557</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## Parse Errors</tt> </tt>
<a name="L1558"></a><tt class="py-lineno">1558</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">##################################################</tt> </tt>
<a name="L1559"></a><tt class="py-lineno">1559</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="TokenizationError"></a><div id="TokenizationError-def"><a name="L1560"></a><tt class="py-lineno">1560</tt> <a class="py-toggle" href="#" id="TokenizationError-toggle" onclick="return toggle('TokenizationError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.markup.epytext.TokenizationError-class.html">TokenizationError</a><tt class="py-op">(</tt><tt class="py-base-class">ParseError</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TokenizationError-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="TokenizationError-expanded"><a name="L1561"></a><tt class="py-lineno">1561</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1562"></a><tt class="py-lineno">1562</tt> <tt class="py-line"><tt class="py-docstring"> An error generated while tokenizing a formatted documentation</tt> </tt>
<a name="L1563"></a><tt class="py-lineno">1563</tt> <tt class="py-line"><tt class="py-docstring"> string.</tt> </tt>
<a name="L1564"></a><tt class="py-lineno">1564</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
</div><a name="L1565"></a><tt class="py-lineno">1565</tt> <tt class="py-line"> </tt>
<a name="StructuringError"></a><div id="StructuringError-def"><a name="L1566"></a><tt class="py-lineno">1566</tt> <a class="py-toggle" href="#" id="StructuringError-toggle" onclick="return toggle('StructuringError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.markup.epytext.StructuringError-class.html">StructuringError</a><tt class="py-op">(</tt><tt class="py-base-class">ParseError</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="StructuringError-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="StructuringError-expanded"><a name="L1567"></a><tt class="py-lineno">1567</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1568"></a><tt class="py-lineno">1568</tt> <tt class="py-line"><tt class="py-docstring"> An error generated while structuring a formatted documentation</tt> </tt>
<a name="L1569"></a><tt class="py-lineno">1569</tt> <tt class="py-line"><tt class="py-docstring"> string.</tt> </tt>
<a name="L1570"></a><tt class="py-lineno">1570</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
</div><a name="L1571"></a><tt class="py-lineno">1571</tt> <tt class="py-line"> </tt>
<a name="ColorizingError"></a><div id="ColorizingError-def"><a name="L1572"></a><tt class="py-lineno">1572</tt> <a class="py-toggle" href="#" id="ColorizingError-toggle" onclick="return toggle('ColorizingError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.markup.epytext.ColorizingError-class.html">ColorizingError</a><tt class="py-op">(</tt><tt class="py-base-class">ParseError</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ColorizingError-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="ColorizingError-expanded"><a name="L1573"></a><tt class="py-lineno">1573</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1574"></a><tt class="py-lineno">1574</tt> <tt class="py-line"><tt class="py-docstring"> An error generated while colorizing a paragraph.</tt> </tt>
<a name="L1575"></a><tt class="py-lineno">1575</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="ColorizingError.__init__"></a><div id="ColorizingError.__init__-def"><a name="L1576"></a><tt class="py-lineno">1576</tt> <a class="py-toggle" href="#" id="ColorizingError.__init__-toggle" onclick="return toggle('ColorizingError.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext.ColorizingError-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">descr</tt><tt class="py-op">,</tt> <tt class="py-param">token</tt><tt class="py-op">,</tt> <tt class="py-param">charnum</tt><tt class="py-op">,</tt> <tt class="py-param">is_fatal</tt><tt class="py-op">=</tt><tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ColorizingError.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ColorizingError.__init__-expanded"><a name="L1577"></a><tt class="py-lineno">1577</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1578"></a><tt class="py-lineno">1578</tt> <tt class="py-line"><tt class="py-docstring"> Construct a new colorizing exception.</tt> </tt>
<a name="L1579"></a><tt class="py-lineno">1579</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1580"></a><tt class="py-lineno">1580</tt> <tt class="py-line"><tt class="py-docstring"> @param descr: A short description of the error.</tt> </tt>
<a name="L1581"></a><tt class="py-lineno">1581</tt> <tt class="py-line"><tt class="py-docstring"> @type descr: C{string}</tt> </tt>
<a name="L1582"></a><tt class="py-lineno">1582</tt> <tt class="py-line"><tt class="py-docstring"> @param token: The token where the error occured</tt> </tt>
<a name="L1583"></a><tt class="py-lineno">1583</tt> <tt class="py-line"><tt class="py-docstring"> @type token: L{Token}</tt> </tt>
<a name="L1584"></a><tt class="py-lineno">1584</tt> <tt class="py-line"><tt class="py-docstring"> @param charnum: The character index of the position in</tt> </tt>
<a name="L1585"></a><tt class="py-lineno">1585</tt> <tt class="py-line"><tt class="py-docstring"> C{token} where the error occured.</tt> </tt>
<a name="L1586"></a><tt class="py-lineno">1586</tt> <tt class="py-line"><tt class="py-docstring"> @type charnum: C{int}</tt> </tt>
<a name="L1587"></a><tt class="py-lineno">1587</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1588"></a><tt class="py-lineno">1588</tt> <tt class="py-line"> <tt id="link-362" class="py-name" targets="Class epydoc.docparser.ParseError=epydoc.docparser.ParseError-class.html,Class epydoc.markup.ParseError=epydoc.markup.ParseError-class.html"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-362', 'ParseError', 'link-362');">ParseError</a></tt><tt class="py-op">.</tt><tt id="link-363" class="py-name" targets="Method epydoc.apidoc.APIDoc.__init__()=epydoc.apidoc.APIDoc-class.html#__init__,Method epydoc.apidoc.DocIndex.__init__()=epydoc.apidoc.DocIndex-class.html#__init__,Method epydoc.apidoc.DottedName.__init__()=epydoc.apidoc.DottedName-class.html#__init__,Method epydoc.apidoc.NamespaceDoc.__init__()=epydoc.apidoc.NamespaceDoc-class.html#__init__,Method epydoc.apidoc.VariableDoc.__init__()=epydoc.apidoc.VariableDoc-class.html#__init__,Method epydoc.apidoc._Sentinel.__init__()=epydoc.apidoc._Sentinel-class.html#__init__,Method epydoc.checker.DocChecker.__init__()=epydoc.checker.DocChecker-class.html#__init__,Method epydoc.cli.ConsoleLogger.__init__()=epydoc.cli.ConsoleLogger-class.html#__init__,Method epydoc.cli.HTMLLogger.__init__()=epydoc.cli.HTMLLogger-class.html#__init__,Method epydoc.cli.TerminalController.__init__()=epydoc.cli.TerminalController-class.html#__init__,Method epydoc.cli.UnifiedProgressConsoleLogger.__init__()=epydoc.cli.UnifiedProgressConsoleLogger-class.html#__init__,Method epydoc.docbuilder.BuildOptions.__init__()=epydoc.docbuilder.BuildOptions-class.html#__init__,Method epydoc.docbuilder._ProgressEstimator.__init__()=epydoc.docbuilder._ProgressEstimator-class.html#__init__,Method epydoc.docintrospecter._DevNull.__init__()=epydoc.docintrospecter._DevNull-class.html#__init__,Method epydoc.docstringparser.DocstringField.__init__()=epydoc.docstringparser.DocstringField-class.html#__init__,Method epydoc.docwriter.dotgraph.DotGraph.__init__()=epydoc.docwriter.dotgraph.DotGraph-class.html#__init__,Method epydoc.docwriter.dotgraph.DotGraphEdge.__init__()=epydoc.docwriter.dotgraph.DotGraphEdge-class.html#__init__,Method epydoc.docwriter.dotgraph.DotGraphNode.__init__()=epydoc.docwriter.dotgraph.DotGraphNode-class.html#__init__,Method epydoc.docwriter.dotgraph.DotGraphUmlClassNode.__init__()=epydoc.docwriter.dotgraph.DotGraphUmlClassNode-class.html#__init__,Method epydoc.docwriter.dotgraph.DotGraphUmlModuleNode.__init__()=epydoc.docwriter.dotgraph.DotGraphUmlModuleNode-class.html#__init__,Method epydoc.docwriter.html.HTMLWriter.__init__()=epydoc.docwriter.html.HTMLWriter-class.html#__init__,Method epydoc.docwriter.html._HTMLDocstringLinker.__init__()=epydoc.docwriter.html._HTMLDocstringLinker-class.html#__init__,Method epydoc.docwriter.html_colorize.PythonSourceColorizer.__init__()=epydoc.docwriter.html_colorize.PythonSourceColorizer-class.html#__init__,Method epydoc.docwriter.latex.LatexWriter.__init__()=epydoc.docwriter.latex.LatexWriter-class.html#__init__,Method epydoc.docwriter.xlink.ApiLinkReader.__init__()=epydoc.docwriter.xlink.ApiLinkReader-class.html#__init__,Method epydoc.docwriter.xlink.DocUrlGenerator.__init__()=epydoc.docwriter.xlink.DocUrlGenerator-class.html#__init__,Method epydoc.gui.EpydocGUI.__init__()=epydoc.gui.EpydocGUI-class.html#__init__,Method epydoc.gui.GUILogger.__init__()=epydoc.gui.GUILogger-class.html#__init__,Method epydoc.log.SimpleLogger.__init__()=epydoc.log.SimpleLogger-class.html#__init__,Method epydoc.markup.ConcatenatedDocstring.__init__()=epydoc.markup.ConcatenatedDocstring-class.html#__init__,Method epydoc.markup.Field.__init__()=epydoc.markup.Field-class.html#__init__,Method epydoc.markup.ParseError.__init__()=epydoc.markup.ParseError-class.html#__init__,Method epydoc.markup.epytext.ColorizingError.__init__()=epydoc.markup.epytext.ColorizingError-class.html#__init__,Method epydoc.markup.epytext.Element.__init__()=epydoc.markup.epytext.Element-class.html#__init__,Method epydoc.markup.epytext.ParsedEpytextDocstring.__init__()=epydoc.markup.epytext.ParsedEpytextDocstring-class.html#__init__,Method epydoc.markup.epytext.Token.__init__()=epydoc.markup.epytext.Token-class.html#__init__,Method epydoc.markup.javadoc.ParsedJavadocDocstring.__init__()=epydoc.markup.javadoc.ParsedJavadocDocstring-class.html#__init__,Method epydoc.markup.plaintext.ParsedPlaintextDocstring.__init__()=epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#__init__,Method epydoc.markup.pyval_repr.ColorizedPyvalRepr.__init__()=epydoc.markup.pyval_repr.ColorizedPyvalRepr-class.html#__init__,Method epydoc.markup.pyval_repr.PyvalColorizer.__init__()=epydoc.markup.pyval_repr.PyvalColorizer-class.html#__init__,Method epydoc.markup.pyval_repr._ColorizerState.__init__()=epydoc.markup.pyval_repr._ColorizerState-class.html#__init__,Method epydoc.markup.restructuredtext.ParsedRstDocstring.__init__()=epydoc.markup.restructuredtext.ParsedRstDocstring-class.html#__init__,Method epydoc.markup.restructuredtext._DocumentPseudoWriter.__init__()=epydoc.markup.restructuredtext._DocumentPseudoWriter-class.html#__init__,Method epydoc.markup.restructuredtext._EpydocHTMLTranslator.__init__()=epydoc.markup.restructuredtext._EpydocHTMLTranslator-class.html#__init__,Method epydoc.markup.restructuredtext._EpydocLaTeXTranslator.__init__()=epydoc.markup.restructuredtext._EpydocLaTeXTranslator-class.html#__init__,Method epydoc.markup.restructuredtext._EpydocReader.__init__()=epydoc.markup.restructuredtext._EpydocReader-class.html#__init__,Method epydoc.markup.restructuredtext._SplitFieldsTranslator.__init__()=epydoc.markup.restructuredtext._SplitFieldsTranslator-class.html#__init__,Method epydoc.markup.restructuredtext._SummaryExtractor.__init__()=epydoc.markup.restructuredtext._SummaryExtractor-class.html#__init__,Method epydoc.markup.restructuredtext._TermsExtractor.__init__()=epydoc.markup.restructuredtext._TermsExtractor-class.html#__init__,Method epydoc.markup.restructuredtext.dotgraph.__init__()=epydoc.markup.restructuredtext.dotgraph-class.html#__init__,Method epydoc.util.RunSubprocessError.__init__()=epydoc.util.RunSubprocessError-class.html#__init__"><a title="epydoc.apidoc.APIDoc.__init__
epydoc.apidoc.DocIndex.__init__
epydoc.apidoc.DottedName.__init__
epydoc.apidoc.NamespaceDoc.__init__
epydoc.apidoc.VariableDoc.__init__
epydoc.apidoc._Sentinel.__init__
epydoc.checker.DocChecker.__init__
epydoc.cli.ConsoleLogger.__init__
epydoc.cli.HTMLLogger.__init__
epydoc.cli.TerminalController.__init__
epydoc.cli.UnifiedProgressConsoleLogger.__init__
epydoc.docbuilder.BuildOptions.__init__
epydoc.docbuilder._ProgressEstimator.__init__
epydoc.docintrospecter._DevNull.__init__
epydoc.docstringparser.DocstringField.__init__
epydoc.docwriter.dotgraph.DotGraph.__init__
epydoc.docwriter.dotgraph.DotGraphEdge.__init__
epydoc.docwriter.dotgraph.DotGraphNode.__init__
epydoc.docwriter.dotgraph.DotGraphUmlClassNode.__init__
epydoc.docwriter.dotgraph.DotGraphUmlModuleNode.__init__
epydoc.docwriter.html.HTMLWriter.__init__
epydoc.docwriter.html._HTMLDocstringLinker.__init__
epydoc.docwriter.html_colorize.PythonSourceColorizer.__init__
epydoc.docwriter.latex.LatexWriter.__init__
epydoc.docwriter.xlink.ApiLinkReader.__init__
epydoc.docwriter.xlink.DocUrlGenerator.__init__
epydoc.gui.EpydocGUI.__init__
epydoc.gui.GUILogger.__init__
epydoc.log.SimpleLogger.__init__
epydoc.markup.ConcatenatedDocstring.__init__
epydoc.markup.Field.__init__
epydoc.markup.ParseError.__init__
epydoc.markup.epytext.ColorizingError.__init__
epydoc.markup.epytext.Element.__init__
epydoc.markup.epytext.ParsedEpytextDocstring.__init__
epydoc.markup.epytext.Token.__init__
epydoc.markup.javadoc.ParsedJavadocDocstring.__init__
epydoc.markup.plaintext.ParsedPlaintextDocstring.__init__
epydoc.markup.pyval_repr.ColorizedPyvalRepr.__init__
epydoc.markup.pyval_repr.PyvalColorizer.__init__
epydoc.markup.pyval_repr._ColorizerState.__init__
epydoc.markup.restructuredtext.ParsedRstDocstring.__init__
epydoc.markup.restructuredtext._DocumentPseudoWriter.__init__
epydoc.markup.restructuredtext._EpydocHTMLTranslator.__init__
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.__init__
epydoc.markup.restructuredtext._EpydocReader.__init__
epydoc.markup.restructuredtext._SplitFieldsTranslator.__init__
epydoc.markup.restructuredtext._SummaryExtractor.__init__
epydoc.markup.restructuredtext._TermsExtractor.__init__
epydoc.markup.restructuredtext.dotgraph.__init__
epydoc.util.RunSubprocessError.__init__" class="py-name" href="#" onclick="return doclink('link-363', '__init__', 'link-363');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt id="link-364" 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-364', 'descr', 'link-364');">descr</a></tt><tt class="py-op">,</tt> <tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">startline</tt><tt class="py-op">,</tt> <tt id="link-365" class="py-name"><a title="epydoc.markup.ParseError.is_fatal" class="py-name" href="#" onclick="return doclink('link-365', 'is_fatal', 'link-56');">is_fatal</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1589"></a><tt class="py-lineno">1589</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">token</tt> <tt class="py-op">=</tt> <tt class="py-name">token</tt> </tt>
<a name="L1590"></a><tt class="py-lineno">1590</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">charnum</tt> <tt class="py-op">=</tt> <tt class="py-name">charnum</tt> </tt>
</div><a name="L1591"></a><tt class="py-lineno">1591</tt> <tt class="py-line"> </tt>
<a name="L1592"></a><tt class="py-lineno">1592</tt> <tt class="py-line"> <tt id="link-366" class="py-name" targets="Variable epydoc.markup.epytext.ColorizingError.CONTEXT_RANGE=epydoc.markup.epytext.ColorizingError-class.html#CONTEXT_RANGE"><a title="epydoc.markup.epytext.ColorizingError.CONTEXT_RANGE" class="py-name" href="#" onclick="return doclink('link-366', 'CONTEXT_RANGE', 'link-366');">CONTEXT_RANGE</a></tt> <tt class="py-op">=</tt> <tt class="py-number">20</tt> </tt>
<a name="ColorizingError.descr"></a><div id="ColorizingError.descr-def"><a name="L1593"></a><tt class="py-lineno">1593</tt> <a class="py-toggle" href="#" id="ColorizingError.descr-toggle" onclick="return toggle('ColorizingError.descr');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext.ColorizingError-class.html#descr">descr</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="ColorizingError.descr-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ColorizingError.descr-expanded"><a name="L1594"></a><tt class="py-lineno">1594</tt> <tt class="py-line"> <tt class="py-name">RANGE</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-367" class="py-name"><a title="epydoc.markup.epytext.ColorizingError.CONTEXT_RANGE" class="py-name" href="#" onclick="return doclink('link-367', 'CONTEXT_RANGE', 'link-366');">CONTEXT_RANGE</a></tt> </tt>
<a name="L1595"></a><tt class="py-lineno">1595</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">charnum</tt> <tt class="py-op"><=</tt> <tt class="py-name">RANGE</tt><tt class="py-op">:</tt> </tt>
<a name="L1596"></a><tt class="py-lineno">1596</tt> <tt class="py-line"> <tt class="py-name">left</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">contents</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 class="py-name">charnum</tt><tt class="py-op">]</tt> </tt>
<a name="L1597"></a><tt class="py-lineno">1597</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1598"></a><tt class="py-lineno">1598</tt> <tt class="py-line"> <tt class="py-name">left</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">token</tt><tt class="py-op">.</tt><tt class="py-name">contents</tt><tt class="py-op">[</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">charnum</tt><tt class="py-op">-</tt><tt class="py-name">RANGE</tt><tt class="py-op">:</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">charnum</tt><tt class="py-op">]</tt> </tt>
<a name="L1599"></a><tt class="py-lineno">1599</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">self</tt><tt class="py-op">.</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">contents</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">charnum</tt><tt class="py-op">)</tt> <tt class="py-op"><=</tt> <tt class="py-name">RANGE</tt><tt class="py-op">:</tt> </tt>
<a name="L1600"></a><tt class="py-lineno">1600</tt> <tt class="py-line"> <tt class="py-name">right</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">contents</tt><tt class="py-op">[</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">charnum</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L1601"></a><tt class="py-lineno">1601</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1602"></a><tt class="py-lineno">1602</tt> <tt class="py-line"> <tt class="py-name">right</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">token</tt><tt class="py-op">.</tt><tt class="py-name">contents</tt><tt class="py-op">[</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">charnum</tt><tt class="py-op">:</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">charnum</tt><tt class="py-op">+</tt><tt class="py-name">RANGE</tt><tt class="py-op">]</tt> </tt>
<a name="L1603"></a><tt class="py-lineno">1603</tt> <tt class="py-line"> <tt class="py-op">+</tt> <tt class="py-string">'...'</tt><tt class="py-op">)</tt> </tt>
<a name="L1604"></a><tt class="py-lineno">1604</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-string">'%s\n\n%s%s\n%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-368" class="py-name" targets="Method epydoc.docwriter.plaintext.PlaintextWriter._descr()=epydoc.docwriter.plaintext.PlaintextWriter-class.html#_descr"><a title="epydoc.docwriter.plaintext.PlaintextWriter._descr" class="py-name" href="#" onclick="return doclink('link-368', '_descr', 'link-368');">_descr</a></tt><tt class="py-op">,</tt> <tt class="py-name">left</tt><tt class="py-op">,</tt> <tt class="py-name">right</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">left</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L1605"></a><tt class="py-lineno">1605</tt> <tt class="py-line"> </tt>
<a name="L1606"></a><tt class="py-lineno">1606</tt> <tt class="py-line"><tt class="py-comment">##################################################</tt> </tt>
<a name="L1607"></a><tt class="py-lineno">1607</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## Convenience parsers</tt> </tt>
<a name="L1608"></a><tt class="py-lineno">1608</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">##################################################</tt> </tt>
<a name="L1609"></a><tt class="py-lineno">1609</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="parse_as_literal"></a><div id="parse_as_literal-def"><a name="L1610"></a><tt class="py-lineno">1610</tt> <a class="py-toggle" href="#" id="parse_as_literal-toggle" onclick="return toggle('parse_as_literal');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext-module.html#parse_as_literal">parse_as_literal</a><tt class="py-op">(</tt><tt class="py-param">str</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="parse_as_literal-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="parse_as_literal-expanded"><a name="L1611"></a><tt class="py-lineno">1611</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1612"></a><tt class="py-lineno">1612</tt> <tt class="py-line"><tt class="py-docstring"> Return a DOM document matching the epytext DTD, containing a</tt> </tt>
<a name="L1613"></a><tt class="py-lineno">1613</tt> <tt class="py-line"><tt class="py-docstring"> single literal block. That literal block will include the</tt> </tt>
<a name="L1614"></a><tt class="py-lineno">1614</tt> <tt class="py-line"><tt class="py-docstring"> contents of the given string. This method is typically used as a</tt> </tt>
<a name="L1615"></a><tt class="py-lineno">1615</tt> <tt class="py-line"><tt class="py-docstring"> fall-back when the parser fails.</tt> </tt>
<a name="L1616"></a><tt class="py-lineno">1616</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1617"></a><tt class="py-lineno">1617</tt> <tt class="py-line"><tt class="py-docstring"> @param str: The string which should be enclosed in a literal</tt> </tt>
<a name="L1618"></a><tt class="py-lineno">1618</tt> <tt class="py-line"><tt class="py-docstring"> block.</tt> </tt>
<a name="L1619"></a><tt class="py-lineno">1619</tt> <tt class="py-line"><tt class="py-docstring"> @type str: C{string}</tt> </tt>
<a name="L1620"></a><tt class="py-lineno">1620</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1621"></a><tt class="py-lineno">1621</tt> <tt class="py-line"><tt class="py-docstring"> @return: A DOM document containing C{str} in a single literal</tt> </tt>
<a name="L1622"></a><tt class="py-lineno">1622</tt> <tt class="py-line"><tt class="py-docstring"> block.</tt> </tt>
<a name="L1623"></a><tt class="py-lineno">1623</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{Element}</tt> </tt>
<a name="L1624"></a><tt class="py-lineno">1624</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1625"></a><tt class="py-lineno">1625</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-369" class="py-name"><a title="epydoc.markup.epytext.Element" class="py-name" href="#" onclick="return doclink('link-369', 'Element', 'link-30');">Element</a></tt><tt class="py-op">(</tt><tt class="py-string">'epytext'</tt><tt class="py-op">,</tt> <tt id="link-370" class="py-name"><a title="epydoc.markup.epytext.Element" class="py-name" href="#" onclick="return doclink('link-370', 'Element', 'link-30');">Element</a></tt><tt class="py-op">(</tt><tt class="py-string">'literalblock'</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1626"></a><tt class="py-lineno">1626</tt> <tt class="py-line"> </tt>
<a name="parse_as_para"></a><div id="parse_as_para-def"><a name="L1627"></a><tt class="py-lineno">1627</tt> <a class="py-toggle" href="#" id="parse_as_para-toggle" onclick="return toggle('parse_as_para');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext-module.html#parse_as_para">parse_as_para</a><tt class="py-op">(</tt><tt class="py-param">str</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="parse_as_para-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="parse_as_para-expanded"><a name="L1628"></a><tt class="py-lineno">1628</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1629"></a><tt class="py-lineno">1629</tt> <tt class="py-line"><tt class="py-docstring"> Return a DOM document matching the epytext DTD, containing a</tt> </tt>
<a name="L1630"></a><tt class="py-lineno">1630</tt> <tt class="py-line"><tt class="py-docstring"> single paragraph. That paragraph will include the contents of the</tt> </tt>
<a name="L1631"></a><tt class="py-lineno">1631</tt> <tt class="py-line"><tt class="py-docstring"> given string. This can be used to wrap some forms of</tt> </tt>
<a name="L1632"></a><tt class="py-lineno">1632</tt> <tt class="py-line"><tt class="py-docstring"> automatically generated information (such as type names) in</tt> </tt>
<a name="L1633"></a><tt class="py-lineno">1633</tt> <tt class="py-line"><tt class="py-docstring"> paragraphs.</tt> </tt>
<a name="L1634"></a><tt class="py-lineno">1634</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1635"></a><tt class="py-lineno">1635</tt> <tt class="py-line"><tt class="py-docstring"> @param str: The string which should be enclosed in a paragraph.</tt> </tt>
<a name="L1636"></a><tt class="py-lineno">1636</tt> <tt class="py-line"><tt class="py-docstring"> @type str: C{string}</tt> </tt>
<a name="L1637"></a><tt class="py-lineno">1637</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1638"></a><tt class="py-lineno">1638</tt> <tt class="py-line"><tt class="py-docstring"> @return: A DOM document containing C{str} in a single paragraph.</tt> </tt>
<a name="L1639"></a><tt class="py-lineno">1639</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{Element}</tt> </tt>
<a name="L1640"></a><tt class="py-lineno">1640</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1641"></a><tt class="py-lineno">1641</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-371" class="py-name"><a title="epydoc.markup.epytext.Element" class="py-name" href="#" onclick="return doclink('link-371', 'Element', 'link-30');">Element</a></tt><tt class="py-op">(</tt><tt class="py-string">'epytext'</tt><tt class="py-op">,</tt> <tt id="link-372" class="py-name"><a title="epydoc.markup.epytext.Element" class="py-name" href="#" onclick="return doclink('link-372', 'Element', 'link-30');">Element</a></tt><tt class="py-op">(</tt><tt class="py-string">'para'</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1642"></a><tt class="py-lineno">1642</tt> <tt class="py-line"> </tt>
<a name="L1643"></a><tt class="py-lineno">1643</tt> <tt class="py-line"><tt class="py-comment">#################################################################</tt> </tt>
<a name="L1644"></a><tt class="py-lineno">1644</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## SUPPORT FOR EPYDOC</tt> </tt>
<a name="L1645"></a><tt class="py-lineno">1645</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#################################################################</tt> </tt>
<a name="L1646"></a><tt class="py-lineno">1646</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="parse_docstring"></a><div id="parse_docstring-def"><a name="L1647"></a><tt class="py-lineno">1647</tt> <a class="py-toggle" href="#" id="parse_docstring-toggle" onclick="return toggle('parse_docstring');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext-module.html#parse_docstring">parse_docstring</a><tt class="py-op">(</tt><tt class="py-param">docstring</tt><tt class="py-op">,</tt> <tt class="py-param">errors</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">options</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="parse_docstring-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="parse_docstring-expanded"><a name="L1648"></a><tt class="py-lineno">1648</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1649"></a><tt class="py-lineno">1649</tt> <tt class="py-line"><tt class="py-docstring"> Parse the given docstring, which is formatted using epytext; and</tt> </tt>
<a name="L1650"></a><tt class="py-lineno">1650</tt> <tt class="py-line"><tt class="py-docstring"> return a C{ParsedDocstring} representation of its contents.</tt> </tt>
<a name="L1651"></a><tt class="py-lineno">1651</tt> <tt class="py-line"><tt class="py-docstring"> @param docstring: The docstring to parse</tt> </tt>
<a name="L1652"></a><tt class="py-lineno">1652</tt> <tt class="py-line"><tt class="py-docstring"> @type docstring: C{string}</tt> </tt>
<a name="L1653"></a><tt class="py-lineno">1653</tt> <tt class="py-line"><tt class="py-docstring"> @param errors: A list where any errors generated during parsing</tt> </tt>
<a name="L1654"></a><tt class="py-lineno">1654</tt> <tt class="py-line"><tt class="py-docstring"> will be stored.</tt> </tt>
<a name="L1655"></a><tt class="py-lineno">1655</tt> <tt class="py-line"><tt class="py-docstring"> @type errors: C{list} of L{ParseError}</tt> </tt>
<a name="L1656"></a><tt class="py-lineno">1656</tt> <tt class="py-line"><tt class="py-docstring"> @param options: Extra options. Unknown options are ignored.</tt> </tt>
<a name="L1657"></a><tt class="py-lineno">1657</tt> <tt class="py-line"><tt class="py-docstring"> Currently, no extra options are defined.</tt> </tt>
<a name="L1658"></a><tt class="py-lineno">1658</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: L{ParsedDocstring}</tt> </tt>
<a name="L1659"></a><tt class="py-lineno">1659</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1660"></a><tt class="py-lineno">1660</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-373" 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-373', 'ParsedEpytextDocstring', 'link-373');">ParsedEpytextDocstring</a></tt><tt class="py-op">(</tt><tt id="link-374" class="py-name"><a title="epydoc.markup.epytext.parse
epydoc.markup.parse" class="py-name" href="#" onclick="return doclink('link-374', 'parse', 'link-355');">parse</a></tt><tt class="py-op">(</tt><tt id="link-375" 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-375', 'docstring', 'link-375');">docstring</a></tt><tt class="py-op">,</tt> <tt class="py-name">errors</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">options</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1661"></a><tt class="py-lineno">1661</tt> <tt class="py-line"> </tt>
<a name="ParsedEpytextDocstring"></a><div id="ParsedEpytextDocstring-def"><a name="L1662"></a><tt class="py-lineno">1662</tt> <a class="py-toggle" href="#" id="ParsedEpytextDocstring-toggle" onclick="return toggle('ParsedEpytextDocstring');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html">ParsedEpytextDocstring</a><tt class="py-op">(</tt><tt class="py-base-class">ParsedDocstring</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ParsedEpytextDocstring-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="ParsedEpytextDocstring-expanded"><a name="L1663"></a><tt class="py-lineno">1663</tt> <tt class="py-line"> <tt id="link-376" 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-376', 'SYMBOL_TO_HTML', 'link-376');">SYMBOL_TO_HTML</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
<a name="L1664"></a><tt class="py-lineno">1664</tt> <tt class="py-line"> <tt class="py-comment"># Symbols</tt> </tt>
<a name="L1665"></a><tt class="py-lineno">1665</tt> <tt class="py-line"> <tt class="py-string">'<-'</tt><tt class="py-op">:</tt> <tt class="py-string">'&larr;'</tt><tt class="py-op">,</tt> <tt class="py-string">'->'</tt><tt class="py-op">:</tt> <tt class="py-string">'&rarr;'</tt><tt class="py-op">,</tt> <tt class="py-string">'^'</tt><tt class="py-op">:</tt> <tt class="py-string">'&uarr;'</tt><tt class="py-op">,</tt> <tt class="py-string">'v'</tt><tt class="py-op">:</tt> <tt class="py-string">'&darr;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1666"></a><tt class="py-lineno">1666</tt> <tt class="py-line"> </tt>
<a name="L1667"></a><tt class="py-lineno">1667</tt> <tt class="py-line"> <tt class="py-comment"># Greek letters</tt> </tt>
<a name="L1668"></a><tt class="py-lineno">1668</tt> <tt class="py-line"> <tt class="py-string">'alpha'</tt><tt class="py-op">:</tt> <tt class="py-string">'&alpha;'</tt><tt class="py-op">,</tt> <tt class="py-string">'beta'</tt><tt class="py-op">:</tt> <tt class="py-string">'&beta;'</tt><tt class="py-op">,</tt> <tt class="py-string">'gamma'</tt><tt class="py-op">:</tt> <tt class="py-string">'&gamma;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1669"></a><tt class="py-lineno">1669</tt> <tt class="py-line"> <tt class="py-string">'delta'</tt><tt class="py-op">:</tt> <tt class="py-string">'&delta;'</tt><tt class="py-op">,</tt> <tt class="py-string">'epsilon'</tt><tt class="py-op">:</tt> <tt class="py-string">'&epsilon;'</tt><tt class="py-op">,</tt> <tt class="py-string">'zeta'</tt><tt class="py-op">:</tt> <tt class="py-string">'&zeta;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1670"></a><tt class="py-lineno">1670</tt> <tt class="py-line"> <tt class="py-string">'eta'</tt><tt class="py-op">:</tt> <tt class="py-string">'&eta;'</tt><tt class="py-op">,</tt> <tt class="py-string">'theta'</tt><tt class="py-op">:</tt> <tt class="py-string">'&theta;'</tt><tt class="py-op">,</tt> <tt class="py-string">'iota'</tt><tt class="py-op">:</tt> <tt class="py-string">'&iota;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1671"></a><tt class="py-lineno">1671</tt> <tt class="py-line"> <tt class="py-string">'kappa'</tt><tt class="py-op">:</tt> <tt class="py-string">'&kappa;'</tt><tt class="py-op">,</tt> <tt class="py-string">'lambda'</tt><tt class="py-op">:</tt> <tt class="py-string">'&lambda;'</tt><tt class="py-op">,</tt> <tt class="py-string">'mu'</tt><tt class="py-op">:</tt> <tt class="py-string">'&mu;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1672"></a><tt class="py-lineno">1672</tt> <tt class="py-line"> <tt class="py-string">'nu'</tt><tt class="py-op">:</tt> <tt class="py-string">'&nu;'</tt><tt class="py-op">,</tt> <tt class="py-string">'xi'</tt><tt class="py-op">:</tt> <tt class="py-string">'&xi;'</tt><tt class="py-op">,</tt> <tt class="py-string">'omicron'</tt><tt class="py-op">:</tt> <tt class="py-string">'&omicron;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1673"></a><tt class="py-lineno">1673</tt> <tt class="py-line"> <tt class="py-string">'pi'</tt><tt class="py-op">:</tt> <tt class="py-string">'&pi;'</tt><tt class="py-op">,</tt> <tt class="py-string">'rho'</tt><tt class="py-op">:</tt> <tt class="py-string">'&rho;'</tt><tt class="py-op">,</tt> <tt class="py-string">'sigma'</tt><tt class="py-op">:</tt> <tt class="py-string">'&sigma;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1674"></a><tt class="py-lineno">1674</tt> <tt class="py-line"> <tt class="py-string">'tau'</tt><tt class="py-op">:</tt> <tt class="py-string">'&tau;'</tt><tt class="py-op">,</tt> <tt class="py-string">'upsilon'</tt><tt class="py-op">:</tt> <tt class="py-string">'&upsilon;'</tt><tt class="py-op">,</tt> <tt class="py-string">'phi'</tt><tt class="py-op">:</tt> <tt class="py-string">'&phi;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1675"></a><tt class="py-lineno">1675</tt> <tt class="py-line"> <tt class="py-string">'chi'</tt><tt class="py-op">:</tt> <tt class="py-string">'&chi;'</tt><tt class="py-op">,</tt> <tt class="py-string">'psi'</tt><tt class="py-op">:</tt> <tt class="py-string">'&psi;'</tt><tt class="py-op">,</tt> <tt class="py-string">'omega'</tt><tt class="py-op">:</tt> <tt class="py-string">'&omega;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1676"></a><tt class="py-lineno">1676</tt> <tt class="py-line"> <tt class="py-string">'Alpha'</tt><tt class="py-op">:</tt> <tt class="py-string">'&Alpha;'</tt><tt class="py-op">,</tt> <tt class="py-string">'Beta'</tt><tt class="py-op">:</tt> <tt class="py-string">'&Beta;'</tt><tt class="py-op">,</tt> <tt class="py-string">'Gamma'</tt><tt class="py-op">:</tt> <tt class="py-string">'&Gamma;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1677"></a><tt class="py-lineno">1677</tt> <tt class="py-line"> <tt class="py-string">'Delta'</tt><tt class="py-op">:</tt> <tt class="py-string">'&Delta;'</tt><tt class="py-op">,</tt> <tt class="py-string">'Epsilon'</tt><tt class="py-op">:</tt> <tt class="py-string">'&Epsilon;'</tt><tt class="py-op">,</tt> <tt class="py-string">'Zeta'</tt><tt class="py-op">:</tt> <tt class="py-string">'&Zeta;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1678"></a><tt class="py-lineno">1678</tt> <tt class="py-line"> <tt class="py-string">'Eta'</tt><tt class="py-op">:</tt> <tt class="py-string">'&Eta;'</tt><tt class="py-op">,</tt> <tt class="py-string">'Theta'</tt><tt class="py-op">:</tt> <tt class="py-string">'&Theta;'</tt><tt class="py-op">,</tt> <tt class="py-string">'Iota'</tt><tt class="py-op">:</tt> <tt class="py-string">'&Iota;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1679"></a><tt class="py-lineno">1679</tt> <tt class="py-line"> <tt class="py-string">'Kappa'</tt><tt class="py-op">:</tt> <tt class="py-string">'&Kappa;'</tt><tt class="py-op">,</tt> <tt class="py-string">'Lambda'</tt><tt class="py-op">:</tt> <tt class="py-string">'&Lambda;'</tt><tt class="py-op">,</tt> <tt class="py-string">'Mu'</tt><tt class="py-op">:</tt> <tt class="py-string">'&Mu;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1680"></a><tt class="py-lineno">1680</tt> <tt class="py-line"> <tt class="py-string">'Nu'</tt><tt class="py-op">:</tt> <tt class="py-string">'&Nu;'</tt><tt class="py-op">,</tt> <tt class="py-string">'Xi'</tt><tt class="py-op">:</tt> <tt class="py-string">'&Xi;'</tt><tt class="py-op">,</tt> <tt class="py-string">'Omicron'</tt><tt class="py-op">:</tt> <tt class="py-string">'&Omicron;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1681"></a><tt class="py-lineno">1681</tt> <tt class="py-line"> <tt class="py-string">'Pi'</tt><tt class="py-op">:</tt> <tt class="py-string">'&Pi;'</tt><tt class="py-op">,</tt> <tt class="py-string">'Rho'</tt><tt class="py-op">:</tt> <tt class="py-string">'&Rho;'</tt><tt class="py-op">,</tt> <tt class="py-string">'Sigma'</tt><tt class="py-op">:</tt> <tt class="py-string">'&Sigma;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1682"></a><tt class="py-lineno">1682</tt> <tt class="py-line"> <tt class="py-string">'Tau'</tt><tt class="py-op">:</tt> <tt class="py-string">'&Tau;'</tt><tt class="py-op">,</tt> <tt class="py-string">'Upsilon'</tt><tt class="py-op">:</tt> <tt class="py-string">'&Upsilon;'</tt><tt class="py-op">,</tt> <tt class="py-string">'Phi'</tt><tt class="py-op">:</tt> <tt class="py-string">'&Phi;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1683"></a><tt class="py-lineno">1683</tt> <tt class="py-line"> <tt class="py-string">'Chi'</tt><tt class="py-op">:</tt> <tt class="py-string">'&Chi;'</tt><tt class="py-op">,</tt> <tt class="py-string">'Psi'</tt><tt class="py-op">:</tt> <tt class="py-string">'&Psi;'</tt><tt class="py-op">,</tt> <tt class="py-string">'Omega'</tt><tt class="py-op">:</tt> <tt class="py-string">'&Omega;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1684"></a><tt class="py-lineno">1684</tt> <tt class="py-line"> </tt>
<a name="L1685"></a><tt class="py-lineno">1685</tt> <tt class="py-line"> <tt class="py-comment"># HTML character entities</tt> </tt>
<a name="L1686"></a><tt class="py-lineno">1686</tt> <tt class="py-line"> <tt class="py-string">'larr'</tt><tt class="py-op">:</tt> <tt class="py-string">'&larr;'</tt><tt class="py-op">,</tt> <tt class="py-string">'rarr'</tt><tt class="py-op">:</tt> <tt class="py-string">'&rarr;'</tt><tt class="py-op">,</tt> <tt class="py-string">'uarr'</tt><tt class="py-op">:</tt> <tt class="py-string">'&uarr;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1687"></a><tt class="py-lineno">1687</tt> <tt class="py-line"> <tt class="py-string">'darr'</tt><tt class="py-op">:</tt> <tt class="py-string">'&darr;'</tt><tt class="py-op">,</tt> <tt class="py-string">'harr'</tt><tt class="py-op">:</tt> <tt class="py-string">'&harr;'</tt><tt class="py-op">,</tt> <tt class="py-string">'crarr'</tt><tt class="py-op">:</tt> <tt class="py-string">'&crarr;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1688"></a><tt class="py-lineno">1688</tt> <tt class="py-line"> <tt class="py-string">'lArr'</tt><tt class="py-op">:</tt> <tt class="py-string">'&lArr;'</tt><tt class="py-op">,</tt> <tt class="py-string">'rArr'</tt><tt class="py-op">:</tt> <tt class="py-string">'&rArr;'</tt><tt class="py-op">,</tt> <tt class="py-string">'uArr'</tt><tt class="py-op">:</tt> <tt class="py-string">'&uArr;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1689"></a><tt class="py-lineno">1689</tt> <tt class="py-line"> <tt class="py-string">'dArr'</tt><tt class="py-op">:</tt> <tt class="py-string">'&dArr;'</tt><tt class="py-op">,</tt> <tt class="py-string">'hArr'</tt><tt class="py-op">:</tt> <tt class="py-string">'&hArr;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1690"></a><tt class="py-lineno">1690</tt> <tt class="py-line"> <tt class="py-string">'copy'</tt><tt class="py-op">:</tt> <tt class="py-string">'&copy;'</tt><tt class="py-op">,</tt> <tt class="py-string">'times'</tt><tt class="py-op">:</tt> <tt class="py-string">'&times;'</tt><tt class="py-op">,</tt> <tt class="py-string">'forall'</tt><tt class="py-op">:</tt> <tt class="py-string">'&forall;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1691"></a><tt class="py-lineno">1691</tt> <tt class="py-line"> <tt class="py-string">'exist'</tt><tt class="py-op">:</tt> <tt class="py-string">'&exist;'</tt><tt class="py-op">,</tt> <tt class="py-string">'part'</tt><tt class="py-op">:</tt> <tt class="py-string">'&part;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1692"></a><tt class="py-lineno">1692</tt> <tt class="py-line"> <tt class="py-string">'empty'</tt><tt class="py-op">:</tt> <tt class="py-string">'&empty;'</tt><tt class="py-op">,</tt> <tt class="py-string">'isin'</tt><tt class="py-op">:</tt> <tt class="py-string">'&isin;'</tt><tt class="py-op">,</tt> <tt class="py-string">'notin'</tt><tt class="py-op">:</tt> <tt class="py-string">'&notin;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1693"></a><tt class="py-lineno">1693</tt> <tt class="py-line"> <tt class="py-string">'ni'</tt><tt class="py-op">:</tt> <tt class="py-string">'&ni;'</tt><tt class="py-op">,</tt> <tt class="py-string">'prod'</tt><tt class="py-op">:</tt> <tt class="py-string">'&prod;'</tt><tt class="py-op">,</tt> <tt class="py-string">'sum'</tt><tt class="py-op">:</tt> <tt class="py-string">'&sum;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1694"></a><tt class="py-lineno">1694</tt> <tt class="py-line"> <tt class="py-string">'prop'</tt><tt class="py-op">:</tt> <tt class="py-string">'&prop;'</tt><tt class="py-op">,</tt> <tt class="py-string">'infin'</tt><tt class="py-op">:</tt> <tt class="py-string">'&infin;'</tt><tt class="py-op">,</tt> <tt class="py-string">'ang'</tt><tt class="py-op">:</tt> <tt class="py-string">'&ang;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1695"></a><tt class="py-lineno">1695</tt> <tt class="py-line"> <tt class="py-string">'and'</tt><tt class="py-op">:</tt> <tt class="py-string">'&and;'</tt><tt class="py-op">,</tt> <tt class="py-string">'or'</tt><tt class="py-op">:</tt> <tt class="py-string">'&or;'</tt><tt class="py-op">,</tt> <tt class="py-string">'cap'</tt><tt class="py-op">:</tt> <tt class="py-string">'&cap;'</tt><tt class="py-op">,</tt> <tt class="py-string">'cup'</tt><tt class="py-op">:</tt> <tt class="py-string">'&cup;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1696"></a><tt class="py-lineno">1696</tt> <tt class="py-line"> <tt class="py-string">'int'</tt><tt class="py-op">:</tt> <tt class="py-string">'&int;'</tt><tt class="py-op">,</tt> <tt class="py-string">'there4'</tt><tt class="py-op">:</tt> <tt class="py-string">'&there4;'</tt><tt class="py-op">,</tt> <tt class="py-string">'sim'</tt><tt class="py-op">:</tt> <tt class="py-string">'&sim;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1697"></a><tt class="py-lineno">1697</tt> <tt class="py-line"> <tt class="py-string">'cong'</tt><tt class="py-op">:</tt> <tt class="py-string">'&cong;'</tt><tt class="py-op">,</tt> <tt class="py-string">'asymp'</tt><tt class="py-op">:</tt> <tt class="py-string">'&asymp;'</tt><tt class="py-op">,</tt> <tt class="py-string">'ne'</tt><tt class="py-op">:</tt> <tt class="py-string">'&ne;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1698"></a><tt class="py-lineno">1698</tt> <tt class="py-line"> <tt class="py-string">'equiv'</tt><tt class="py-op">:</tt> <tt class="py-string">'&equiv;'</tt><tt class="py-op">,</tt> <tt class="py-string">'le'</tt><tt class="py-op">:</tt> <tt class="py-string">'&le;'</tt><tt class="py-op">,</tt> <tt class="py-string">'ge'</tt><tt class="py-op">:</tt> <tt class="py-string">'&ge;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1699"></a><tt class="py-lineno">1699</tt> <tt class="py-line"> <tt class="py-string">'sub'</tt><tt class="py-op">:</tt> <tt class="py-string">'&sub;'</tt><tt class="py-op">,</tt> <tt class="py-string">'sup'</tt><tt class="py-op">:</tt> <tt class="py-string">'&sup;'</tt><tt class="py-op">,</tt> <tt class="py-string">'nsub'</tt><tt class="py-op">:</tt> <tt class="py-string">'&nsub;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1700"></a><tt class="py-lineno">1700</tt> <tt class="py-line"> <tt class="py-string">'sube'</tt><tt class="py-op">:</tt> <tt class="py-string">'&sube;'</tt><tt class="py-op">,</tt> <tt class="py-string">'supe'</tt><tt class="py-op">:</tt> <tt class="py-string">'&supe;'</tt><tt class="py-op">,</tt> <tt class="py-string">'oplus'</tt><tt class="py-op">:</tt> <tt class="py-string">'&oplus;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1701"></a><tt class="py-lineno">1701</tt> <tt class="py-line"> <tt class="py-string">'otimes'</tt><tt class="py-op">:</tt> <tt class="py-string">'&otimes;'</tt><tt class="py-op">,</tt> <tt class="py-string">'perp'</tt><tt class="py-op">:</tt> <tt class="py-string">'&perp;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1702"></a><tt class="py-lineno">1702</tt> <tt class="py-line"> </tt>
<a name="L1703"></a><tt class="py-lineno">1703</tt> <tt class="py-line"> <tt class="py-comment"># Alternate (long) names</tt> </tt>
<a name="L1704"></a><tt class="py-lineno">1704</tt> <tt class="py-line"> <tt class="py-string">'infinity'</tt><tt class="py-op">:</tt> <tt class="py-string">'&infin;'</tt><tt class="py-op">,</tt> <tt class="py-string">'integral'</tt><tt class="py-op">:</tt> <tt class="py-string">'&int;'</tt><tt class="py-op">,</tt> <tt class="py-string">'product'</tt><tt class="py-op">:</tt> <tt class="py-string">'&prod;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1705"></a><tt class="py-lineno">1705</tt> <tt class="py-line"> <tt class="py-string">'<='</tt><tt class="py-op">:</tt> <tt class="py-string">'&le;'</tt><tt class="py-op">,</tt> <tt class="py-string">'>='</tt><tt class="py-op">:</tt> <tt class="py-string">'&ge;'</tt><tt class="py-op">,</tt> </tt>
<a name="L1706"></a><tt class="py-lineno">1706</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt>
<a name="L1707"></a><tt class="py-lineno">1707</tt> <tt class="py-line"> </tt>
<a name="L1708"></a><tt class="py-lineno">1708</tt> <tt class="py-line"> <tt id="link-377" class="py-name" targets="Variable epydoc.markup.epytext.ParsedEpytextDocstring.SYMBOL_TO_LATEX=epydoc.markup.epytext.ParsedEpytextDocstring-class.html#SYMBOL_TO_LATEX"><a title="epydoc.markup.epytext.ParsedEpytextDocstring.SYMBOL_TO_LATEX" class="py-name" href="#" onclick="return doclink('link-377', 'SYMBOL_TO_LATEX', 'link-377');">SYMBOL_TO_LATEX</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
<a name="L1709"></a><tt class="py-lineno">1709</tt> <tt class="py-line"> <tt class="py-comment"># Symbols</tt> </tt>
<a name="L1710"></a><tt class="py-lineno">1710</tt> <tt class="py-line"> <tt class="py-string">'<-'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\leftarrow\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'->'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\rightarrow\)'</tt><tt class="py-op">,</tt> </tt>
<a name="L1711"></a><tt class="py-lineno">1711</tt> <tt class="py-line"> <tt class="py-string">'^'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\uparrow\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'v'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\downarrow\)'</tt><tt class="py-op">,</tt> </tt>
<a name="L1712"></a><tt class="py-lineno">1712</tt> <tt class="py-line"> </tt>
<a name="L1713"></a><tt class="py-lineno">1713</tt> <tt class="py-line"> <tt class="py-comment"># Greek letters (use lower case when upcase not available)</tt> </tt>
<a name="L1714"></a><tt class="py-lineno">1714</tt> <tt class="py-line"> </tt>
<a name="L1715"></a><tt class="py-lineno">1715</tt> <tt class="py-line"> <tt class="py-string">'alpha'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\alpha\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'beta'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\beta\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'gamma'</tt><tt class="py-op">:</tt> </tt>
<a name="L1716"></a><tt class="py-lineno">1716</tt> <tt class="py-line"> <tt class="py-string">r'\(\gamma\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'delta'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\delta\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'epsilon'</tt><tt class="py-op">:</tt> </tt>
<a name="L1717"></a><tt class="py-lineno">1717</tt> <tt class="py-line"> <tt class="py-string">r'\(\epsilon\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'zeta'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\zeta\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'eta'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\eta\)'</tt><tt class="py-op">,</tt> </tt>
<a name="L1718"></a><tt class="py-lineno">1718</tt> <tt class="py-line"> <tt class="py-string">'theta'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\theta\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'iota'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\iota\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'kappa'</tt><tt class="py-op">:</tt> </tt>
<a name="L1719"></a><tt class="py-lineno">1719</tt> <tt class="py-line"> <tt class="py-string">r'\(\kappa\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'lambda'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\lambda\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'mu'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\mu\)'</tt><tt class="py-op">,</tt> </tt>
<a name="L1720"></a><tt class="py-lineno">1720</tt> <tt class="py-line"> <tt class="py-string">'nu'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\nu\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'xi'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\xi\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'omicron'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(o\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'pi'</tt><tt class="py-op">:</tt> </tt>
<a name="L1721"></a><tt class="py-lineno">1721</tt> <tt class="py-line"> <tt class="py-string">r'\(\pi\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'rho'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\rho\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'sigma'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\sigma\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'tau'</tt><tt class="py-op">:</tt> </tt>
<a name="L1722"></a><tt class="py-lineno">1722</tt> <tt class="py-line"> <tt class="py-string">r'\(\tau\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'upsilon'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\upsilon\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'phi'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\phi\)'</tt><tt class="py-op">,</tt> </tt>
<a name="L1723"></a><tt class="py-lineno">1723</tt> <tt class="py-line"> <tt class="py-string">'chi'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\chi\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'psi'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\psi\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'omega'</tt><tt class="py-op">:</tt> </tt>
<a name="L1724"></a><tt class="py-lineno">1724</tt> <tt class="py-line"> <tt class="py-string">r'\(\omega\)'</tt><tt class="py-op">,</tt> </tt>
<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-string">'Alpha'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\alpha\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'Beta'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\beta\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'Gamma'</tt><tt class="py-op">:</tt> </tt>
<a name="L1727"></a><tt class="py-lineno">1727</tt> <tt class="py-line"> <tt class="py-string">r'\(\Gamma\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'Delta'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\Delta\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'Epsilon'</tt><tt class="py-op">:</tt> </tt>
<a name="L1728"></a><tt class="py-lineno">1728</tt> <tt class="py-line"> <tt class="py-string">r'\(\epsilon\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'Zeta'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\zeta\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'Eta'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\eta\)'</tt><tt class="py-op">,</tt> </tt>
<a name="L1729"></a><tt class="py-lineno">1729</tt> <tt class="py-line"> <tt class="py-string">'Theta'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\Theta\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'Iota'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\iota\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'Kappa'</tt><tt class="py-op">:</tt> </tt>
<a name="L1730"></a><tt class="py-lineno">1730</tt> <tt class="py-line"> <tt class="py-string">r'\(\kappa\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'Lambda'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\Lambda\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'Mu'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\mu\)'</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">'Nu'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\nu\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'Xi'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\Xi\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'Omicron'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(o\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'Pi'</tt><tt class="py-op">:</tt> </tt>
<a name="L1732"></a><tt class="py-lineno">1732</tt> <tt class="py-line"> <tt class="py-string">r'\(\Pi\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'ho'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\rho\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'Sigma'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\Sigma\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'Tau'</tt><tt class="py-op">:</tt> </tt>
<a name="L1733"></a><tt class="py-lineno">1733</tt> <tt class="py-line"> <tt class="py-string">r'\(\tau\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'Upsilon'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\Upsilon\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'Phi'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\Phi\)'</tt><tt class="py-op">,</tt> </tt>
<a name="L1734"></a><tt class="py-lineno">1734</tt> <tt class="py-line"> <tt class="py-string">'Chi'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\chi\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'Psi'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\Psi\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'Omega'</tt><tt class="py-op">:</tt> </tt>
<a name="L1735"></a><tt class="py-lineno">1735</tt> <tt class="py-line"> <tt class="py-string">r'\(\Omega\)'</tt><tt class="py-op">,</tt> </tt>
<a name="L1736"></a><tt class="py-lineno">1736</tt> <tt class="py-line"> </tt>
<a name="L1737"></a><tt class="py-lineno">1737</tt> <tt class="py-line"> <tt class="py-comment"># HTML character entities</tt> </tt>
<a name="L1738"></a><tt class="py-lineno">1738</tt> <tt class="py-line"> <tt class="py-string">'larr'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\leftarrow\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'rarr'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\rightarrow\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'uarr'</tt><tt class="py-op">:</tt> </tt>
<a name="L1739"></a><tt class="py-lineno">1739</tt> <tt class="py-line"> <tt class="py-string">r'\(\uparrow\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'darr'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\downarrow\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'harr'</tt><tt class="py-op">:</tt> </tt>
<a name="L1740"></a><tt class="py-lineno">1740</tt> <tt class="py-line"> <tt class="py-string">r'\(\leftrightarrow\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'crarr'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\hookleftarrow\)'</tt><tt class="py-op">,</tt> </tt>
<a name="L1741"></a><tt class="py-lineno">1741</tt> <tt class="py-line"> <tt class="py-string">'lArr'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\Leftarrow\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'rArr'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\Rightarrow\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'uArr'</tt><tt class="py-op">:</tt> </tt>
<a name="L1742"></a><tt class="py-lineno">1742</tt> <tt class="py-line"> <tt class="py-string">r'\(\Uparrow\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'dArr'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\Downarrow\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'hArr'</tt><tt class="py-op">:</tt> </tt>
<a name="L1743"></a><tt class="py-lineno">1743</tt> <tt class="py-line"> <tt class="py-string">r'\(\Leftrightarrow\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'copy'</tt><tt class="py-op">:</tt> <tt class="py-string">r'{\textcopyright}'</tt><tt class="py-op">,</tt> </tt>
<a name="L1744"></a><tt class="py-lineno">1744</tt> <tt class="py-line"> <tt class="py-string">'times'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\times\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'forall'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\forall\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'exist'</tt><tt class="py-op">:</tt> </tt>
<a name="L1745"></a><tt class="py-lineno">1745</tt> <tt class="py-line"> <tt class="py-string">r'\(\exists\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'part'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\partial\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'empty'</tt><tt class="py-op">:</tt> </tt>
<a name="L1746"></a><tt class="py-lineno">1746</tt> <tt class="py-line"> <tt class="py-string">r'\(\emptyset\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'isin'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\in\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'notin'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\notin\)'</tt><tt class="py-op">,</tt> </tt>
<a name="L1747"></a><tt class="py-lineno">1747</tt> <tt class="py-line"> <tt class="py-string">'ni'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\ni\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'prod'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\prod\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'sum'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\sum\)'</tt><tt class="py-op">,</tt> </tt>
<a name="L1748"></a><tt class="py-lineno">1748</tt> <tt class="py-line"> <tt class="py-string">'prop'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\propto\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'infin'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\infty\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'ang'</tt><tt class="py-op">:</tt> </tt>
<a name="L1749"></a><tt class="py-lineno">1749</tt> <tt class="py-line"> <tt class="py-string">r'\(\angle\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'and'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\wedge\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'or'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\vee\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'cap'</tt><tt class="py-op">:</tt> </tt>
<a name="L1750"></a><tt class="py-lineno">1750</tt> <tt class="py-line"> <tt class="py-string">r'\(\cap\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'cup'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\cup\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'int'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\int\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'there4'</tt><tt class="py-op">:</tt> </tt>
<a name="L1751"></a><tt class="py-lineno">1751</tt> <tt class="py-line"> <tt class="py-string">r'\(\therefore\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'sim'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\sim\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'cong'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\cong\)'</tt><tt class="py-op">,</tt> </tt>
<a name="L1752"></a><tt class="py-lineno">1752</tt> <tt class="py-line"> <tt class="py-string">'asymp'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\approx\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'ne'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\ne\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'equiv'</tt><tt class="py-op">:</tt> </tt>
<a name="L1753"></a><tt class="py-lineno">1753</tt> <tt class="py-line"> <tt class="py-string">r'\(\equiv\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'le'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\le\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'ge'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\ge\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'sub'</tt><tt class="py-op">:</tt> </tt>
<a name="L1754"></a><tt class="py-lineno">1754</tt> <tt class="py-line"> <tt class="py-string">r'\(\subset\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'sup'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\supset\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'nsub'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\supset\)'</tt><tt class="py-op">,</tt> </tt>
<a name="L1755"></a><tt class="py-lineno">1755</tt> <tt class="py-line"> <tt class="py-string">'sube'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\subseteq\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'supe'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\supseteq\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'oplus'</tt><tt class="py-op">:</tt> </tt>
<a name="L1756"></a><tt class="py-lineno">1756</tt> <tt class="py-line"> <tt class="py-string">r'\(\oplus\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'otimes'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\otimes\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'perp'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\perp\)'</tt><tt class="py-op">,</tt> </tt>
<a name="L1757"></a><tt class="py-lineno">1757</tt> <tt class="py-line"> </tt>
<a name="L1758"></a><tt class="py-lineno">1758</tt> <tt class="py-line"> <tt class="py-comment"># Alternate (long) names</tt> </tt>
<a name="L1759"></a><tt class="py-lineno">1759</tt> <tt class="py-line"> <tt class="py-string">'infinity'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\infty\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'integral'</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\int\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'product'</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">r'\(\prod\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'<='</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\le\)'</tt><tt class="py-op">,</tt> <tt class="py-string">'>='</tt><tt class="py-op">:</tt> <tt class="py-string">r'\(\ge\)'</tt><tt class="py-op">,</tt> </tt>
<a name="L1761"></a><tt class="py-lineno">1761</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt>
<a name="L1762"></a><tt class="py-lineno">1762</tt> <tt class="py-line"> </tt>
<a name="ParsedEpytextDocstring.__init__"></a><div id="ParsedEpytextDocstring.__init__-def"><a name="L1763"></a><tt class="py-lineno">1763</tt> <a class="py-toggle" href="#" id="ParsedEpytextDocstring.__init__-toggle" onclick="return toggle('ParsedEpytextDocstring.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext.ParsedEpytextDocstring-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">dom_tree</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">options</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ParsedEpytextDocstring.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ParsedEpytextDocstring.__init__-expanded"><a name="L1764"></a><tt class="py-lineno">1764</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_tree</tt> <tt class="py-op">=</tt> <tt class="py-name">dom_tree</tt> </tt>
<a name="L1765"></a><tt class="py-lineno">1765</tt> <tt class="py-line"> <tt class="py-comment"># Caching:</tt> </tt>
<a name="L1766"></a><tt class="py-lineno">1766</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">_html</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_latex</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_plaintext</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L1767"></a><tt class="py-lineno">1767</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_terms</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L1768"></a><tt class="py-lineno">1768</tt> <tt class="py-line"> <tt class="py-comment"># inline option -- mark top-level children as inline.</tt> </tt>
<a name="L1769"></a><tt class="py-lineno">1769</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">options</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'inline'</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_tree</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="L1770"></a><tt class="py-lineno">1770</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">elt</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_tree</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">:</tt> </tt>
<a name="L1771"></a><tt class="py-lineno">1771</tt> <tt class="py-line"> <tt class="py-name">elt</tt><tt class="py-op">.</tt><tt class="py-name">attribs</tt><tt class="py-op">[</tt><tt class="py-string">'inline'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
</div><a name="L1772"></a><tt class="py-lineno">1772</tt> <tt class="py-line"> </tt>
<a name="ParsedEpytextDocstring.__str__"></a><div id="ParsedEpytextDocstring.__str__-def"><a name="L1773"></a><tt class="py-lineno">1773</tt> <a class="py-toggle" href="#" id="ParsedEpytextDocstring.__str__-toggle" onclick="return toggle('ParsedEpytextDocstring.__str__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#__str__">__str__</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="ParsedEpytextDocstring.__str__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ParsedEpytextDocstring.__str__-expanded"><a name="L1774"></a><tt class="py-lineno">1774</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">self</tt><tt class="py-op">.</tt><tt class="py-name">_tree</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1775"></a><tt class="py-lineno">1775</tt> <tt class="py-line"> </tt>
<a name="ParsedEpytextDocstring.to_html"></a><div id="ParsedEpytextDocstring.to_html-def"><a name="L1776"></a><tt class="py-lineno">1776</tt> <a class="py-toggle" href="#" id="ParsedEpytextDocstring.to_html-toggle" onclick="return toggle('ParsedEpytextDocstring.to_html');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#to_html">to_html</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">docstring_linker</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-param">docindex</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
<a name="L1777"></a><tt class="py-lineno">1777</tt> <tt class="py-line"> <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 class="py-param">options</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ParsedEpytextDocstring.to_html-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ParsedEpytextDocstring.to_html-expanded"><a name="L1778"></a><tt class="py-lineno">1778</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">_html</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-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_html</tt> </tt>
<a name="L1779"></a><tt class="py-lineno">1779</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">_tree</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="L1780"></a><tt class="py-lineno">1780</tt> <tt class="py-line"> <tt class="py-name">indent</tt> <tt class="py-op">=</tt> <tt class="py-name">options</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'indent'</tt><tt class="py-op">,</tt> <tt class="py-number">0</tt><tt class="py-op">)</tt> </tt>
<a name="L1781"></a><tt class="py-lineno">1781</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_html</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-378" class="py-name" targets="Method epydoc.markup.epytext.ParsedEpytextDocstring._to_html()=epydoc.markup.epytext.ParsedEpytextDocstring-class.html#_to_html"><a title="epydoc.markup.epytext.ParsedEpytextDocstring._to_html" class="py-name" href="#" onclick="return doclink('link-378', '_to_html', 'link-378');">_to_html</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_tree</tt><tt class="py-op">,</tt> <tt class="py-name">docstring_linker</tt><tt class="py-op">,</tt> <tt class="py-name">directory</tt><tt class="py-op">,</tt> </tt>
<a name="L1782"></a><tt class="py-lineno">1782</tt> <tt class="py-line"> <tt class="py-name">docindex</tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">)</tt> </tt>
<a name="L1783"></a><tt class="py-lineno">1783</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">_html</tt> </tt>
</div><a name="L1784"></a><tt class="py-lineno">1784</tt> <tt class="py-line"> </tt>
<a name="ParsedEpytextDocstring.to_latex"></a><div id="ParsedEpytextDocstring.to_latex-def"><a name="L1785"></a><tt class="py-lineno">1785</tt> <a class="py-toggle" href="#" id="ParsedEpytextDocstring.to_latex-toggle" onclick="return toggle('ParsedEpytextDocstring.to_latex');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#to_latex">to_latex</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">docstring_linker</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">options</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ParsedEpytextDocstring.to_latex-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ParsedEpytextDocstring.to_latex-expanded"><a name="L1786"></a><tt class="py-lineno">1786</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">_latex</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-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_latex</tt> </tt>
<a name="L1787"></a><tt class="py-lineno">1787</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">_tree</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="L1788"></a><tt class="py-lineno">1788</tt> <tt class="py-line"> <tt class="py-name">indent</tt> <tt class="py-op">=</tt> <tt class="py-name">options</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'indent'</tt><tt class="py-op">,</tt> <tt class="py-number">0</tt><tt class="py-op">)</tt> </tt>
<a name="L1789"></a><tt class="py-lineno">1789</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_hyperref</tt> <tt class="py-op">=</tt> <tt class="py-name">options</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'hyperref'</tt><tt class="py-op">,</tt> <tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
<a name="L1790"></a><tt class="py-lineno">1790</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_latex</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-379" class="py-name" targets="Method epydoc.markup.epytext.ParsedEpytextDocstring._to_latex()=epydoc.markup.epytext.ParsedEpytextDocstring-class.html#_to_latex"><a title="epydoc.markup.epytext.ParsedEpytextDocstring._to_latex" class="py-name" href="#" onclick="return doclink('link-379', '_to_latex', 'link-379');">_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_tree</tt><tt class="py-op">,</tt> <tt class="py-name">docstring_linker</tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">)</tt> </tt>
<a name="L1791"></a><tt class="py-lineno">1791</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">_latex</tt> </tt>
</div><a name="L1792"></a><tt class="py-lineno">1792</tt> <tt class="py-line"> </tt>
<a name="ParsedEpytextDocstring.to_plaintext"></a><div id="ParsedEpytextDocstring.to_plaintext-def"><a name="L1793"></a><tt class="py-lineno">1793</tt> <a class="py-toggle" href="#" id="ParsedEpytextDocstring.to_plaintext-toggle" onclick="return toggle('ParsedEpytextDocstring.to_plaintext');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#to_plaintext">to_plaintext</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">docstring_linker</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">options</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ParsedEpytextDocstring.to_plaintext-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ParsedEpytextDocstring.to_plaintext-expanded"><a name="L1794"></a><tt class="py-lineno">1794</tt> <tt class="py-line"> <tt class="py-comment"># [XX] don't cache -- different options might be used!!</tt> </tt>
<a name="L1795"></a><tt class="py-lineno">1795</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#if self._plaintext is not None: return self._plaintext</tt> </tt>
<a name="L1796"></a><tt class="py-lineno">1796</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">_tree</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="L1797"></a><tt class="py-lineno">1797</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'indent'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">options</tt><tt class="py-op">:</tt> </tt>
<a name="L1798"></a><tt class="py-lineno">1798</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_plaintext</tt> <tt class="py-op">=</tt> <tt id="link-380" 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-380', 'to_plaintext', 'link-287');">to_plaintext</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_tree</tt><tt class="py-op">,</tt> </tt>
<a name="L1799"></a><tt class="py-lineno">1799</tt> <tt class="py-line"> <tt class="py-name">indent</tt><tt class="py-op">=</tt><tt class="py-name">options</tt><tt class="py-op">[</tt><tt class="py-string">'indent'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L1800"></a><tt class="py-lineno">1800</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1801"></a><tt class="py-lineno">1801</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_plaintext</tt> <tt class="py-op">=</tt> <tt id="link-381" 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-381', 'to_plaintext', 'link-287');">to_plaintext</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_tree</tt><tt class="py-op">)</tt> </tt>
<a name="L1802"></a><tt class="py-lineno">1802</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">_plaintext</tt> </tt>
</div><a name="L1803"></a><tt class="py-lineno">1803</tt> <tt class="py-line"> </tt>
<a name="ParsedEpytextDocstring._index_term_key"></a><div id="ParsedEpytextDocstring._index_term_key-def"><a name="L1804"></a><tt class="py-lineno">1804</tt> <a class="py-toggle" href="#" id="ParsedEpytextDocstring._index_term_key-toggle" onclick="return toggle('ParsedEpytextDocstring._index_term_key');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#_index_term_key">_index_term_key</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">tree</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ParsedEpytextDocstring._index_term_key-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ParsedEpytextDocstring._index_term_key-expanded"><a name="L1805"></a><tt class="py-lineno">1805</tt> <tt class="py-line"> <tt class="py-name">str</tt> <tt class="py-op">=</tt> <tt id="link-382" 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-382', 'to_plaintext', 'link-287');">to_plaintext</a></tt><tt class="py-op">(</tt><tt class="py-name">tree</tt><tt class="py-op">)</tt> </tt>
<a name="L1806"></a><tt class="py-lineno">1806</tt> <tt class="py-line"> <tt class="py-name">str</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">str</tt><tt class="py-op">)</tt> </tt>
<a name="L1807"></a><tt class="py-lineno">1807</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">str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1808"></a><tt class="py-lineno">1808</tt> <tt class="py-line"> </tt>
<a name="ParsedEpytextDocstring._to_html"></a><div id="ParsedEpytextDocstring._to_html-def"><a name="L1809"></a><tt class="py-lineno">1809</tt> <a class="py-toggle" href="#" id="ParsedEpytextDocstring._to_html-toggle" onclick="return toggle('ParsedEpytextDocstring._to_html');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#_to_html">_to_html</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">tree</tt><tt class="py-op">,</tt> <tt class="py-param">linker</tt><tt class="py-op">,</tt> <tt class="py-param">directory</tt><tt class="py-op">,</tt> <tt class="py-param">docindex</tt><tt class="py-op">,</tt> <tt class="py-param">context</tt><tt class="py-op">,</tt> </tt>
<a name="L1810"></a><tt class="py-lineno">1810</tt> <tt class="py-line"> <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-param">seclevel</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="ParsedEpytextDocstring._to_html-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ParsedEpytextDocstring._to_html-expanded"><a name="L1811"></a><tt class="py-lineno">1811</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">tree</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="L1812"></a><tt class="py-lineno">1812</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-383" class="py-name"><a title="epydoc.util.plaintext_to_html" class="py-name" href="#" onclick="return doclink('link-383', 'plaintext_to_html', 'link-6');">plaintext_to_html</a></tt><tt class="py-op">(</tt><tt class="py-name">tree</tt><tt class="py-op">)</tt> </tt>
<a name="L1813"></a><tt class="py-lineno">1813</tt> <tt class="py-line"> </tt>
<a name="L1814"></a><tt class="py-lineno">1814</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-384" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-384', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'epytext'</tt><tt class="py-op">:</tt> <tt class="py-name">indent</tt> <tt class="py-op">-=</tt> <tt class="py-number">2</tt> </tt>
<a name="L1815"></a><tt class="py-lineno">1815</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-385" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-385', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'section'</tt><tt class="py-op">:</tt> <tt class="py-name">seclevel</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L1816"></a><tt class="py-lineno">1816</tt> <tt class="py-line"> </tt>
<a name="L1817"></a><tt class="py-lineno">1817</tt> <tt class="py-line"> <tt class="py-comment"># Process the variables first.</tt> </tt>
<a name="L1818"></a><tt class="py-lineno">1818</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-386" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-386', 'variables', 'link-225');">variables</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-387" class="py-name"><a title="epydoc.markup.epytext.ParsedEpytextDocstring._to_html" class="py-name" href="#" onclick="return doclink('link-387', '_to_html', 'link-378');">_to_html</a></tt><tt class="py-op">(</tt><tt class="py-name">c</tt><tt class="py-op">,</tt> <tt class="py-name">linker</tt><tt class="py-op">,</tt> <tt class="py-name">directory</tt><tt class="py-op">,</tt> <tt class="py-name">docindex</tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">,</tt> </tt>
<a name="L1819"></a><tt class="py-lineno">1819</tt> <tt class="py-line"> <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-name">seclevel</tt><tt class="py-op">)</tt> </tt>
<a name="L1820"></a><tt class="py-lineno">1820</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">c</tt> <tt class="py-keyword">in</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">]</tt> </tt>
<a name="L1821"></a><tt class="py-lineno">1821</tt> <tt class="py-line"> </tt>
<a name="L1822"></a><tt class="py-lineno">1822</tt> <tt class="py-line"> <tt class="py-comment"># Construct the HTML string for the variables.</tt> </tt>
<a name="L1823"></a><tt class="py-lineno">1823</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">childstr</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 id="link-388" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-388', 'variables', 'link-225');">variables</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1824"></a><tt class="py-lineno">1824</tt> <tt class="py-line"> </tt>
<a name="L1825"></a><tt class="py-lineno">1825</tt> <tt class="py-line"> <tt class="py-comment"># Perform the approriate action for the DOM tree type.</tt> </tt>
<a name="L1826"></a><tt class="py-lineno">1826</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-389" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-389', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'para'</tt><tt class="py-op">:</tt> </tt>
<a name="L1827"></a><tt class="py-lineno">1827</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-390" class="py-name"><a title="epydoc.util.wordwrap" class="py-name" href="#" onclick="return doclink('link-390', 'wordwrap', 'link-5');">wordwrap</a></tt><tt class="py-op">(</tt> </tt>
<a name="L1828"></a><tt class="py-lineno">1828</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">attribs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'inline'</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-string">'%s'</tt> <tt class="py-keyword">or</tt> <tt class="py-string">'<p>%s</p>'</tt><tt class="py-op">)</tt> <tt class="py-op">%</tt> <tt class="py-name">childstr</tt><tt class="py-op">,</tt> </tt>
<a name="L1829"></a><tt class="py-lineno">1829</tt> <tt class="py-line"> <tt class="py-name">indent</tt><tt class="py-op">)</tt> </tt>
<a name="L1830"></a><tt class="py-lineno">1830</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-391" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-391', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'code'</tt><tt class="py-op">:</tt> </tt>
<a name="L1831"></a><tt class="py-lineno">1831</tt> <tt class="py-line"> <tt class="py-name">style</tt> <tt class="py-op">=</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">attribs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'style'</tt><tt class="py-op">)</tt> </tt>
<a name="L1832"></a><tt class="py-lineno">1832</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">style</tt><tt class="py-op">:</tt> </tt>
<a name="L1833"></a><tt class="py-lineno">1833</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'<code class="%s">%s</code>'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">style</tt><tt class="py-op">,</tt> <tt class="py-name">childstr</tt><tt class="py-op">)</tt> </tt>
<a name="L1834"></a><tt class="py-lineno">1834</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1835"></a><tt class="py-lineno">1835</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'<code>%s</code>'</tt> <tt class="py-op">%</tt> <tt class="py-name">childstr</tt> </tt>
<a name="L1836"></a><tt class="py-lineno">1836</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-392" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-392', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'uri'</tt><tt class="py-op">:</tt> </tt>
<a name="L1837"></a><tt class="py-lineno">1837</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-string">'<a href="%s" target="_top">%s</a>'</tt> <tt class="py-op">%</tt> </tt>
<a name="L1838"></a><tt class="py-lineno">1838</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt id="link-393" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-393', 'variables', 'link-225');">variables</a></tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt id="link-394" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-394', 'variables', 'link-225');">variables</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-op">)</tt> </tt>
<a name="L1839"></a><tt class="py-lineno">1839</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-395" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-395', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'link'</tt><tt class="py-op">:</tt> </tt>
<a name="L1840"></a><tt class="py-lineno">1840</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">linker</tt><tt class="py-op">.</tt><tt id="link-396" class="py-name" targets="Method epydoc.docwriter.html._HTMLDocstringLinker.translate_identifier_xref()=epydoc.docwriter.html._HTMLDocstringLinker-class.html#translate_identifier_xref,Method epydoc.docwriter.latex.LatexWriter._LatexDocstringLinker.translate_identifier_xref()=epydoc.docwriter.latex.LatexWriter._LatexDocstringLinker-class.html#translate_identifier_xref,Method epydoc.markup.DocstringLinker.translate_identifier_xref()=epydoc.markup.DocstringLinker-class.html#translate_identifier_xref"><a title="epydoc.docwriter.html._HTMLDocstringLinker.translate_identifier_xref
epydoc.docwriter.latex.LatexWriter._LatexDocstringLinker.translate_identifier_xref
epydoc.markup.DocstringLinker.translate_identifier_xref" class="py-name" href="#" onclick="return doclink('link-396', 'translate_identifier_xref', 'link-396');">translate_identifier_xref</a></tt><tt class="py-op">(</tt><tt id="link-397" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-397', 'variables', 'link-225');">variables</a></tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt id="link-398" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-398', 'variables', 'link-225');">variables</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="L1841"></a><tt class="py-lineno">1841</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-399" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-399', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'italic'</tt><tt class="py-op">:</tt> </tt>
<a name="L1842"></a><tt class="py-lineno">1842</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'<i>%s</i>'</tt> <tt class="py-op">%</tt> <tt class="py-name">childstr</tt> </tt>
<a name="L1843"></a><tt class="py-lineno">1843</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-400" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-400', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'math'</tt><tt class="py-op">:</tt> </tt>
<a name="L1844"></a><tt class="py-lineno">1844</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'<i class="math">%s</i>'</tt> <tt class="py-op">%</tt> <tt class="py-name">childstr</tt> </tt>
<a name="L1845"></a><tt class="py-lineno">1845</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-401" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-401', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'indexed'</tt><tt class="py-op">:</tt> </tt>
<a name="L1846"></a><tt class="py-lineno">1846</tt> <tt class="py-line"> <tt class="py-name">term</tt> <tt class="py-op">=</tt> <tt id="link-402" class="py-name"><a title="epydoc.markup.epytext.Element" class="py-name" href="#" onclick="return doclink('link-402', 'Element', 'link-30');">Element</a></tt><tt class="py-op">(</tt><tt class="py-string">'epytext'</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">attribs</tt><tt class="py-op">)</tt> </tt>
<a name="L1847"></a><tt class="py-lineno">1847</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">linker</tt><tt class="py-op">.</tt><tt id="link-403" class="py-name" targets="Method epydoc.docwriter.html._HTMLDocstringLinker.translate_indexterm()=epydoc.docwriter.html._HTMLDocstringLinker-class.html#translate_indexterm,Method epydoc.docwriter.latex.LatexWriter._LatexDocstringLinker.translate_indexterm()=epydoc.docwriter.latex.LatexWriter._LatexDocstringLinker-class.html#translate_indexterm,Method epydoc.markup.DocstringLinker.translate_indexterm()=epydoc.markup.DocstringLinker-class.html#translate_indexterm"><a title="epydoc.docwriter.html._HTMLDocstringLinker.translate_indexterm
epydoc.docwriter.latex.LatexWriter._LatexDocstringLinker.translate_indexterm
epydoc.markup.DocstringLinker.translate_indexterm" class="py-name" href="#" onclick="return doclink('link-403', 'translate_indexterm', 'link-403');">translate_indexterm</a></tt><tt class="py-op">(</tt><tt id="link-404" class="py-name"><a title="epydoc.markup.epytext.ParsedEpytextDocstring" class="py-name" href="#" onclick="return doclink('link-404', 'ParsedEpytextDocstring', 'link-373');">ParsedEpytextDocstring</a></tt><tt class="py-op">(</tt><tt class="py-name">term</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1848"></a><tt class="py-lineno">1848</tt> <tt class="py-line"> <tt class="py-comment">#term_key = self._index_term_key(tree)</tt> </tt>
<a name="L1849"></a><tt class="py-lineno">1849</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#return linker.translate_indexterm(childstr, term_key)</tt> </tt>
<a name="L1850"></a><tt class="py-lineno">1850</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-405" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-405', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'bold'</tt><tt class="py-op">:</tt> </tt>
<a name="L1851"></a><tt class="py-lineno">1851</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'<b>%s</b>'</tt> <tt class="py-op">%</tt> <tt class="py-name">childstr</tt> </tt>
<a name="L1852"></a><tt class="py-lineno">1852</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-406" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-406', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'ulist'</tt><tt class="py-op">:</tt> </tt>
<a name="L1853"></a><tt class="py-lineno">1853</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'%s<ul>\n%s%s</ul>\n'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">indent</tt><tt class="py-op">*</tt><tt class="py-string">' '</tt><tt class="py-op">,</tt> <tt class="py-name">childstr</tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">*</tt><tt class="py-string">' '</tt><tt class="py-op">)</tt> </tt>
<a name="L1854"></a><tt class="py-lineno">1854</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-407" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-407', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'olist'</tt><tt class="py-op">:</tt> </tt>
<a name="L1855"></a><tt class="py-lineno">1855</tt> <tt class="py-line"> <tt class="py-name">start</tt> <tt class="py-op">=</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">attribs</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'start'</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-string">''</tt> </tt>
<a name="L1856"></a><tt class="py-lineno">1856</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-string">'%s<ol start="%s">\n%s%s</ol>\n'</tt> <tt class="py-op">%</tt> </tt>
<a name="L1857"></a><tt class="py-lineno">1857</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">indent</tt><tt class="py-op">*</tt><tt class="py-string">' '</tt><tt class="py-op">,</tt> <tt class="py-name">start</tt><tt class="py-op">,</tt> <tt class="py-name">childstr</tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">*</tt><tt class="py-string">' '</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1858"></a><tt class="py-lineno">1858</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-408" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-408', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'li'</tt><tt class="py-op">:</tt> </tt>
<a name="L1859"></a><tt class="py-lineno">1859</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">indent</tt><tt class="py-op">*</tt><tt class="py-string">' '</tt><tt class="py-op">+</tt><tt class="py-string">'<li>\n%s%s</li>\n'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">childstr</tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">*</tt><tt class="py-string">' '</tt><tt class="py-op">)</tt> </tt>
<a name="L1860"></a><tt class="py-lineno">1860</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-409" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-409', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'heading'</tt><tt class="py-op">:</tt> </tt>
<a name="L1861"></a><tt class="py-lineno">1861</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-string">'%s<h%s class="heading">%s</h%s>\n'</tt> <tt class="py-op">%</tt> </tt>
<a name="L1862"></a><tt class="py-lineno">1862</tt> <tt class="py-line"> <tt class="py-op">(</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-op">*</tt><tt class="py-string">' '</tt><tt class="py-op">,</tt> <tt class="py-name">seclevel</tt><tt class="py-op">,</tt> <tt class="py-name">childstr</tt><tt class="py-op">,</tt> <tt class="py-name">seclevel</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1863"></a><tt class="py-lineno">1863</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-410" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-410', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'literalblock'</tt><tt class="py-op">:</tt> </tt>
<a name="L1864"></a><tt class="py-lineno">1864</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'<pre class="literalblock">\n%s\n</pre>\n'</tt> <tt class="py-op">%</tt> <tt class="py-name">childstr</tt> </tt>
<a name="L1865"></a><tt class="py-lineno">1865</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-411" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-411', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'doctestblock'</tt><tt class="py-op">:</tt> </tt>
<a name="L1866"></a><tt class="py-lineno">1866</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-412" class="py-name"><a title="epydoc.markup.doctest.doctest_to_html" class="py-name" href="#" onclick="return doclink('link-412', 'doctest_to_html', 'link-11');">doctest_to_html</a></tt><tt class="py-op">(</tt><tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">children</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 class="py-op">)</tt> </tt>
<a name="L1867"></a><tt class="py-lineno">1867</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-413" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-413', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'fieldlist'</tt><tt class="py-op">:</tt> </tt>
<a name="L1868"></a><tt class="py-lineno">1868</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">AssertionError</tt><tt class="py-op">(</tt><tt class="py-string">"There should not be any field lists left"</tt><tt class="py-op">)</tt> </tt>
<a name="L1869"></a><tt class="py-lineno">1869</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-414" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-414', 'tag', 'link-13');">tag</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-string">'epytext'</tt><tt class="py-op">,</tt> <tt class="py-string">'section'</tt><tt class="py-op">,</tt> <tt class="py-string">'tag'</tt><tt class="py-op">,</tt> <tt class="py-string">'arg'</tt><tt class="py-op">,</tt> </tt>
<a name="L1870"></a><tt class="py-lineno">1870</tt> <tt class="py-line"> <tt class="py-string">'name'</tt><tt class="py-op">,</tt> <tt class="py-string">'target'</tt><tt class="py-op">,</tt> <tt class="py-string">'html'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1871"></a><tt class="py-lineno">1871</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">childstr</tt> </tt>
<a name="L1872"></a><tt class="py-lineno">1872</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-415" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-415', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'symbol'</tt><tt class="py-op">:</tt> </tt>
<a name="L1873"></a><tt class="py-lineno">1873</tt> <tt class="py-line"> <tt class="py-name">symbol</tt> <tt class="py-op">=</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L1874"></a><tt class="py-lineno">1874</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-416" class="py-name"><a title="epydoc.markup.epytext.ParsedEpytextDocstring.SYMBOL_TO_HTML" class="py-name" href="#" onclick="return doclink('link-416', 'SYMBOL_TO_HTML', 'link-376');">SYMBOL_TO_HTML</a></tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-name">symbol</tt><tt class="py-op">,</tt> <tt class="py-string">'[%s]'</tt> <tt class="py-op">%</tt> <tt class="py-name">symbol</tt><tt class="py-op">)</tt> </tt>
<a name="L1875"></a><tt class="py-lineno">1875</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-417" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-417', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'graph'</tt><tt class="py-op">:</tt> </tt>
<a name="L1876"></a><tt class="py-lineno">1876</tt> <tt class="py-line"> <tt class="py-comment"># Generate the graph.</tt> </tt>
<a name="L1877"></a><tt class="py-lineno">1877</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-418" class="py-name"><a title="epydoc.markup.restructuredtext.dotgraph.graph" class="py-name" href="#" onclick="return doclink('link-418', 'graph', 'link-214');">graph</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-419" class="py-name" targets="Method epydoc.markup.epytext.ParsedEpytextDocstring._build_graph()=epydoc.markup.epytext.ParsedEpytextDocstring-class.html#_build_graph"><a title="epydoc.markup.epytext.ParsedEpytextDocstring._build_graph" class="py-name" href="#" onclick="return doclink('link-419', '_build_graph', 'link-419');">_build_graph</a></tt><tt class="py-op">(</tt><tt id="link-420" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-420', 'variables', 'link-225');">variables</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt id="link-421" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-421', 'variables', 'link-225');">variables</a></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">linker</tt><tt class="py-op">,</tt> </tt>
<a name="L1878"></a><tt class="py-lineno">1878</tt> <tt class="py-line"> <tt class="py-name">docindex</tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">)</tt> </tt>
<a name="L1879"></a><tt class="py-lineno">1879</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt id="link-422" class="py-name"><a title="epydoc.markup.restructuredtext.dotgraph.graph" class="py-name" href="#" onclick="return doclink('link-422', 'graph', 'link-214');">graph</a></tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-string">''</tt> </tt>
<a name="L1880"></a><tt class="py-lineno">1880</tt> <tt class="py-line"> <tt class="py-comment"># Write the graph.</tt> </tt>
<a name="L1881"></a><tt class="py-lineno">1881</tt> <tt class="py-line"><tt class="py-comment"></tt> <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-423" class="py-name"><a title="epydoc.markup.restructuredtext.dotgraph.graph" class="py-name" href="#" onclick="return doclink('link-423', 'graph', 'link-214');">graph</a></tt><tt class="py-op">.</tt><tt class="py-name">uid</tt> </tt>
<a name="L1882"></a><tt class="py-lineno">1882</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-424" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-424', 'path', 'link-0');">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">image_url</tt><tt class="py-op">)</tt> </tt>
<a name="L1883"></a><tt class="py-lineno">1883</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-425" class="py-name"><a title="epydoc.markup.restructuredtext.dotgraph.graph" class="py-name" href="#" onclick="return doclink('link-425', 'graph', 'link-214');">graph</a></tt><tt class="py-op">.</tt><tt id="link-426" 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-426', 'to_html', 'link-426');">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>
<a name="L1884"></a><tt class="py-lineno">1884</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1885"></a><tt class="py-lineno">1885</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">'Unknown epytext DOM element %r'</tt> <tt class="py-op">%</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-427" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-427', 'tag', 'link-13');">tag</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L1886"></a><tt class="py-lineno">1886</tt> <tt class="py-line"> </tt>
<a name="L1887"></a><tt class="py-lineno">1887</tt> <tt class="py-line"> <tt class="py-comment">#GRAPH_TYPES = ['classtree', 'packagetree', 'importgraph']</tt> </tt>
<a name="ParsedEpytextDocstring._build_graph"></a><div id="ParsedEpytextDocstring._build_graph-def"><a name="L1888"></a><tt class="py-lineno">1888</tt> <a class="py-toggle" href="#" id="ParsedEpytextDocstring._build_graph-toggle" onclick="return toggle('ParsedEpytextDocstring._build_graph');">-</a><tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#_build_graph">_build_graph</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">graph_type</tt><tt class="py-op">,</tt> <tt class="py-param">graph_args</tt><tt class="py-op">,</tt> <tt class="py-param">linker</tt><tt class="py-op">,</tt> </tt>
<a name="L1889"></a><tt class="py-lineno">1889</tt> <tt class="py-line"> <tt class="py-param">docindex</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="ParsedEpytextDocstring._build_graph-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ParsedEpytextDocstring._build_graph-expanded"><a name="L1890"></a><tt class="py-lineno">1890</tt> <tt class="py-line"> <tt class="py-comment"># Generate the graph</tt> </tt>
<a name="L1891"></a><tt class="py-lineno">1891</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">graph_type</tt> <tt class="py-op">==</tt> <tt class="py-string">'classtree'</tt><tt class="py-op">:</tt> </tt>
<a name="L1892"></a><tt class="py-lineno">1892</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt id="link-428" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-428', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-429" class="py-name" targets="Module epydoc.apidoc=epydoc.apidoc-module.html"><a title="epydoc.apidoc" class="py-name" href="#" onclick="return doclink('link-429', 'apidoc', 'link-429');">apidoc</a></tt> <tt class="py-keyword">import</tt> <tt id="link-430" 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-430', 'ClassDoc', 'link-430');">ClassDoc</a></tt> </tt>
<a name="L1893"></a><tt class="py-lineno">1893</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">graph_args</tt><tt class="py-op">:</tt> </tt>
<a name="L1894"></a><tt class="py-lineno">1894</tt> <tt class="py-line"> <tt id="link-431" 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-431', 'bases', 'link-431');">bases</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt id="link-432" 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-432', 'find', 'link-432');">find</a></tt><tt class="py-op">(</tt><tt id="link-433" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-433', 'name', 'link-276');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">)</tt> </tt>
<a name="L1895"></a><tt class="py-lineno">1895</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-434" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-434', 'name', 'link-276');">name</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">graph_args</tt><tt class="py-op">]</tt> </tt>
<a name="L1896"></a><tt class="py-lineno">1896</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">context</tt><tt class="py-op">,</tt> <tt id="link-435" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-435', 'ClassDoc', 'link-430');">ClassDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1897"></a><tt class="py-lineno">1897</tt> <tt class="py-line"> <tt id="link-436" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-436', 'bases', 'link-431');">bases</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">context</tt><tt class="py-op">]</tt> </tt>
<a name="L1898"></a><tt class="py-lineno">1898</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1899"></a><tt class="py-lineno">1899</tt> <tt class="py-line"> <tt id="link-437" 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-437', 'log', 'link-437');">log</a></tt><tt class="py-op">.</tt><tt id="link-438" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-438', 'warning', 'link-358');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">"Could not construct class tree: you must "</tt> </tt>
<a name="L1900"></a><tt class="py-lineno">1900</tt> <tt class="py-line"> <tt class="py-string">"specify one or more base classes."</tt><tt class="py-op">)</tt> </tt>
<a name="L1901"></a><tt class="py-lineno">1901</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L1902"></a><tt class="py-lineno">1902</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt id="link-439" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-439', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-440" class="py-name" targets="Package epydoc.docwriter=epydoc.docwriter-module.html"><a title="epydoc.docwriter" class="py-name" href="#" onclick="return doclink('link-440', 'docwriter', 'link-440');">docwriter</a></tt><tt class="py-op">.</tt><tt id="link-441" 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-441', 'dotgraph', 'link-441');">dotgraph</a></tt> <tt class="py-keyword">import</tt> <tt id="link-442" 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-442', 'class_tree_graph', 'link-442');">class_tree_graph</a></tt> </tt>
<a name="L1903"></a><tt class="py-lineno">1903</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-443" class="py-name"><a title="epydoc.docwriter.dotgraph.class_tree_graph" class="py-name" href="#" onclick="return doclink('link-443', 'class_tree_graph', 'link-442');">class_tree_graph</a></tt><tt class="py-op">(</tt><tt id="link-444" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-444', 'bases', 'link-431');">bases</a></tt><tt class="py-op">,</tt> <tt class="py-name">linker</tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">)</tt> </tt>
<a name="L1904"></a><tt class="py-lineno">1904</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">graph_type</tt> <tt class="py-op">==</tt> <tt class="py-string">'packagetree'</tt><tt class="py-op">:</tt> </tt>
<a name="L1905"></a><tt class="py-lineno">1905</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt id="link-445" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-445', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-446" class="py-name"><a title="epydoc.apidoc" class="py-name" href="#" onclick="return doclink('link-446', 'apidoc', 'link-429');">apidoc</a></tt> <tt class="py-keyword">import</tt> <tt id="link-447" 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-447', 'ModuleDoc', 'link-447');">ModuleDoc</a></tt> </tt>
<a name="L1906"></a><tt class="py-lineno">1906</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">graph_args</tt><tt class="py-op">:</tt> </tt>
<a name="L1907"></a><tt class="py-lineno">1907</tt> <tt class="py-line"> <tt class="py-name">packages</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt id="link-448" class="py-name"><a title="epydoc.apidoc.DocIndex.find" class="py-name" href="#" onclick="return doclink('link-448', 'find', 'link-432');">find</a></tt><tt class="py-op">(</tt><tt id="link-449" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-449', 'name', 'link-276');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">)</tt> </tt>
<a name="L1908"></a><tt class="py-lineno">1908</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-450" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-450', 'name', 'link-276');">name</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">graph_args</tt><tt class="py-op">]</tt> </tt>
<a name="L1909"></a><tt class="py-lineno">1909</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">context</tt><tt class="py-op">,</tt> <tt id="link-451" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-451', 'ModuleDoc', 'link-447');">ModuleDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1910"></a><tt class="py-lineno">1910</tt> <tt class="py-line"> <tt class="py-name">packages</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">context</tt><tt class="py-op">]</tt> </tt>
<a name="L1911"></a><tt class="py-lineno">1911</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1912"></a><tt class="py-lineno">1912</tt> <tt class="py-line"> <tt id="link-452" 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-452', 'log', 'link-437');">log</a></tt><tt class="py-op">.</tt><tt id="link-453" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-453', 'warning', 'link-358');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">"Could not construct package tree: you must "</tt> </tt>
<a name="L1913"></a><tt class="py-lineno">1913</tt> <tt class="py-line"> <tt class="py-string">"specify one or more root packages."</tt><tt class="py-op">)</tt> </tt>
<a name="L1914"></a><tt class="py-lineno">1914</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L1915"></a><tt class="py-lineno">1915</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt id="link-454" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-454', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-455" class="py-name"><a title="epydoc.docwriter" class="py-name" href="#" onclick="return doclink('link-455', 'docwriter', 'link-440');">docwriter</a></tt><tt class="py-op">.</tt><tt id="link-456" class="py-name"><a title="epydoc.docwriter.dotgraph
epydoc.markup.restructuredtext.dotgraph" class="py-name" href="#" onclick="return doclink('link-456', 'dotgraph', 'link-441');">dotgraph</a></tt> <tt class="py-keyword">import</tt> <tt id="link-457" class="py-name" targets="Function epydoc.docwriter.dotgraph.package_tree_graph()=epydoc.docwriter.dotgraph-module.html#package_tree_graph"><a title="epydoc.docwriter.dotgraph.package_tree_graph" class="py-name" href="#" onclick="return doclink('link-457', 'package_tree_graph', 'link-457');">package_tree_graph</a></tt> </tt>
<a name="L1916"></a><tt class="py-lineno">1916</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-458" class="py-name"><a title="epydoc.docwriter.dotgraph.package_tree_graph" class="py-name" href="#" onclick="return doclink('link-458', 'package_tree_graph', 'link-457');">package_tree_graph</a></tt><tt class="py-op">(</tt><tt class="py-name">packages</tt><tt class="py-op">,</tt> <tt class="py-name">linker</tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">)</tt> </tt>
<a name="L1917"></a><tt class="py-lineno">1917</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">graph_type</tt> <tt class="py-op">==</tt> <tt class="py-string">'importgraph'</tt><tt class="py-op">:</tt> </tt>
<a name="L1918"></a><tt class="py-lineno">1918</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt id="link-459" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-459', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-460" class="py-name"><a title="epydoc.apidoc" class="py-name" href="#" onclick="return doclink('link-460', 'apidoc', 'link-429');">apidoc</a></tt> <tt class="py-keyword">import</tt> <tt id="link-461" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-461', 'ModuleDoc', 'link-447');">ModuleDoc</a></tt> </tt>
<a name="L1919"></a><tt class="py-lineno">1919</tt> <tt class="py-line"> <tt class="py-name">modules</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">docindex</tt><tt class="py-op">.</tt><tt class="py-name">root</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-462" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-462', 'ModuleDoc', 'link-447');">ModuleDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L1920"></a><tt class="py-lineno">1920</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt id="link-463" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-463', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-464" class="py-name"><a title="epydoc.docwriter" class="py-name" href="#" onclick="return doclink('link-464', 'docwriter', 'link-440');">docwriter</a></tt><tt class="py-op">.</tt><tt id="link-465" class="py-name"><a title="epydoc.docwriter.dotgraph
epydoc.markup.restructuredtext.dotgraph" class="py-name" href="#" onclick="return doclink('link-465', 'dotgraph', 'link-441');">dotgraph</a></tt> <tt class="py-keyword">import</tt> <tt id="link-466" class="py-name" targets="Function epydoc.docwriter.dotgraph.import_graph()=epydoc.docwriter.dotgraph-module.html#import_graph"><a title="epydoc.docwriter.dotgraph.import_graph" class="py-name" href="#" onclick="return doclink('link-466', 'import_graph', 'link-466');">import_graph</a></tt> </tt>
<a name="L1921"></a><tt class="py-lineno">1921</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-467" class="py-name"><a title="epydoc.docwriter.dotgraph.import_graph" class="py-name" href="#" onclick="return doclink('link-467', 'import_graph', 'link-466');">import_graph</a></tt><tt class="py-op">(</tt><tt class="py-name">modules</tt><tt class="py-op">,</tt> <tt class="py-name">docindex</tt><tt class="py-op">,</tt> <tt class="py-name">linker</tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">)</tt> </tt>
<a name="L1922"></a><tt class="py-lineno">1922</tt> <tt class="py-line"> </tt>
<a name="L1923"></a><tt class="py-lineno">1923</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">graph_type</tt> <tt class="py-op">==</tt> <tt class="py-string">'callgraph'</tt><tt class="py-op">:</tt> </tt>
<a name="L1924"></a><tt class="py-lineno">1924</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">graph_args</tt><tt class="py-op">:</tt> </tt>
<a name="L1925"></a><tt class="py-lineno">1925</tt> <tt class="py-line"> <tt class="py-name">docs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">docindex</tt><tt class="py-op">.</tt><tt id="link-468" class="py-name"><a title="epydoc.apidoc.DocIndex.find" class="py-name" href="#" onclick="return doclink('link-468', 'find', 'link-432');">find</a></tt><tt class="py-op">(</tt><tt id="link-469" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-469', 'name', 'link-276');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt id="link-470" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-470', 'name', 'link-276');">name</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">graph_args</tt><tt class="py-op">]</tt> </tt>
<a name="L1926"></a><tt class="py-lineno">1926</tt> <tt class="py-line"> <tt class="py-name">docs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">doc</tt> <tt class="py-keyword">for</tt> <tt class="py-name">doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">docs</tt> <tt class="py-keyword">if</tt> <tt class="py-name">doc</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="L1927"></a><tt class="py-lineno">1927</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1928"></a><tt class="py-lineno">1928</tt> <tt class="py-line"> <tt class="py-name">docs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">context</tt><tt class="py-op">]</tt> </tt>
<a name="L1929"></a><tt class="py-lineno">1929</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt id="link-471" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-471', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-472" class="py-name"><a title="epydoc.docwriter" class="py-name" href="#" onclick="return doclink('link-472', 'docwriter', 'link-440');">docwriter</a></tt><tt class="py-op">.</tt><tt id="link-473" class="py-name"><a title="epydoc.docwriter.dotgraph
epydoc.markup.restructuredtext.dotgraph" class="py-name" href="#" onclick="return doclink('link-473', 'dotgraph', 'link-441');">dotgraph</a></tt> <tt class="py-keyword">import</tt> <tt id="link-474" 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-474', 'call_graph', 'link-474');">call_graph</a></tt> </tt>
<a name="L1930"></a><tt class="py-lineno">1930</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-475" class="py-name"><a title="epydoc.docwriter.dotgraph.call_graph" class="py-name" href="#" onclick="return doclink('link-475', 'call_graph', 'link-474');">call_graph</a></tt><tt class="py-op">(</tt><tt class="py-name">docs</tt><tt class="py-op">,</tt> <tt class="py-name">docindex</tt><tt class="py-op">,</tt> <tt class="py-name">linker</tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">)</tt> </tt>
<a name="L1931"></a><tt class="py-lineno">1931</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1932"></a><tt class="py-lineno">1932</tt> <tt class="py-line"> <tt id="link-476" 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-476', 'log', 'link-437');">log</a></tt><tt class="py-op">.</tt><tt id="link-477" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-477', 'warning', 'link-358');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">"Unknown graph type %s"</tt> <tt class="py-op">%</tt> <tt class="py-name">graph_type</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1933"></a><tt class="py-lineno">1933</tt> <tt class="py-line"> </tt>
<a name="L1934"></a><tt class="py-lineno">1934</tt> <tt class="py-line"> </tt>
<a name="ParsedEpytextDocstring._to_latex"></a><div id="ParsedEpytextDocstring._to_latex-def"><a name="L1935"></a><tt class="py-lineno">1935</tt> <a class="py-toggle" href="#" id="ParsedEpytextDocstring._to_latex-toggle" onclick="return toggle('ParsedEpytextDocstring._to_latex');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#_to_latex">_to_latex</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">tree</tt><tt class="py-op">,</tt> <tt class="py-param">linker</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-param">seclevel</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-param">breakany</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="ParsedEpytextDocstring._to_latex-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ParsedEpytextDocstring._to_latex-expanded"><a name="L1936"></a><tt class="py-lineno">1936</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">tree</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="L1937"></a><tt class="py-lineno">1937</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-478" class="py-name"><a title="epydoc.util.plaintext_to_latex" class="py-name" href="#" onclick="return doclink('link-478', 'plaintext_to_latex', 'link-7');">plaintext_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">tree</tt><tt class="py-op">,</tt> <tt class="py-name">breakany</tt><tt class="py-op">=</tt><tt class="py-name">breakany</tt><tt class="py-op">)</tt> </tt>
<a name="L1938"></a><tt class="py-lineno">1938</tt> <tt class="py-line"> </tt>
<a name="L1939"></a><tt class="py-lineno">1939</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-479" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-479', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'section'</tt><tt class="py-op">:</tt> <tt class="py-name">seclevel</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L1940"></a><tt class="py-lineno">1940</tt> <tt class="py-line"> </tt>
<a name="L1941"></a><tt class="py-lineno">1941</tt> <tt class="py-line"> <tt class="py-comment"># Figure out the child indent level.</tt> </tt>
<a name="L1942"></a><tt class="py-lineno">1942</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-480" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-480', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'epytext'</tt><tt class="py-op">:</tt> <tt class="py-name">cindent</tt> <tt class="py-op">=</tt> <tt class="py-name">indent</tt> </tt>
<a name="L1943"></a><tt class="py-lineno">1943</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-name">cindent</tt> <tt class="py-op">=</tt> <tt class="py-name">indent</tt> <tt class="py-op">+</tt> <tt class="py-number">2</tt> </tt>
<a name="L1944"></a><tt class="py-lineno">1944</tt> <tt class="py-line"> <tt id="link-481" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-481', 'variables', 'link-225');">variables</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-482" class="py-name"><a title="epydoc.markup.epytext.ParsedEpytextDocstring._to_latex" class="py-name" href="#" onclick="return doclink('link-482', '_to_latex', 'link-379');">_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">c</tt><tt class="py-op">,</tt> <tt class="py-name">linker</tt><tt class="py-op">,</tt> <tt class="py-name">cindent</tt><tt class="py-op">,</tt> <tt class="py-name">seclevel</tt><tt class="py-op">,</tt> <tt class="py-name">breakany</tt><tt class="py-op">)</tt> </tt>
<a name="L1945"></a><tt class="py-lineno">1945</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">c</tt> <tt class="py-keyword">in</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">]</tt> </tt>
<a name="L1946"></a><tt class="py-lineno">1946</tt> <tt class="py-line"> <tt class="py-name">childstr</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 id="link-483" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-483', 'variables', 'link-225');">variables</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1947"></a><tt class="py-lineno">1947</tt> <tt class="py-line"> </tt>
<a name="L1948"></a><tt class="py-lineno">1948</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-484" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-484', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'para'</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 id="link-485" class="py-name"><a title="epydoc.util.wordwrap" class="py-name" href="#" onclick="return doclink('link-485', 'wordwrap', 'link-5');">wordwrap</a></tt><tt class="py-op">(</tt><tt class="py-name">childstr</tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">)</tt><tt class="py-op">+</tt><tt class="py-string">'\n'</tt> </tt>
<a name="L1950"></a><tt class="py-lineno">1950</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-486" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-486', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'code'</tt><tt class="py-op">:</tt> </tt>
<a name="L1951"></a><tt class="py-lineno">1951</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'\\texttt{%s}'</tt> <tt class="py-op">%</tt> <tt class="py-name">childstr</tt> </tt>
<a name="L1952"></a><tt class="py-lineno">1952</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-487" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-487', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'uri'</tt><tt class="py-op">:</tt> </tt>
<a name="L1953"></a><tt class="py-lineno">1953</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-488" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-488', 'variables', 'link-225');">variables</a></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-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">'Bad URI '</tt><tt class="py-op">)</tt> </tt>
<a name="L1954"></a><tt class="py-lineno">1954</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">_hyperref</tt><tt class="py-op">:</tt> </tt>
<a name="L1955"></a><tt class="py-lineno">1955</tt> <tt class="py-line"> <tt class="py-comment"># ~ and # should not be escaped in the URI.</tt> </tt>
<a name="L1956"></a><tt class="py-lineno">1956</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">uri</tt> <tt class="py-op">=</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">children</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">children</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L1957"></a><tt class="py-lineno">1957</tt> <tt class="py-line"> <tt class="py-name">uri</tt> <tt class="py-op">=</tt> <tt class="py-name">uri</tt><tt class="py-op">.</tt><tt class="py-name">replace</tt><tt class="py-op">(</tt><tt class="py-string">'{\\textasciitilde}'</tt><tt class="py-op">,</tt> <tt class="py-string">'~'</tt><tt class="py-op">)</tt> </tt>
<a name="L1958"></a><tt class="py-lineno">1958</tt> <tt class="py-line"> <tt class="py-name">uri</tt> <tt class="py-op">=</tt> <tt class="py-name">uri</tt><tt class="py-op">.</tt><tt class="py-name">replace</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>
<a name="L1959"></a><tt class="py-lineno">1959</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-489" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-489', 'variables', 'link-225');">variables</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt id="link-490" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-490', 'variables', 'link-225');">variables</a></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="L1960"></a><tt class="py-lineno">1960</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'\\href{%s}{\\textit{%s}}'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">uri</tt><tt class="py-op">,</tt> <tt id="link-491" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-491', 'variables', 'link-225');">variables</a></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="L1961"></a><tt class="py-lineno">1961</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1962"></a><tt class="py-lineno">1962</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-string">'%s\\footnote{\\href{%s}{%s}}'</tt> <tt class="py-op">%</tt> </tt>
<a name="L1963"></a><tt class="py-lineno">1963</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt id="link-492" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-492', 'variables', 'link-225');">variables</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">uri</tt><tt class="py-op">,</tt> <tt id="link-493" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-493', 'variables', 'link-225');">variables</a></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="L1964"></a><tt class="py-lineno">1964</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1965"></a><tt class="py-lineno">1965</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-494" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-494', 'variables', 'link-225');">variables</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt id="link-495" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-495', 'variables', 'link-225');">variables</a></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="L1966"></a><tt class="py-lineno">1966</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'\\textit{%s}'</tt> <tt class="py-op">%</tt> <tt id="link-496" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-496', 'variables', 'link-225');">variables</a></tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt>
<a name="L1967"></a><tt class="py-lineno">1967</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1968"></a><tt class="py-lineno">1968</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'%s\\footnote{%s}'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt id="link-497" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-497', 'variables', 'link-225');">variables</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt id="link-498" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-498', 'variables', 'link-225');">variables</a></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="L1969"></a><tt class="py-lineno">1969</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-499" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-499', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'link'</tt><tt class="py-op">:</tt> </tt>
<a name="L1970"></a><tt class="py-lineno">1970</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-500" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-500', 'variables', 'link-225');">variables</a></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-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">'Bad Link'</tt><tt class="py-op">)</tt> </tt>
<a name="L1971"></a><tt class="py-lineno">1971</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">linker</tt><tt class="py-op">.</tt><tt id="link-501" class="py-name"><a title="epydoc.docwriter.html._HTMLDocstringLinker.translate_identifier_xref
epydoc.docwriter.latex.LatexWriter._LatexDocstringLinker.translate_identifier_xref
epydoc.markup.DocstringLinker.translate_identifier_xref" class="py-name" href="#" onclick="return doclink('link-501', 'translate_identifier_xref', 'link-396');">translate_identifier_xref</a></tt><tt class="py-op">(</tt><tt id="link-502" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-502', 'variables', 'link-225');">variables</a></tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt id="link-503" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-503', 'variables', 'link-225');">variables</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="L1972"></a><tt class="py-lineno">1972</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-504" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-504', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'italic'</tt><tt class="py-op">:</tt> </tt>
<a name="L1973"></a><tt class="py-lineno">1973</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'\\textit{%s}'</tt> <tt class="py-op">%</tt> <tt class="py-name">childstr</tt> </tt>
<a name="L1974"></a><tt class="py-lineno">1974</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-505" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-505', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'math'</tt><tt class="py-op">:</tt> </tt>
<a name="L1975"></a><tt class="py-lineno">1975</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'\\textit{%s}'</tt> <tt class="py-op">%</tt> <tt class="py-name">childstr</tt> </tt>
<a name="L1976"></a><tt class="py-lineno">1976</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-506" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-506', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'indexed'</tt><tt class="py-op">:</tt> </tt>
<a name="L1977"></a><tt class="py-lineno">1977</tt> <tt class="py-line"> <tt class="py-name">term</tt> <tt class="py-op">=</tt> <tt id="link-507" class="py-name"><a title="epydoc.markup.epytext.Element" class="py-name" href="#" onclick="return doclink('link-507', 'Element', 'link-30');">Element</a></tt><tt class="py-op">(</tt><tt class="py-string">'epytext'</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">attribs</tt><tt class="py-op">)</tt> </tt>
<a name="L1978"></a><tt class="py-lineno">1978</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">linker</tt><tt class="py-op">.</tt><tt id="link-508" class="py-name"><a title="epydoc.docwriter.html._HTMLDocstringLinker.translate_indexterm
epydoc.docwriter.latex.LatexWriter._LatexDocstringLinker.translate_indexterm
epydoc.markup.DocstringLinker.translate_indexterm" class="py-name" href="#" onclick="return doclink('link-508', 'translate_indexterm', 'link-403');">translate_indexterm</a></tt><tt class="py-op">(</tt><tt id="link-509" class="py-name"><a title="epydoc.markup.epytext.ParsedEpytextDocstring" class="py-name" href="#" onclick="return doclink('link-509', 'ParsedEpytextDocstring', 'link-373');">ParsedEpytextDocstring</a></tt><tt class="py-op">(</tt><tt class="py-name">term</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1979"></a><tt class="py-lineno">1979</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-510" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-510', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'bold'</tt><tt class="py-op">:</tt> </tt>
<a name="L1980"></a><tt class="py-lineno">1980</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'\\textbf{%s}'</tt> <tt class="py-op">%</tt> <tt class="py-name">childstr</tt> </tt>
<a name="L1981"></a><tt class="py-lineno">1981</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-511" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-511', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'li'</tt><tt class="py-op">:</tt> </tt>
<a name="L1982"></a><tt class="py-lineno">1982</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">indent</tt><tt class="py-op">*</tt><tt class="py-string">' '</tt> <tt class="py-op">+</tt> <tt class="py-string">'\\item '</tt> <tt class="py-op">+</tt> <tt class="py-name">childstr</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="L1983"></a><tt class="py-lineno">1983</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-512" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-512', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'heading'</tt><tt class="py-op">:</tt> </tt>
<a name="L1984"></a><tt class="py-lineno">1984</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">' '</tt><tt class="py-op">*</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-op">+</tt> <tt class="py-string">'(section) %s\n\n'</tt> <tt class="py-op">%</tt> <tt class="py-name">childstr</tt> </tt>
<a name="L1985"></a><tt class="py-lineno">1985</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-513" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-513', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'doctestblock'</tt><tt class="py-op">:</tt> </tt>
<a name="L1986"></a><tt class="py-lineno">1986</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-514" class="py-name"><a title="epydoc.markup.doctest.doctest_to_latex" class="py-name" href="#" onclick="return doclink('link-514', 'doctest_to_latex', 'link-12');">doctest_to_latex</a></tt><tt class="py-op">(</tt><tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">children</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 class="py-op">)</tt> </tt>
<a name="L1987"></a><tt class="py-lineno">1987</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-515" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-515', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'literalblock'</tt><tt class="py-op">:</tt> </tt>
<a name="L1988"></a><tt class="py-lineno">1988</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'\\begin{alltt}\n%s\\end{alltt}\n\n'</tt> <tt class="py-op">%</tt> <tt class="py-name">childstr</tt> </tt>
<a name="L1989"></a><tt class="py-lineno">1989</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-516" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-516', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'fieldlist'</tt><tt class="py-op">:</tt> </tt>
<a name="L1990"></a><tt class="py-lineno">1990</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">indent</tt><tt class="py-op">*</tt><tt class="py-string">' '</tt><tt class="py-op">+</tt><tt class="py-string">'{omitted fieldlist}\n'</tt> </tt>
<a name="L1991"></a><tt class="py-lineno">1991</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-517" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-517', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'olist'</tt><tt class="py-op">:</tt> </tt>
<a name="L1992"></a><tt class="py-lineno">1992</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-name">indent</tt> <tt class="py-op">+</tt> <tt class="py-string">'\\begin{enumerate}\n\n'</tt> <tt class="py-op">+</tt> </tt>
<a name="L1993"></a><tt class="py-lineno">1993</tt> <tt class="py-line"> <tt class="py-string">' '</tt><tt class="py-op">*</tt><tt class="py-name">indent</tt> <tt class="py-op">+</tt> <tt class="py-string">'\\setlength{\\parskip}{0.5ex}\n'</tt> <tt class="py-op">+</tt> </tt>
<a name="L1994"></a><tt class="py-lineno">1994</tt> <tt class="py-line"> <tt class="py-name">childstr</tt> <tt class="py-op">+</tt> </tt>
<a name="L1995"></a><tt class="py-lineno">1995</tt> <tt class="py-line"> <tt class="py-string">' '</tt><tt class="py-op">*</tt><tt class="py-name">indent</tt> <tt class="py-op">+</tt> <tt class="py-string">'\\end{enumerate}\n\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L1996"></a><tt class="py-lineno">1996</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-518" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-518', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'ulist'</tt><tt class="py-op">:</tt> </tt>
<a name="L1997"></a><tt class="py-lineno">1997</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-name">indent</tt> <tt class="py-op">+</tt> <tt class="py-string">'\\begin{itemize}\n'</tt> <tt class="py-op">+</tt> </tt>
<a name="L1998"></a><tt class="py-lineno">1998</tt> <tt class="py-line"> <tt class="py-string">' '</tt><tt class="py-op">*</tt><tt class="py-name">indent</tt> <tt class="py-op">+</tt> <tt class="py-string">'\\setlength{\\parskip}{0.6ex}\n'</tt> <tt class="py-op">+</tt> </tt>
<a name="L1999"></a><tt class="py-lineno">1999</tt> <tt class="py-line"> <tt class="py-name">childstr</tt> <tt class="py-op">+</tt> </tt>
<a name="L2000"></a><tt class="py-lineno">2000</tt> <tt class="py-line"> <tt class="py-string">' '</tt><tt class="py-op">*</tt><tt class="py-name">indent</tt> <tt class="py-op">+</tt> <tt class="py-string">'\\end{itemize}\n\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L2001"></a><tt class="py-lineno">2001</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-519" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-519', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'symbol'</tt><tt class="py-op">:</tt> </tt>
<a name="L2002"></a><tt class="py-lineno">2002</tt> <tt class="py-line"> <tt class="py-name">symbol</tt> <tt class="py-op">=</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L2003"></a><tt class="py-lineno">2003</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-520" class="py-name"><a title="epydoc.markup.epytext.ParsedEpytextDocstring.SYMBOL_TO_LATEX" class="py-name" href="#" onclick="return doclink('link-520', 'SYMBOL_TO_LATEX', 'link-377');">SYMBOL_TO_LATEX</a></tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-name">symbol</tt><tt class="py-op">,</tt> <tt class="py-string">'[%s]'</tt> <tt class="py-op">%</tt> <tt class="py-name">symbol</tt><tt class="py-op">)</tt> </tt>
<a name="L2004"></a><tt class="py-lineno">2004</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-521" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-521', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'graph'</tt><tt class="py-op">:</tt> </tt>
<a name="L2005"></a><tt class="py-lineno">2005</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'(GRAPH)'</tt> </tt>
<a name="L2006"></a><tt class="py-lineno">2006</tt> <tt class="py-line"> <tt class="py-comment">#raise ValueError, 'graph not implemented yet for latex'</tt> </tt>
<a name="L2007"></a><tt class="py-lineno">2007</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2008"></a><tt class="py-lineno">2008</tt> <tt class="py-line"> <tt class="py-comment"># Assume that anything else can be passed through.</tt> </tt>
<a name="L2009"></a><tt class="py-lineno">2009</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt class="py-name">childstr</tt> </tt>
</div><a name="L2010"></a><tt class="py-lineno">2010</tt> <tt class="py-line"> </tt>
<a name="L2011"></a><tt class="py-lineno">2011</tt> <tt class="py-line"> <tt id="link-522" class="py-name" targets="Variable epydoc.markup.epytext.ParsedEpytextDocstring._SUMMARY_RE=epydoc.markup.epytext.ParsedEpytextDocstring-class.html#_SUMMARY_RE,Variable epydoc.markup.javadoc.ParsedJavadocDocstring._SUMMARY_RE=epydoc.markup.javadoc.ParsedJavadocDocstring-class.html#_SUMMARY_RE,Variable epydoc.markup.plaintext.ParsedPlaintextDocstring._SUMMARY_RE=epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#_SUMMARY_RE,Variable epydoc.markup.restructuredtext._SummaryExtractor._SUMMARY_RE=epydoc.markup.restructuredtext._SummaryExtractor-class.html#_SUMMARY_RE"><a title="epydoc.markup.epytext.ParsedEpytextDocstring._SUMMARY_RE
epydoc.markup.javadoc.ParsedJavadocDocstring._SUMMARY_RE
epydoc.markup.plaintext.ParsedPlaintextDocstring._SUMMARY_RE
epydoc.markup.restructuredtext._SummaryExtractor._SUMMARY_RE" class="py-name" href="#" onclick="return doclink('link-522', '_SUMMARY_RE', 'link-522');">_SUMMARY_RE</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'(\s*[\w\W]*?\.)(\s|$)'</tt><tt class="py-op">)</tt> </tt>
<a name="L2012"></a><tt class="py-lineno">2012</tt> <tt class="py-line"> </tt>
<a name="ParsedEpytextDocstring.summary"></a><div id="ParsedEpytextDocstring.summary-def"><a name="L2013"></a><tt class="py-lineno">2013</tt> <a class="py-toggle" href="#" id="ParsedEpytextDocstring.summary-toggle" onclick="return toggle('ParsedEpytextDocstring.summary');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#summary">summary</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="ParsedEpytextDocstring.summary-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ParsedEpytextDocstring.summary-expanded"><a name="L2014"></a><tt class="py-lineno">2014</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">_tree</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">self</tt><tt class="py-op">,</tt> <tt class="py-name">False</tt> </tt>
<a name="L2015"></a><tt class="py-lineno">2015</tt> <tt class="py-line"> <tt class="py-name">tree</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_tree</tt> </tt>
<a name="L2016"></a><tt class="py-lineno">2016</tt> <tt class="py-line"> <tt class="py-name">doc</tt> <tt class="py-op">=</tt> <tt id="link-523" class="py-name"><a title="epydoc.markup.epytext.Element" class="py-name" href="#" onclick="return doclink('link-523', 'Element', 'link-30');">Element</a></tt><tt class="py-op">(</tt><tt class="py-string">'epytext'</tt><tt class="py-op">)</tt> </tt>
<a name="L2017"></a><tt class="py-lineno">2017</tt> <tt class="py-line"> </tt>
<a name="L2018"></a><tt class="py-lineno">2018</tt> <tt class="py-line"> <tt class="py-comment"># Find the first paragraph.</tt> </tt>
<a name="L2019"></a><tt class="py-lineno">2019</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-524" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-524', 'variables', 'link-225');">variables</a></tt> <tt class="py-op">=</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">children</tt> </tt>
<a name="L2020"></a><tt class="py-lineno">2020</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-525" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-525', 'variables', 'link-225');">variables</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">and</tt> <tt class="py-op">(</tt><tt id="link-526" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-526', 'variables', 'link-225');">variables</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-527" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-527', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">!=</tt> <tt class="py-string">'para'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2021"></a><tt class="py-lineno">2021</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-528" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-528', 'variables', 'link-225');">variables</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-529" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-529', 'tag', 'link-13');">tag</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-string">'section'</tt><tt class="py-op">,</tt> <tt class="py-string">'ulist'</tt><tt class="py-op">,</tt> <tt class="py-string">'olist'</tt><tt class="py-op">,</tt> <tt class="py-string">'li'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2022"></a><tt class="py-lineno">2022</tt> <tt class="py-line"> <tt id="link-530" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-530', 'variables', 'link-225');">variables</a></tt> <tt class="py-op">=</tt> <tt id="link-531" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-531', 'variables', 'link-225');">variables</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">children</tt> </tt>
<a name="L2023"></a><tt class="py-lineno">2023</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2024"></a><tt class="py-lineno">2024</tt> <tt class="py-line"> <tt id="link-532" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-532', 'variables', 'link-225');">variables</a></tt> <tt class="py-op">=</tt> <tt id="link-533" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-533', 'variables', 'link-225');">variables</a></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="L2025"></a><tt class="py-lineno">2025</tt> <tt class="py-line"> </tt>
<a name="L2026"></a><tt class="py-lineno">2026</tt> <tt class="py-line"> <tt class="py-comment"># Special case: if the docstring contains a single literal block,</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"># then try extracting the summary from it.</tt> </tt>
<a name="L2028"></a><tt class="py-lineno">2028</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">len</tt><tt class="py-op">(</tt><tt id="link-534" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-534', 'variables', 'link-225');">variables</a></tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt> <tt class="py-keyword">and</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">children</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="L2029"></a><tt class="py-lineno">2029</tt> <tt class="py-line"> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-535" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-535', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'literalblock'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2030"></a><tt class="py-lineno">2030</tt> <tt class="py-line"> <tt class="py-name">str</tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">r'\n\s*(\n|$).*'</tt><tt class="py-op">,</tt> </tt>
<a name="L2031"></a><tt class="py-lineno">2031</tt> <tt class="py-line"> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">children</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">children</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 class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L2032"></a><tt class="py-lineno">2032</tt> <tt class="py-line"> <tt id="link-536" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-536', 'variables', 'link-225');">variables</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt id="link-537" class="py-name"><a title="epydoc.markup.epytext.Element" class="py-name" href="#" onclick="return doclink('link-537', 'Element', 'link-30');">Element</a></tt><tt class="py-op">(</tt><tt class="py-string">'para'</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 id="link-538" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-538', 'variables', 'link-225');">variables</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">children</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
<a name="L2034"></a><tt class="py-lineno">2034</tt> <tt class="py-line"> </tt>
<a name="L2035"></a><tt class="py-lineno">2035</tt> <tt class="py-line"> <tt class="py-comment"># If we didn't find a paragraph, return an empty epytext.</tt> </tt>
<a name="L2036"></a><tt class="py-lineno">2036</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-539" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-539', 'variables', 'link-225');">variables</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 id="link-540" class="py-name"><a title="epydoc.markup.epytext.ParsedEpytextDocstring" class="py-name" href="#" onclick="return doclink('link-540', 'ParsedEpytextDocstring', 'link-373');">ParsedEpytextDocstring</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">False</tt> </tt>
<a name="L2037"></a><tt class="py-lineno">2037</tt> <tt class="py-line"> </tt>
<a name="L2038"></a><tt class="py-lineno">2038</tt> <tt class="py-line"> <tt class="py-comment"># Is there anything else, excluding tags, after the first variable?</tt> </tt>
<a name="L2039"></a><tt class="py-lineno">2039</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">long_docs</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L2040"></a><tt class="py-lineno">2040</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">var</tt> <tt class="py-keyword">in</tt> <tt id="link-541" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-541', 'variables', 'link-225');">variables</a></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="L2041"></a><tt class="py-lineno">2041</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</tt><tt class="py-op">,</tt> <tt id="link-542" class="py-name"><a title="epydoc.markup.epytext.Element" class="py-name" href="#" onclick="return doclink('link-542', 'Element', 'link-30');">Element</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">var</tt><tt class="py-op">.</tt><tt id="link-543" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-543', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'fieldlist'</tt><tt class="py-op">:</tt> </tt>
<a name="L2042"></a><tt class="py-lineno">2042</tt> <tt class="py-line"> <tt class="py-keyword">continue</tt> </tt>
<a name="L2043"></a><tt class="py-lineno">2043</tt> <tt class="py-line"> <tt class="py-name">long_docs</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L2044"></a><tt class="py-lineno">2044</tt> <tt class="py-line"> <tt class="py-keyword">break</tt> </tt>
<a name="L2045"></a><tt class="py-lineno">2045</tt> <tt class="py-line"> </tt>
<a name="L2046"></a><tt class="py-lineno">2046</tt> <tt class="py-line"> <tt class="py-comment"># Extract the first sentence.</tt> </tt>
<a name="L2047"></a><tt class="py-lineno">2047</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">parachildren</tt> <tt class="py-op">=</tt> <tt id="link-544" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-544', 'variables', 'link-225');">variables</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">children</tt> </tt>
<a name="L2048"></a><tt class="py-lineno">2048</tt> <tt class="py-line"> <tt class="py-name">para</tt> <tt class="py-op">=</tt> <tt id="link-545" class="py-name"><a title="epydoc.markup.epytext.Element" class="py-name" href="#" onclick="return doclink('link-545', 'Element', 'link-30');">Element</a></tt><tt class="py-op">(</tt><tt class="py-string">'para'</tt><tt class="py-op">,</tt> <tt class="py-name">inline</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L2049"></a><tt class="py-lineno">2049</tt> <tt class="py-line"> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">para</tt><tt class="py-op">)</tt> </tt>
<a name="L2050"></a><tt class="py-lineno">2050</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">parachild</tt> <tt class="py-keyword">in</tt> <tt class="py-name">parachildren</tt><tt class="py-op">:</tt> </tt>
<a name="L2051"></a><tt class="py-lineno">2051</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">parachild</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="L2052"></a><tt class="py-lineno">2052</tt> <tt class="py-line"> <tt class="py-name">m</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-546" class="py-name"><a title="epydoc.markup.epytext.ParsedEpytextDocstring._SUMMARY_RE
epydoc.markup.javadoc.ParsedJavadocDocstring._SUMMARY_RE
epydoc.markup.plaintext.ParsedPlaintextDocstring._SUMMARY_RE
epydoc.markup.restructuredtext._SummaryExtractor._SUMMARY_RE" class="py-name" href="#" onclick="return doclink('link-546', '_SUMMARY_RE', 'link-522');">_SUMMARY_RE</a></tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-name">parachild</tt><tt class="py-op">)</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">m</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">para</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">.</tt><tt class="py-name">append</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-number">1</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L2055"></a><tt class="py-lineno">2055</tt> <tt class="py-line"> <tt class="py-name">long_docs</tt> <tt class="py-op">|=</tt> <tt class="py-name">parachild</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">parachildren</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="L2056"></a><tt class="py-lineno">2056</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">long_docs</tt><tt class="py-op">:</tt> </tt>
<a name="L2057"></a><tt class="py-lineno">2057</tt> <tt class="py-line"> <tt class="py-name">other</tt> <tt class="py-op">=</tt> <tt class="py-name">parachild</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="L2058"></a><tt class="py-lineno">2058</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">other</tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt class="py-name">other</tt><tt class="py-op">.</tt><tt class="py-name">isspace</tt><tt class="py-op">(</tt><tt class="py-op">)</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">long_docs</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L2060"></a><tt class="py-lineno">2060</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-547" class="py-name"><a title="epydoc.markup.epytext.ParsedEpytextDocstring" class="py-name" href="#" onclick="return doclink('link-547', 'ParsedEpytextDocstring', 'link-373');">ParsedEpytextDocstring</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">long_docs</tt> </tt>
<a name="L2061"></a><tt class="py-lineno">2061</tt> <tt class="py-line"> <tt class="py-name">para</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">parachild</tt><tt class="py-op">)</tt> </tt>
<a name="L2062"></a><tt class="py-lineno">2062</tt> <tt class="py-line"> </tt>
<a name="L2063"></a><tt class="py-lineno">2063</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-548" class="py-name"><a title="epydoc.markup.epytext.ParsedEpytextDocstring" class="py-name" href="#" onclick="return doclink('link-548', 'ParsedEpytextDocstring', 'link-373');">ParsedEpytextDocstring</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">long_docs</tt> </tt>
</div><a name="L2064"></a><tt class="py-lineno">2064</tt> <tt class="py-line"> </tt>
<a name="ParsedEpytextDocstring.split_fields"></a><div id="ParsedEpytextDocstring.split_fields-def"><a name="L2065"></a><tt class="py-lineno">2065</tt> <a class="py-toggle" href="#" id="ParsedEpytextDocstring.split_fields-toggle" onclick="return toggle('ParsedEpytextDocstring.split_fields');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#split_fields">split_fields</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">errors</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="ParsedEpytextDocstring.split_fields-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ParsedEpytextDocstring.split_fields-expanded"><a name="L2066"></a><tt class="py-lineno">2066</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">_tree</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-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</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-name">tree</tt> <tt class="py-op">=</tt> <tt id="link-549" class="py-name"><a title="epydoc.markup.epytext.Element" class="py-name" href="#" onclick="return doclink('link-549', 'Element', 'link-30');">Element</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_tree</tt><tt class="py-op">.</tt><tt id="link-550" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-550', 'tag', 'link-13');">tag</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">_tree</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">,</tt> </tt>
<a name="L2068"></a><tt class="py-lineno">2068</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">_tree</tt><tt class="py-op">.</tt><tt class="py-name">attribs</tt><tt class="py-op">)</tt> </tt>
<a name="L2069"></a><tt class="py-lineno">2069</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="L2070"></a><tt class="py-lineno">2070</tt> <tt class="py-line"> </tt>
<a name="L2071"></a><tt class="py-lineno">2071</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">children</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L2072"></a><tt class="py-lineno">2072</tt> <tt class="py-line"> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">children</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 id="link-551" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-551', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'fieldlist'</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L2073"></a><tt class="py-lineno">2073</tt> <tt class="py-line"> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">children</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">children</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2074"></a><tt class="py-lineno">2074</tt> <tt class="py-line"> <tt class="py-name">field_nodes</tt> <tt class="py-op">=</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">children</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">children</tt> </tt>
<a name="L2075"></a><tt class="py-lineno">2075</tt> <tt class="py-line"> <tt class="py-keyword">del</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">children</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="L2076"></a><tt class="py-lineno">2076</tt> <tt class="py-line"> </tt>
<a name="L2077"></a><tt class="py-lineno">2077</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">field_nodes</tt><tt class="py-op">:</tt> </tt>
<a name="L2078"></a><tt class="py-lineno">2078</tt> <tt class="py-line"> <tt class="py-comment"># Get the tag</tt> </tt>
<a name="L2079"></a><tt class="py-lineno">2079</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-552" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-552', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">=</tt> <tt class="py-name">field</tt><tt class="py-op">.</tt><tt class="py-name">children</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">children</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>
<a name="L2080"></a><tt class="py-lineno">2080</tt> <tt class="py-line"> <tt class="py-keyword">del</tt> <tt class="py-name">field</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L2081"></a><tt class="py-lineno">2081</tt> <tt class="py-line"> </tt>
<a name="L2082"></a><tt class="py-lineno">2082</tt> <tt class="py-line"> <tt class="py-comment"># Get the argument.</tt> </tt>
<a name="L2083"></a><tt class="py-lineno">2083</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">field</tt><tt class="py-op">.</tt><tt class="py-name">children</tt> <tt class="py-keyword">and</tt> <tt class="py-name">field</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-553" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-553', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'arg'</tt><tt class="py-op">:</tt> </tt>
<a name="L2084"></a><tt class="py-lineno">2084</tt> <tt class="py-line"> <tt id="link-554" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-554', 'arg', 'link-222');">arg</a></tt> <tt class="py-op">=</tt> <tt class="py-name">field</tt><tt class="py-op">.</tt><tt class="py-name">children</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">children</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L2085"></a><tt class="py-lineno">2085</tt> <tt class="py-line"> <tt class="py-keyword">del</tt> <tt class="py-name">field</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L2086"></a><tt class="py-lineno">2086</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2087"></a><tt class="py-lineno">2087</tt> <tt class="py-line"> <tt id="link-555" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-555', 'arg', 'link-222');">arg</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L2088"></a><tt class="py-lineno">2088</tt> <tt class="py-line"> </tt>
<a name="L2089"></a><tt class="py-lineno">2089</tt> <tt class="py-line"> <tt class="py-comment"># Process the field.</tt> </tt>
<a name="L2090"></a><tt class="py-lineno">2090</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">field</tt><tt class="py-op">.</tt><tt id="link-556" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-556', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'epytext'</tt> </tt>
<a name="L2091"></a><tt class="py-lineno">2091</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 id="link-557" class="py-name" targets="Class epydoc.markup.Field=epydoc.markup.Field-class.html"><a title="epydoc.markup.Field" class="py-name" href="#" onclick="return doclink('link-557', 'Field', 'link-557');">Field</a></tt><tt class="py-op">(</tt><tt id="link-558" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-558', 'tag', 'link-13');">tag</a></tt><tt class="py-op">,</tt> <tt id="link-559" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-559', 'arg', 'link-222');">arg</a></tt><tt class="py-op">,</tt> <tt id="link-560" class="py-name"><a title="epydoc.markup.epytext.ParsedEpytextDocstring" class="py-name" href="#" onclick="return doclink('link-560', 'ParsedEpytextDocstring', 'link-373');">ParsedEpytextDocstring</a></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>
<a name="L2092"></a><tt class="py-lineno">2092</tt> <tt class="py-line"> </tt>
<a name="L2093"></a><tt class="py-lineno">2093</tt> <tt class="py-line"> <tt class="py-comment"># Save the remaining docstring as the description..</tt> </tt>
<a name="L2094"></a><tt class="py-lineno">2094</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">children</tt> <tt class="py-keyword">and</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">children</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">children</tt><tt class="py-op">:</tt> </tt>
<a name="L2095"></a><tt class="py-lineno">2095</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-561" class="py-name"><a title="epydoc.markup.epytext.ParsedEpytextDocstring" class="py-name" href="#" onclick="return doclink('link-561', 'ParsedEpytextDocstring', 'link-373');">ParsedEpytextDocstring</a></tt><tt class="py-op">(</tt><tt class="py-name">tree</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">fields</tt> </tt>
<a name="L2096"></a><tt class="py-lineno">2096</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2097"></a><tt class="py-lineno">2097</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-name">fields</tt> </tt>
</div><a name="L2098"></a><tt class="py-lineno">2098</tt> <tt class="py-line"> </tt>
<a name="L2099"></a><tt class="py-lineno">2099</tt> <tt class="py-line"> </tt>
<a name="ParsedEpytextDocstring.index_terms"></a><div id="ParsedEpytextDocstring.index_terms-def"><a name="L2100"></a><tt class="py-lineno">2100</tt> <a class="py-toggle" href="#" id="ParsedEpytextDocstring.index_terms-toggle" onclick="return toggle('ParsedEpytextDocstring.index_terms');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#index_terms">index_terms</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="ParsedEpytextDocstring.index_terms-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ParsedEpytextDocstring.index_terms-expanded"><a name="L2101"></a><tt class="py-lineno">2101</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">_terms</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L2102"></a><tt class="py-lineno">2102</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_terms</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L2103"></a><tt class="py-lineno">2103</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-562" class="py-name" targets="Method epydoc.markup.epytext.ParsedEpytextDocstring._index_terms()=epydoc.markup.epytext.ParsedEpytextDocstring-class.html#_index_terms"><a title="epydoc.markup.epytext.ParsedEpytextDocstring._index_terms" class="py-name" href="#" onclick="return doclink('link-562', '_index_terms', 'link-562');">_index_terms</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_tree</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_terms</tt><tt class="py-op">)</tt> </tt>
<a name="L2104"></a><tt class="py-lineno">2104</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">_terms</tt> </tt>
</div><a name="L2105"></a><tt class="py-lineno">2105</tt> <tt class="py-line"> </tt>
<a name="ParsedEpytextDocstring._index_terms"></a><div id="ParsedEpytextDocstring._index_terms-def"><a name="L2106"></a><tt class="py-lineno">2106</tt> <a class="py-toggle" href="#" id="ParsedEpytextDocstring._index_terms-toggle" onclick="return toggle('ParsedEpytextDocstring._index_terms');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#_index_terms">_index_terms</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">tree</tt><tt class="py-op">,</tt> <tt class="py-param">terms</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ParsedEpytextDocstring._index_terms-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ParsedEpytextDocstring._index_terms-expanded"><a name="L2107"></a><tt class="py-lineno">2107</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">tree</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt> <tt class="py-keyword">or</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">tree</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="L2108"></a><tt class="py-lineno">2108</tt> <tt class="py-line"> <tt class="py-keyword">return</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-keyword">if</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt id="link-563" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-563', 'tag', 'link-13');">tag</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'indexed'</tt><tt class="py-op">:</tt> </tt>
<a name="L2111"></a><tt class="py-lineno">2111</tt> <tt class="py-line"> <tt class="py-name">term</tt> <tt class="py-op">=</tt> <tt id="link-564" class="py-name"><a title="epydoc.markup.epytext.Element" class="py-name" href="#" onclick="return doclink('link-564', 'Element', 'link-30');">Element</a></tt><tt class="py-op">(</tt><tt class="py-string">'epytext'</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">attribs</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">terms</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-565" class="py-name"><a title="epydoc.markup.epytext.ParsedEpytextDocstring" class="py-name" href="#" onclick="return doclink('link-565', 'ParsedEpytextDocstring', 'link-373');">ParsedEpytextDocstring</a></tt><tt class="py-op">(</tt><tt class="py-name">term</tt><tt class="py-op">)</tt><tt class="py-op">)</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"># Look for index items in child nodes.</tt> </tt>
<a name="L2115"></a><tt class="py-lineno">2115</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">child</tt> <tt class="py-keyword">in</tt> <tt class="py-name">tree</tt><tt class="py-op">.</tt><tt class="py-name">children</tt><tt class="py-op">:</tt> </tt>
<a name="L2116"></a><tt class="py-lineno">2116</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-566" class="py-name"><a title="epydoc.markup.epytext.ParsedEpytextDocstring._index_terms" class="py-name" href="#" onclick="return doclink('link-566', '_index_terms', 'link-562');">_index_terms</a></tt><tt class="py-op">(</tt><tt class="py-name">child</tt><tt class="py-op">,</tt> <tt class="py-name">terms</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L2117"></a><tt class="py-lineno">2117</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:13 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>
|
