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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>epydoc.markup.epytext</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="epydoc-module.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 2.0</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="epydoc-module.html">Package epydoc</a> ::
<a href="epydoc.markup-module.html">Package markup</a> ::
Module epytext
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[show private | <a href="../public/epydoc.markup.epytext-module.html">hide private</a>]</font></td></tr>
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="epydoc.markup.epytext-module.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module epydoc.markup.epytext</h2>
Parser for epytext strings. Epytext is a lightweight markup whose
primary intended application is Python documentation strings. This parser
converts Epytext strings to a XML/DOM representation. Epytext strings can
contain the following <a name="index-structural_blocks"></a><i
class="indexterm">structural blocks</i>:
<ul>
<li>
<a name="index-epytext"></a><i class="indexterm">epytext</i>: The
top-level element of the DOM tree.
</li>
<li>
<a name="index-para"></a><i class="indexterm">para</i>: A
paragraph of text. Paragraphs contain no newlines, and all spaces are
soft.
</li>
<li>
<a name="index-section"></a><i class="indexterm">section</i>: A
section or subsection.
</li>
<li>
<a name="index-field"></a><i class="indexterm">field</i>: A tagged
field. These fields provide information about specific aspects of a
Python object, such as the description of a function's parameter, or
the author of a module.
</li>
<li>
<a name="index-literalblock"></a><i
class="indexterm">literalblock</i>: A block of literal text. This
text should be displayed as it would be displayed in plaintext. The
parser removes the appropriate amount of leading whitespace from each
line in the literal block.
</li>
<li>
<a name="index-doctestblock"></a><i
class="indexterm">doctestblock</i>: A block containing sample python
code, formatted according to the specifications of the
<code>doctest</code> module.
</li>
<li>
<a name="index-ulist"></a><i class="indexterm">ulist</i>: An
unordered list.
</li>
<li>
<a name="index-olist"></a><i class="indexterm">olist</i>: An
ordered list.
</li>
<li>
<a name="index-li"></a><i class="indexterm">li</i>: A list item.
This tag is used both for unordered list items and for ordered list
items.
</li>
</ul>
Additionally, the following <a name="index-inline_regions"></a><i
class="indexterm">inline regions</i> may be used within <code>para</code>
blocks:
<ul>
<li>
<a name="index-code"></a><i class="indexterm">code</i>: Source
code and identifiers.
</li>
<li>
<a name="index-math"></a><i class="indexterm">math</i>:
Mathematical expressions.
</li>
<li>
<a name="index-index"></a><i class="indexterm">index</i>: A term
which should be included in an index, if one is generated.
</li>
<li>
<a name="index-italic"></a><i class="indexterm">italic</i>:
Italicized text.
</li>
<li>
<a name="index-bold"></a><i class="indexterm">bold</i>: Bold-faced
text.
</li>
<li>
<a name="index-uri"></a><i class="indexterm">uri</i>: A Universal
Resource Indicator (URI) or Universal Resource Locator (URL)
</li>
<li>
<a name="index-link"></a><i class="indexterm">link</i>: A Python
identifier which should be hyperlinked to the named object's
documentation, when possible.
</li>
</ul>
The returned DOM tree will conform to the the following Document Type
Description:
<pre class="literalblock">
<!ENTITY % colorized '(code | math | index | italic |
bold | uri | link | symbol)*'>
<!ELEMENT epytext ((para | literalblock | doctestblock |
section | ulist | olist)*, fieldlist?)>
<!ELEMENT para (#PCDATA | %colorized;)*>
<!ELEMENT section (para | listblock | doctestblock |
section | ulist | olist)+>
<!ELEMENT fieldlist (field+)>
<!ELEMENT field (tag, arg?, (para | listblock | doctestblock)
ulist | olist)+)>
<!ELEMENT tag (#PCDATA)>
<!ELEMENT arg (#PCDATA)>
<!ELEMENT literalblock (#PCDATA)>
<!ELEMENT doctestblock (#PCDATA)>
<!ELEMENT ulist (li+)>
<!ELEMENT olist (li+)>
<!ELEMENT li (para | literalblock | doctestblock | ulist | olist)+>
<!ATTLIST li bullet NMTOKEN #IMPLIED>
<!ATTLIST olist start NMTOKEN #IMPLIED>
<!ELEMENT uri (name, target)>
<!ELEMENT link (name, target)>
<!ELEMENT name (#PCDATA | %colorized;)*>
<!ELEMENT target (#PCDATA)>
<!ELEMENT code (#PCDATA | %colorized;)*>
<!ELEMENT math (#PCDATA | %colorized;)*>
<!ELEMENT italic (#PCDATA | %colorized;)*>
<!ELEMENT bold (#PCDATA | %colorized;)*>
<!ELEMENT indexed (#PCDATA | %colorized;)>
<!ELEMENT symbol (#PCDATA)>
</pre>
<hr/>
<!-- =========== START OF CLASSES =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Classes</th></tr>
<tr><td width="15%">
<b><a href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html"><code>ParsedEpytextDocstring</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="epydoc.markup.epytext.Token-class.html"><code>Token</code></a></b></td>
<td><code>Token</code>s are an intermediate data structure used while
constructing the structuring DOM tree for a formatted docstring.</td></tr>
</table><br />
<!-- =========== START OF EXCEPTIONS =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Exceptions</th></tr>
<tr><td width="15%">
<b><a href="epydoc.markup.epytext.ColorizingError-class.html"><code>ColorizingError</code></a></b></td>
<td>An error generated while colorizing a paragraph.</td></tr>
<tr><td width="15%">
<b><a href="epydoc.markup.epytext.StructuringError-class.html"><code>StructuringError</code></a></b></td>
<td>An error generated while structuring a formatted documentation
string.</td></tr>
<tr><td width="15%">
<b><a href="epydoc.markup.epytext.TokenizationError-class.html"><code>TokenizationError</code></a></b></td>
<td>An error generated while tokenizing a formatted documentation
string.</td></tr>
</table><br />
<!-- =========== START OF FUNCTION SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Function Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>xml.dom.minidom.Document</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.markup.epytext-module.html#parse" class="summary-sig-name"><code>parse</code></a>(<span class=summary-sig-arg>str</span>,
<span class=summary-sig-arg>errors</span>)</span></code>
<br />
Return a DOM tree encoding the contents of an epytext string.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>xml.dom.minidom.Document</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.markup.epytext-module.html#parse_as_literal" class="summary-sig-name"><code>parse_as_literal</code></a>(<span class=summary-sig-arg>str</span>)</span></code>
<br />
Return a DOM document matching the epytext DTD, containing a single
literal block.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>xml.dom.minidom.Document</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.markup.epytext-module.html#parse_as_para" class="summary-sig-name"><code>parse_as_para</code></a>(<span class=summary-sig-arg>str</span>)</span></code>
<br />
Return a DOM document matching the epytext DTD, containing a single
paragraph.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="epydoc.markup.ParsedDocstring-class.html"
class="link"><code>ParsedDocstring</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.markup.epytext-module.html#parse_docstring" class="summary-sig-name"><code>parse_docstring</code></a>(<span class=summary-sig-arg>docstring</span>,
<span class=summary-sig-arg>errors</span>,
<span class="summary-sig-kwarg">**options</span>)</span></code>
<br />
Parse the given docstring, which is formatted using epytext; and
return a <code>ParsedDocstring</code> representation of its contents.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>xml.dom.minidom.Document</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.markup.epytext-module.html#pparse" class="summary-sig-name"><code>pparse</code></a>(<span class=summary-sig-arg>str</span>,
<span class=summary-sig-arg>show_warnings</span>,
<span class=summary-sig-arg>show_errors</span>,
<span class=summary-sig-arg>stream</span>)</span></code>
<br />
Pretty-parse the string.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>string</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.markup.epytext-module.html#to_debug" class="summary-sig-name"><code>to_debug</code></a>(<span class=summary-sig-arg>tree</span>,
<span class=summary-sig-arg>indent</span>,
<span class=summary-sig-arg>seclevel</span>)</span></code>
<br />
Convert a DOM document encoding epytext back to an epytext string,
annotated with extra debugging information.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>string</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.markup.epytext-module.html#to_epytext" class="summary-sig-name"><code>to_epytext</code></a>(<span class=summary-sig-arg>tree</span>,
<span class=summary-sig-arg>indent</span>,
<span class=summary-sig-arg>seclevel</span>)</span></code>
<br />
Convert a DOM document encoding epytext back to an epytext string.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>string</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.markup.epytext-module.html#to_plaintext" class="summary-sig-name"><code>to_plaintext</code></a>(<span class=summary-sig-arg>tree</span>,
<span class=summary-sig-arg>indent</span>,
<span class=summary-sig-arg>seclevel</span>)</span></code>
<br />
Convert a DOM document encoding epytext to a string
representation.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="../private/epydoc.markup.epytext-module.html#_add_list" class="summary-sig-name"><code>_add_list</code></a>(<span class=summary-sig-arg>doc</span>,
<span class=summary-sig-arg>bullet_token</span>,
<span class=summary-sig-arg>stack</span>,
<span class=summary-sig-arg>indent_stack</span>,
<span class=summary-sig-arg>errors</span>)</span></code>
<br />
Add a new list item or field to the DOM tree, with the given bullet or
field tag.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="../private/epydoc.markup.epytext-module.html#_add_para" class="summary-sig-name"><code>_add_para</code></a>(<span class=summary-sig-arg>doc</span>,
<span class=summary-sig-arg>para_token</span>,
<span class=summary-sig-arg>stack</span>,
<span class=summary-sig-arg>indent_stack</span>,
<span class=summary-sig-arg>errors</span>)</span></code>
<br />
Colorize the given paragraph, and add it to the DOM tree.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="../private/epydoc.markup.epytext-module.html#_add_section" class="summary-sig-name"><code>_add_section</code></a>(<span class=summary-sig-arg>doc</span>,
<span class=summary-sig-arg>heading_token</span>,
<span class=summary-sig-arg>stack</span>,
<span class=summary-sig-arg>indent_stack</span>,
<span class=summary-sig-arg>errors</span>)</span></code>
<br />
Add a new section to the DOM tree, with the given heading.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>Element</code>
</font></td>
<td><code><span class="summary-sig"><a href="../private/epydoc.markup.epytext-module.html#_colorize" class="summary-sig-name"><code>_colorize</code></a>(<span class=summary-sig-arg>doc</span>,
<span class=summary-sig-arg>token</span>,
<span class=summary-sig-arg>errors</span>,
<span class=summary-sig-arg>tagName</span>)</span></code>
<br />
Given a string containing the contents of a paragraph, produce a DOM
<code>Element</code> encoding that paragraph.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_colorize_link"></a><span class="summary-sig"><span class="summary-sig-name">_colorize_link</span>(<span class=summary-sig-arg>doc</span>,
<span class=summary-sig-arg>link</span>,
<span class=summary-sig-arg>token</span>,
<span class=summary-sig-arg>end</span>,
<span class=summary-sig-arg>errors</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="../private/epydoc.markup.epytext-module.html#_pop_completed_blocks" class="summary-sig-name"><code>_pop_completed_blocks</code></a>(<span class=summary-sig-arg>token</span>,
<span class=summary-sig-arg>stack</span>,
<span class=summary-sig-arg>indent_stack</span>)</span></code>
<br />
Pop any completed blocks off the stack.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>list</code> of <a
href="epydoc.markup.epytext.Token-class.html"
class="link"><code>Token</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="../private/epydoc.markup.epytext-module.html#_tokenize" class="summary-sig-name"><code>_tokenize</code></a>(<span class=summary-sig-arg>str</span>,
<span class=summary-sig-arg>errors</span>)</span></code>
<br />
Split a given formatted docstring into an ordered list of
<code>Token</code>s, according to the epytext markup rules.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>int</code>
</font></td>
<td><code><span class="summary-sig"><a href="../private/epydoc.markup.epytext-module.html#_tokenize_doctest" class="summary-sig-name"><code>_tokenize_doctest</code></a>(<span class=summary-sig-arg>lines</span>,
<span class=summary-sig-arg>start</span>,
<span class=summary-sig-arg>block_indent</span>,
<span class=summary-sig-arg>tokens</span>,
<span class=summary-sig-arg>errors</span>)</span></code>
<br />
Construct a <a href="epydoc.markup.epytext.Token-class.html"
class="link"><code>Token</code></a> containing the doctest block starting
at <code>lines[start]</code>, and append it to <code>tokens</code>.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>int</code>
</font></td>
<td><code><span class="summary-sig"><a href="../private/epydoc.markup.epytext-module.html#_tokenize_listart" class="summary-sig-name"><code>_tokenize_listart</code></a>(<span class=summary-sig-arg>lines</span>,
<span class=summary-sig-arg>start</span>,
<span class=summary-sig-arg>bullet_indent</span>,
<span class=summary-sig-arg>tokens</span>,
<span class=summary-sig-arg>errors</span>)</span></code>
<br />
Construct <a href="epydoc.markup.epytext.Token-class.html"
class="link"><code>Token</code></a>s for the bullet and the first
paragraph of the list item (or field) starting at
<code>lines[start]</code>, and append them to <code>tokens</code>.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>int</code>
</font></td>
<td><code><span class="summary-sig"><a href="../private/epydoc.markup.epytext-module.html#_tokenize_literal" class="summary-sig-name"><code>_tokenize_literal</code></a>(<span class=summary-sig-arg>lines</span>,
<span class=summary-sig-arg>start</span>,
<span class=summary-sig-arg>block_indent</span>,
<span class=summary-sig-arg>tokens</span>,
<span class=summary-sig-arg>errors</span>)</span></code>
<br />
Construct a <a href="epydoc.markup.epytext.Token-class.html"
class="link"><code>Token</code></a> containing the literal block starting
at <code>lines[start]</code>, and append it to <code>tokens</code>.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>int</code>
</font></td>
<td><code><span class="summary-sig"><a href="../private/epydoc.markup.epytext-module.html#_tokenize_para" class="summary-sig-name"><code>_tokenize_para</code></a>(<span class=summary-sig-arg>lines</span>,
<span class=summary-sig-arg>start</span>,
<span class=summary-sig-arg>para_indent</span>,
<span class=summary-sig-arg>tokens</span>,
<span class=summary-sig-arg>errors</span>)</span></code>
<br />
Construct a <a href="epydoc.markup.epytext.Token-class.html"
class="link"><code>Token</code></a> containing the paragraph starting at
<code>lines[start]</code>, and append it to <code>tokens</code>.</td></tr>
</table><br />
<!-- =========== START OF VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td>
<td><b><a href="epydoc.markup.epytext-module.html#SYMBOLS"><code>SYMBOLS</code></a></b>: A list of the of escape symbols that are supported by epydoc.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>SRE_Pattern</code></font></td>
<td><b><a href="../private/epydoc.markup.epytext-module.html#_BRACE_RE"><code>_BRACE_RE</code></a></b> = <span title="<_sre.SRE_Pattern object at 0x84fa388>"><code><span class="re"><span class="re-group">[</span><span class="re-char">\{</span><span class="re-char">\}</span><span class="re-group">]</span></span> </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>SRE_Pattern</code></font></td>
<td><b><a href="../private/epydoc.markup.epytext-module.html#_BULLET_RE"><code>_BULLET_RE</code></a></b> = <span title="<_sre.SRE_Pattern object at 0x835dcd0>"><code><span class="re">-<span class="re-group">(</span> <span class="re-op">+</span><span class="re-op">|</span><span class="re-char">$</span><span class="re-group">)</span><span class="re-op">|</span><span class="re-group">(</span><span class="re-char">\d</span><span class="re-op">+</span><span class="re-char">\.</span><span class="re-group">)</span><span class="re-op">+</span><span class="re-group">(</span> <span class="re-op">+</span><span class="re-op">|</span><span class="re-char">$</span><span class="re-group">)</span><span class="re-op">|</span>@<span class="re-char">\w</span><span class="re-op">+</span><span class="re-group">(</span> <span class="re-group">[</span><span class="re-group">^</span><span class="re-char">\{</span><span class="re-char">\}</span>:<span class="re-char">\n</span><span class="re-group">]</span><span class="re-op">+</span><span class="re-group">)</span><span class="re-op">?</span>:<span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td>
<td><b><a href="../private/epydoc.markup.epytext-module.html#_COLORIZING_TAGS"><code>_COLORIZING_TAGS</code></a></b> = <span title="{'S': 'symbol', 'C': 'code', 'B': 'bold', 'U': 'uri', 'I': 'italic', 'X': 'indexed', 'M': 'math', 'L': 'link', 'E': 'escape'}"><code>{'S': 'symbol', 'C': 'code', 'B': 'bo<span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td>
<td><b><a href="../private/epydoc.markup.epytext-module.html#_ESCAPES"><code>_ESCAPES</code></a></b> = <span title="{'lb': '{', 'rb': '}'}"><code>{'lb': '{', 'rb': '}'} </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>SRE_Pattern</code></font></td>
<td><b><a href="../private/epydoc.markup.epytext-module.html#_FIELD_BULLET_RE"><code>_FIELD_BULLET_RE</code></a></b> = <span title="<_sre.SRE_Pattern object at 0x84ff430>"><code><span class="re">@<span class="re-char">\w</span><span class="re-op">+</span><span class="re-group">(</span> <span class="re-group">[</span><span class="re-group">^</span><span class="re-char">\{</span><span class="re-char">\}</span>:<span class="re-char">\n</span><span class="re-group">]</span><span class="re-op">+</span><span class="re-group">)</span><span class="re-op">?</span>:<span class="re-group">(</span> <span class="re-op">+</span><span class="re-op">|</span><span class="re-char">$</span><span class="re-group">)</span></span> </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="../private/epydoc.markup.epytext-module.html#_HEADING_CHARS"><code>_HEADING_CHARS</code></a></b> = <span title="'=-~'"><code><span class="variable-quote">'</span>=-~<span class="variable-quote">'</span> </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td>
<td><b><a href="../private/epydoc.markup.epytext-module.html#_LINK_COLORIZING_TAGS"><code>_LINK_COLORIZING_TAGS</code></a></b> = <span title="['link', 'uri']"><code>['link', 'uri'] </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>SRE_Pattern</code></font></td>
<td><b><a href="../private/epydoc.markup.epytext-module.html#_LIST_BULLET_RE"><code>_LIST_BULLET_RE</code></a></b> = <span title="<_sre.SRE_Pattern object at 0x835df78>"><code><span class="re">-<span class="re-group">(</span> <span class="re-op">+</span><span class="re-op">|</span><span class="re-char">$</span><span class="re-group">)</span><span class="re-op">|</span><span class="re-group">(</span><span class="re-char">\d</span><span class="re-op">+</span><span class="re-char">\.</span><span class="re-group">)</span><span class="re-op">+</span><span class="re-group">(</span> <span class="re-op">+</span><span class="re-op">|</span><span class="re-char">$</span><span class="re-group">)</span></span> </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td>
<td><b><a href="../private/epydoc.markup.epytext-module.html#_SYMBOLS"><code>_SYMBOLS</code></a></b> = <span title="{'xi': 1, '>=': 1, 'lArr': 1, 'Chi': 1, 'omega': 1, 'ge': 1, 'sube': 1, 'asymp': 1, 'otimes': 1, 'zeta': 1, 'prop': 1, 'Nu': 1, 'equiv': 1, 'Psi': 1, 'integral': 1, 'cup': 1, 'chi': 1, 'Eta': 1, 'Beta': 1, 'perp': 1, 'Delta': 1, 'there4': 1, 'Upsilon': 1, 'Lambda': 1, 'iota': 1, 'empty': 1, 'notin': 1, 'Kappa': 1, 'darr': 1, 'sup': 1, 'part': 1, 'delta': 1, 'upsilon': 1, 'copy': 1, '^': 1, 'Tau': 1, 'Xi': 1, 'kappa': 1, 'dArr': 1, 'cap': 1, 'nu': 1, 'mu': 1, 'v': 1, 'isin': 1, 'Zeta': 1, '->': 1, 'theta': 1, 'and': 1, 'tau': 1, 'nsub': 1, 'ang': 1, 'int': 1, '<=': 1, 'product': 1, 'crarr': ..."><code>{'xi': 1, '>=': 1, 'lArr': 1, 'Chi': 1, 'omeg<span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>SRE_Pattern</code></font></td>
<td><b><a href="../private/epydoc.markup.epytext-module.html#_TARGET_RE"><code>_TARGET_RE</code></a></b> = <span title="<_sre.SRE_Pattern object at 0x82a3038>"><code><span class="re"><span class="re-char">^</span><span class="re-group">(</span><span class="re-char">.</span><span class="re-op">*?</span><span class="re-group">)</span><span class="re-char">\s</span><span class="re-op">*</span><<span class="re-group">(?:</span>URI:<span class="re-op">|</span>L:<span class="re-group">)</span><span class="re-op">?</span><span class="re-group">(</span><span class="re-group">[</span><span class="re-group">^</span><><span class="re-group">]</span><span class="re-op">+</span><span class="re-group">)</span>><span class="re-char">$</span></span> </code>
</span></td></tr>
</table><br />
<!-- =========== START OF FUNCTION DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Function Details</th></tr>
</table>
<a name="parse"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">parse</span>(<span class=sig-arg>str</span>,
<span class=sig-arg>errors</span>=<span class=sig-default>None</span>)</span>
</h3>
Return a DOM tree encoding the contents of an epytext string. Any
errors generated during parsing will be stored in
<code>errors</code>.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>str</b></code> -
The epytext string to parse.
<br /><i>
(type=<code>string</code>)</i>
<dd><code><b>errors</b></code> -
A list where any errors generated during parsing will be
stored. If no list is specified, then fatal errors will generate
exceptions, and non-fatal errors will be ignored.
<br /><i>
(type=<code>list</code> of <a
href="epydoc.markup.ParseError-class.html"
class="link"><code>ParseError</code></a>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
a DOM tree encoding the contents of an epytext string.
<br /><i>
(type=<code>xml.dom.minidom.Document</code>)</i>
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>ParseError</b></code> -
If <code>errors</code> is <code>None</code> and an error is
encountered while parsing.
</dl>
</dd></dl>
</td></tr></table>
<a name="parse_as_literal"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">parse_as_literal</span>(<span class=sig-arg>str</span>)</span>
</h3>
Return a DOM document matching the epytext DTD, containing a single
literal block. That literal block will include the contents of the
given string. This method is typically used as a fall-back when the
parser fails.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>str</b></code> -
The string which should be enclosed in a literal block.
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A DOM document containing <code>str</code> in a single literal
block.
<br /><i>
(type=<code>xml.dom.minidom.Document</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="parse_as_para"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">parse_as_para</span>(<span class=sig-arg>str</span>)</span>
</h3>
Return a DOM document matching the epytext DTD, containing a single
paragraph. That paragraph will include the contents of the given
string. This can be used to wrap some forms of automatically generated
information (such as type names) in paragraphs.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>str</b></code> -
The string which should be enclosed in a paragraph.
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A DOM document containing <code>str</code> in a single
paragraph.
<br /><i>
(type=<code>xml.dom.minidom.Document</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="parse_docstring"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">parse_docstring</span>(<span class=sig-arg>docstring</span>,
<span class=sig-arg>errors</span>,
<span class="sig-kwarg">**options</span>)</span>
</h3>
Parse the given docstring, which is formatted using epytext; and
return a <code>ParsedDocstring</code> representation of its
contents.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>docstring</b></code> -
The docstring to parse
<br /><i>
(type=<code>string</code>)</i>
<dd><code><b>errors</b></code> -
A list where any errors generated during parsing will be
stored.
<br /><i>
(type=<code>list</code> of <a
href="epydoc.markup.ParseError-class.html"
class="link"><code>ParseError</code></a>)</i>
<dd><code><b>options</b></code> -
Extra options. Unknown options are ignored. Currently, no
extra options are defined.
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<a href="epydoc.markup.ParsedDocstring-class.html"
class="link"><code>ParsedDocstring</code></a>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="pparse"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">pparse</span>(<span class=sig-arg>str</span>,
<span class=sig-arg>show_warnings</span>=<span class=sig-default>1</span>,
<span class=sig-arg>show_errors</span>=<span class=sig-default>1</span>,
<span class=sig-arg>stream</span>=<span class=sig-default><cStringIO.StringO object at 0x8504f68></span>)</span>
</h3>
Pretty-parse the string. This parses the string, and catches any
warnings or errors produced. Any warnings and errors are displayed, and
the resulting DOM parse structure is returned.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>str</b></code> -
The string to parse.
<br /><i>
(type=<code>string</code>)</i>
<dd><code><b>show_warnings</b></code> -
Whether or not to display non-fatal errors generated by
parsing <code>str</code>.
<br /><i>
(type=<code>boolean</code>)</i>
<dd><code><b>show_errors</b></code> -
Whether or not to display fatal errors generated by parsing
<code>str</code>.
<br /><i>
(type=<code>boolean</code>)</i>
<dd><code><b>stream</b></code> -
The stream that warnings and errors should be written to.
<br /><i>
(type=<code>stream</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
a DOM document encoding the contents of <code>str</code>.
<br /><i>
(type=<code>xml.dom.minidom.Document</code>)</i>
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>SyntaxError</b></code> -
If any fatal errors were encountered.
</dl>
</dd></dl>
</td></tr></table>
<a name="to_debug"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">to_debug</span>(<span class=sig-arg>tree</span>,
<span class=sig-arg>indent</span>=<span class=sig-default>4</span>,
<span class=sig-arg>seclevel</span>=<span class=sig-default>0</span>)</span>
</h3>
Convert a DOM document encoding epytext back to an epytext string,
annotated with extra debugging information. This function is similar to
<a href="epydoc.markup.epytext-module.html#to_epytext"
class="link"><code>to_epytext</code></a>, but it adds explicit
information about where different blocks begin, along the left
margin.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>tree</b></code> -
A DOM document encoding of an epytext string.
<br /><i>
(type=<code>xml.dom.minidom.Document</code>)</i>
<dd><code><b>indent</b></code> -
The indentation for the string representation of
<code>tree</code>. Each line of the returned string will begin
with <code>indent</code> space characters.
<br /><i>
(type=<code>int</code>)</i>
<dd><code><b>seclevel</b></code> -
The section level that <code>tree</code> appears at. This is
used to generate section headings.
<br /><i>
(type=<code>int</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
The epytext string corresponding to <code>tree</code>.
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="to_epytext"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">to_epytext</span>(<span class=sig-arg>tree</span>,
<span class=sig-arg>indent</span>=<span class=sig-default>0</span>,
<span class=sig-arg>seclevel</span>=<span class=sig-default>0</span>)</span>
</h3>
Convert a DOM document encoding epytext back to an epytext string.
This is the inverse operation from <a
href="epydoc.markup.epytext-module.html#parse"
class="link"><code>parse</code></a>. I.e., assuming there are no
errors, the following is true:
<ul>
<li>
<code>parse(to_epytext(tree)) == tree</code>
</li>
</ul>
The inverse is true, except that whitespace, line wrapping, and
character escaping may be done differently.
<ul>
<li>
<code>to_epytext(parse(str)) == str</code> (approximately)
</li>
</ul>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>tree</b></code> -
A DOM document encoding of an epytext string.
<br /><i>
(type=<code>xml.dom.minidom.Document</code>)</i>
<dd><code><b>indent</b></code> -
The indentation for the string representation of
<code>tree</code>. Each line of the returned string will begin
with <code>indent</code> space characters.
<br /><i>
(type=<code>int</code>)</i>
<dd><code><b>seclevel</b></code> -
The section level that <code>tree</code> appears at. This is
used to generate section headings.
<br /><i>
(type=<code>int</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
The epytext string corresponding to <code>tree</code>.
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="to_plaintext"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">to_plaintext</span>(<span class=sig-arg>tree</span>,
<span class=sig-arg>indent</span>=<span class=sig-default>0</span>,
<span class=sig-arg>seclevel</span>=<span class=sig-default>0</span>)</span>
</h3>
Convert a DOM document encoding epytext to a string representation.
This representation is similar to the string generated by
<code>to_epytext</code>, but <code>to_plaintext</code> removes inline
markup, prints escaped characters in unescaped form, etc.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>tree</b></code> -
A DOM document encoding of an epytext string.
<br /><i>
(type=<code>xml.dom.minidom.Document</code>)</i>
<dd><code><b>indent</b></code> -
The indentation for the string representation of
<code>tree</code>. Each line of the returned string will begin
with <code>indent</code> space characters.
<br /><i>
(type=<code>int</code>)</i>
<dd><code><b>seclevel</b></code> -
The section level that <code>tree</code> appears at. This is
used to generate section headings.
<br /><i>
(type=<code>int</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
The epytext string corresponding to <code>tree</code>.
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_add_list"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_add_list</span>(<span class=sig-arg>doc</span>,
<span class=sig-arg>bullet_token</span>,
<span class=sig-arg>stack</span>,
<span class=sig-arg>indent_stack</span>,
<span class=sig-arg>errors</span>)</span>
</h3>
Add a new list item or field to the DOM tree, with the given bullet
or field tag. When necessary, create the associated list.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="_add_para"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_add_para</span>(<span class=sig-arg>doc</span>,
<span class=sig-arg>para_token</span>,
<span class=sig-arg>stack</span>,
<span class=sig-arg>indent_stack</span>,
<span class=sig-arg>errors</span>)</span>
</h3>
Colorize the given paragraph, and add it to the DOM tree.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="_add_section"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_add_section</span>(<span class=sig-arg>doc</span>,
<span class=sig-arg>heading_token</span>,
<span class=sig-arg>stack</span>,
<span class=sig-arg>indent_stack</span>,
<span class=sig-arg>errors</span>)</span>
</h3>
Add a new section to the DOM tree, with the given heading.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="_colorize"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_colorize</span>(<span class=sig-arg>doc</span>,
<span class=sig-arg>token</span>,
<span class=sig-arg>errors</span>,
<span class=sig-arg>tagName</span>=<span class=sig-default>'para'</span>)</span>
</h3>
Given a string containing the contents of a paragraph, produce a DOM
<code>Element</code> encoding that paragraph. Colorized regions are
represented using DOM <code>Element</code>s, and text is represented
using DOM <code>Text</code>s.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>errors</b></code> -
A list of errors. Any newly generated errors will be appended
to this list.
<br /><i>
(type=<code>list</code> of <code>string</code>)</i>
<dd><code><b>tagName</b></code> -
The element tag for the DOM <code>Element</code> that should
be generated.
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
a DOM <code>Element</code> encoding the given paragraph.
<br /><i>
(type=<code>Element</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_pop_completed_blocks"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_pop_completed_blocks</span>(<span class=sig-arg>token</span>,
<span class=sig-arg>stack</span>,
<span class=sig-arg>indent_stack</span>)</span>
</h3>
Pop any completed blocks off the stack. This includes any blocks
that we have dedented past, as well as any list item blocks that we've
dedented to. The top element on the stack should only be a list if
we're about to start a new list item (i.e., if the next token is a
bullet).
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="_tokenize"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_tokenize</span>(<span class=sig-arg>str</span>,
<span class=sig-arg>errors</span>)</span>
</h3>
Split a given formatted docstring into an ordered list of
<code>Token</code>s, according to the epytext markup rules.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>str</b></code> -
The epytext string
<br /><i>
(type=<code>string</code>)</i>
<dd><code><b>errors</b></code> -
A list where any errors generated during parsing will be
stored. If no list is specified, then errors will generate
exceptions.
<br /><i>
(type=<code>list</code> of <a
href="epydoc.markup.ParseError-class.html"
class="link"><code>ParseError</code></a>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
a list of the <code>Token</code>s that make up the given
string.
<br /><i>
(type=<code>list</code> of <a
href="epydoc.markup.epytext.Token-class.html"
class="link"><code>Token</code></a>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_tokenize_doctest"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_tokenize_doctest</span>(<span class=sig-arg>lines</span>,
<span class=sig-arg>start</span>,
<span class=sig-arg>block_indent</span>,
<span class=sig-arg>tokens</span>,
<span class=sig-arg>errors</span>)</span>
</h3>
Construct a <a href="epydoc.markup.epytext.Token-class.html"
class="link"><code>Token</code></a> containing the doctest block
starting at <code>lines[start]</code>, and append it to
<code>tokens</code>. <code>block_indent</code> should be the
indentation of the doctest block. Any errors generated while tokenizing
the doctest block will be appended to <code>errors</code>.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>lines</b></code> -
The list of lines to be tokenized
<br /><i>
(type=<code>list</code> of <code>string</code>)</i>
<dd><code><b>start</b></code> -
The index into <code>lines</code> of the first line of the
doctest block to be tokenized.
<br /><i>
(type=<code>int</code>)</i>
<dd><code><b>block_indent</b></code> -
The indentation of <code>lines[start]</code>. This is the
indentation of the doctest block.
<br /><i>
(type=<code>int</code>)</i>
<dd><code><b>tokens</b></code>
<br /><i>
(type=<code>list</code> of <a
href="epydoc.markup.epytext.Token-class.html"
class="link"><code>Token</code></a>)</i>
<dd><code><b>errors</b></code> -
A list where any errors generated during parsing will be
stored. If no list is specified, then errors will generate
exceptions.
<br /><i>
(type=<code>list</code> of <a
href="epydoc.markup.ParseError-class.html"
class="link"><code>ParseError</code></a>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
The line number of the first line following the doctest
block.
<br /><i>
(type=<code>int</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_tokenize_listart"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_tokenize_listart</span>(<span class=sig-arg>lines</span>,
<span class=sig-arg>start</span>,
<span class=sig-arg>bullet_indent</span>,
<span class=sig-arg>tokens</span>,
<span class=sig-arg>errors</span>)</span>
</h3>
Construct <a href="epydoc.markup.epytext.Token-class.html"
class="link"><code>Token</code></a>s for the bullet and the first
paragraph of the list item (or field) starting at
<code>lines[start]</code>, and append them to <code>tokens</code>.
<code>bullet_indent</code> should be the indentation of the list item.
Any errors generated while tokenizing will be appended to
<code>errors</code>.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>lines</b></code> -
The list of lines to be tokenized
<br /><i>
(type=<code>list</code> of <code>string</code>)</i>
<dd><code><b>start</b></code> -
The index into <code>lines</code> of the first line of the
list item to be tokenized.
<br /><i>
(type=<code>int</code>)</i>
<dd><code><b>bullet_indent</b></code> -
The indentation of <code>lines[start]</code>. This is the
indentation of the list item.
<br /><i>
(type=<code>int</code>)</i>
<dd><code><b>tokens</b></code>
<br /><i>
(type=<code>list</code> of <a
href="epydoc.markup.epytext.Token-class.html"
class="link"><code>Token</code></a>)</i>
<dd><code><b>errors</b></code> -
A list of the errors generated by parsing. Any new errors
generated while will tokenizing this paragraph will be appended
to this list.
<br /><i>
(type=<code>list</code> of <a
href="epydoc.markup.ParseError-class.html"
class="link"><code>ParseError</code></a>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
The line number of the first line following the list item's
first paragraph.
<br /><i>
(type=<code>int</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_tokenize_literal"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_tokenize_literal</span>(<span class=sig-arg>lines</span>,
<span class=sig-arg>start</span>,
<span class=sig-arg>block_indent</span>,
<span class=sig-arg>tokens</span>,
<span class=sig-arg>errors</span>)</span>
</h3>
Construct a <a href="epydoc.markup.epytext.Token-class.html"
class="link"><code>Token</code></a> containing the literal block
starting at <code>lines[start]</code>, and append it to
<code>tokens</code>. <code>block_indent</code> should be the
indentation of the literal block. Any errors generated while tokenizing
the literal block will be appended to <code>errors</code>.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>lines</b></code> -
The list of lines to be tokenized
<br /><i>
(type=<code>list</code> of <code>string</code>)</i>
<dd><code><b>start</b></code> -
The index into <code>lines</code> of the first line of the
literal block to be tokenized.
<br /><i>
(type=<code>int</code>)</i>
<dd><code><b>block_indent</b></code> -
The indentation of <code>lines[start]</code>. This is the
indentation of the literal block.
<br /><i>
(type=<code>int</code>)</i>
<dd><code><b>tokens</b></code>
<br /><i>
(type=<code>list</code> of <a
href="epydoc.markup.epytext.Token-class.html"
class="link"><code>Token</code></a>)</i>
<dd><code><b>errors</b></code> -
A list of the errors generated by parsing. Any new errors
generated while will tokenizing this paragraph will be appended
to this list.
<br /><i>
(type=<code>list</code> of <a
href="epydoc.markup.ParseError-class.html"
class="link"><code>ParseError</code></a>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
The line number of the first line following the literal
block.
<br /><i>
(type=<code>int</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_tokenize_para"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_tokenize_para</span>(<span class=sig-arg>lines</span>,
<span class=sig-arg>start</span>,
<span class=sig-arg>para_indent</span>,
<span class=sig-arg>tokens</span>,
<span class=sig-arg>errors</span>)</span>
</h3>
Construct a <a href="epydoc.markup.epytext.Token-class.html"
class="link"><code>Token</code></a> containing the paragraph starting
at <code>lines[start]</code>, and append it to <code>tokens</code>.
<code>para_indent</code> should be the indentation of the paragraph .
Any errors generated while tokenizing the paragraph will be appended to
<code>errors</code>.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>lines</b></code> -
The list of lines to be tokenized
<br /><i>
(type=<code>list</code> of <code>string</code>)</i>
<dd><code><b>start</b></code> -
The index into <code>lines</code> of the first line of the
paragraph to be tokenized.
<br /><i>
(type=<code>int</code>)</i>
<dd><code><b>para_indent</b></code> -
The indentation of <code>lines[start]</code>. This is the
indentation of the paragraph.
<br /><i>
(type=<code>int</code>)</i>
<dd><code><b>tokens</b></code>
<br /><i>
(type=<code>list</code> of <a
href="epydoc.markup.epytext.Token-class.html"
class="link"><code>Token</code></a>)</i>
<dd><code><b>errors</b></code> -
A list of the errors generated by parsing. Any new errors
generated while will tokenizing this paragraph will be appended
to this list.
<br /><i>
(type=<code>list</code> of <a
href="epydoc.markup.ParseError-class.html"
class="link"><code>ParseError</code></a>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
The line number of the first line following the paragraph.
<br /><i>
(type=<code>int</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="SYMBOLS"></a>
<h3>SYMBOLS</h3>
A list of the of escape symbols that are supported by epydoc.
Currently the following symbols are supported:
<code>S{<-}</code>=←; <code>S{->}</code>=→;
<code>S{^}</code>=↑; <code>S{v}</code>=↓;
<code>S{alpha}</code>=α; <code>S{beta}</code>=β;
<code>S{gamma}</code>=γ; <code>S{delta}</code>=δ;
<code>S{epsilon}</code>=ε; <code>S{zeta}</code>=ζ;
<code>S{eta}</code>=η; <code>S{theta}</code>=θ;
<code>S{iota}</code>=ι; <code>S{kappa}</code>=κ;
<code>S{lambda}</code>=λ; <code>S{mu}</code>=μ;
<code>S{nu}</code>=ν; <code>S{xi}</code>=ξ;
<code>S{omicron}</code>=ο; <code>S{pi}</code>=π;
<code>S{rho}</code>=ρ; <code>S{sigma}</code>=σ;
<code>S{tau}</code>=τ; <code>S{upsilon}</code>=υ;
<code>S{phi}</code>=φ; <code>S{chi}</code>=χ;
<code>S{psi}</code>=ψ; <code>S{omega}</code>=ω;
<code>S{Alpha}</code>=Α; <code>S{Beta}</code>=Β;
<code>S{Gamma}</code>=Γ; <code>S{Delta}</code>=Δ;
<code>S{Epsilon}</code>=Ε; <code>S{Zeta}</code>=Ζ;
<code>S{Eta}</code>=Η; <code>S{Theta}</code>=Θ;
<code>S{Iota}</code>=Ι; <code>S{Kappa}</code>=Κ;
<code>S{Lambda}</code>=Λ; <code>S{Mu}</code>=Μ;
<code>S{Nu}</code>=Ν; <code>S{Xi}</code>=Ξ;
<code>S{Omicron}</code>=Ο; <code>S{Pi}</code>=Π;
<code>S{Rho}</code>=Ρ; <code>S{Sigma}</code>=Σ;
<code>S{Tau}</code>=Τ; <code>S{Upsilon}</code>=Υ;
<code>S{Phi}</code>=Φ; <code>S{Chi}</code>=Χ;
<code>S{Psi}</code>=Ψ; <code>S{Omega}</code>=Ω;
<code>S{larr}</code>=←; <code>S{rarr}</code>=→;
<code>S{uarr}</code>=↑; <code>S{darr}</code>=↓;
<code>S{harr}</code>=↔; <code>S{crarr}</code>=↵;
<code>S{lArr}</code>=⇐; <code>S{rArr}</code>=⇒;
<code>S{uArr}</code>=⇑; <code>S{dArr}</code>=⇓;
<code>S{hArr}</code>=⇔; <code>S{copy}</code>=©;
<code>S{times}</code>=×; <code>S{forall}</code>=∀;
<code>S{exist}</code>=∃; <code>S{part}</code>=∂;
<code>S{empty}</code>=∅; <code>S{isin}</code>=∈;
<code>S{notin}</code>=∉; <code>S{ni}</code>=∋;
<code>S{prod}</code>=∏; <code>S{sum}</code>=∑;
<code>S{prop}</code>=∝; <code>S{infin}</code>=∞;
<code>S{ang}</code>=∠; <code>S{and}</code>=∧;
<code>S{or}</code>=∨; <code>S{cap}</code>=∩;
<code>S{cup}</code>=∪; <code>S{int}</code>=∫;
<code>S{there4}</code>=∴; <code>S{sim}</code>=∼;
<code>S{cong}</code>=≅; <code>S{asymp}</code>=≈;
<code>S{ne}</code>=≠; <code>S{equiv}</code>=≡;
<code>S{le}</code>=≤; <code>S{ge}</code>=≥;
<code>S{sub}</code>=⊂; <code>S{sup}</code>=⊃;
<code>S{nsub}</code>=⊄; <code>S{sube}</code>=⊆;
<code>S{supe}</code>=⊇; <code>S{oplus}</code>=⊕;
<code>S{otimes}</code>=⊗; <code>S{perp}</code>=⊥;
<code>S{infinity}</code>=∞; <code>S{integral}</code>=∫;
<code>S{product}</code>=∏; <code>S{>=}</code>=≥;
<code>S{<=}</code>=≤
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>list</code>
</dd>
<span title="['<-', '->', '^', 'v', 'alpha', 'beta', 'gamma', 'delta', 'epsilon', 'zeta', 'eta', 'theta', 'iota', 'kappa', 'lambda', 'mu', 'nu', 'xi', 'omicron', 'pi', 'rho', 'sigma', 'tau', 'upsilon', 'phi', 'chi', 'psi', 'omega', 'Alpha', 'Beta', 'Gamma', 'Delta', 'Epsilon', 'Zeta', 'Eta', 'Theta', 'Iota', 'Kappa', 'Lambda', 'Mu', 'Nu', 'Xi', 'Omicron', 'Pi', 'Rho', 'Sigma', 'Tau', 'Upsilon', 'Phi', 'Chi', 'Psi', 'Omega', 'larr', 'rarr', 'uarr', 'darr', 'harr', 'crarr', 'lArr', 'rArr', 'uArr', 'dArr', 'hArr', 'copy', 'times', 'forall', 'exist', 'part', 'empty', 'isin', 'notin', 'ni', 'prod', 'sum', 'p..."> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
['<-', '->', '^', 'v', 'alpha', 'beta', 'gamma', 'delta', 'epsilon'] </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_BRACE_RE"></a>
<h3>_BRACE_RE</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>SRE_Pattern</code>
</dd>
<span title="<_sre.SRE_Pattern object at 0x84fa388>"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="re"><span class="re-group">[</span><span class="re-char">\{</span><span class="re-char">\}</span><span class="re-group">]</span></span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_BULLET_RE"></a>
<h3>_BULLET_RE</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>SRE_Pattern</code>
</dd>
<span title="<_sre.SRE_Pattern object at 0x835dcd0>"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="re">-<span class="re-group">(</span> <span class="re-op">+</span><span class="re-op">|</span><span class="re-char">$</span><span class="re-group">)</span><span class="re-op">|</span><span class="re-group">(</span><span class="re-char">\d</span><span class="re-op">+</span><span class="re-char">\.</span><span class="re-group">)</span><span class="re-op">+</span><span class="re-group">(</span> <span class="re-op">+</span><span class="re-op">|</span><span class="re-char">$</span><span class="re-group">)</span><span class="re-op">|</span>@<span class="re-char">\w</span><span class="re-op">+</span><span class="re-group">(</span> <span class="re-group">[</span><span class="re-group">^</span><span class="re-char">\{</span><span class="re-char">\}</span>:<span class="re-char">\n</span><span class="re-group">]</span><span class="re-op">+</span><span class="re-group">)</span><span class="re-op">?</span>:<span class="re-group">(</span> <span class="re-op">+</span><span class="re-op">|</span><span class="re-char">$</span><span class="re-group">)</span></span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_COLORIZING_TAGS"></a>
<h3>_COLORIZING_TAGS</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>dict</code>
</dd>
<span title="{'S': 'symbol', 'C': 'code', 'B': 'bold', 'U': 'uri', 'I': 'italic', 'X': 'indexed', 'M': 'math', 'L': 'link', 'E': 'escape'}"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
{'B': 'bold',
'C': 'code',
'E': 'escape',
'I': 'italic',
'L': 'link',
'M': 'math',
'S': 'symbol',
'U': 'uri',
<span class="variable-ellipsis">...</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_ESCAPES"></a>
<h3>_ESCAPES</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>dict</code>
</dd>
<span title="{'lb': '{', 'rb': '}'}"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
{'lb': '{', 'rb': '}'} </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_FIELD_BULLET_RE"></a>
<h3>_FIELD_BULLET_RE</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>SRE_Pattern</code>
</dd>
<span title="<_sre.SRE_Pattern object at 0x84ff430>"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="re">@<span class="re-char">\w</span><span class="re-op">+</span><span class="re-group">(</span> <span class="re-group">[</span><span class="re-group">^</span><span class="re-char">\{</span><span class="re-char">\}</span>:<span class="re-char">\n</span><span class="re-group">]</span><span class="re-op">+</span><span class="re-group">)</span><span class="re-op">?</span>:<span class="re-group">(</span> <span class="re-op">+</span><span class="re-op">|</span><span class="re-char">$</span><span class="re-group">)</span></span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_HEADING_CHARS"></a>
<h3>_HEADING_CHARS</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>str</code>
</dd>
<span title="'=-~'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>=-~<span class="variable-quote">'</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_LINK_COLORIZING_TAGS"></a>
<h3>_LINK_COLORIZING_TAGS</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>list</code>
</dd>
<span title="['link', 'uri']"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
['link', 'uri'] </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_LIST_BULLET_RE"></a>
<h3>_LIST_BULLET_RE</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>SRE_Pattern</code>
</dd>
<span title="<_sre.SRE_Pattern object at 0x835df78>"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="re">-<span class="re-group">(</span> <span class="re-op">+</span><span class="re-op">|</span><span class="re-char">$</span><span class="re-group">)</span><span class="re-op">|</span><span class="re-group">(</span><span class="re-char">\d</span><span class="re-op">+</span><span class="re-char">\.</span><span class="re-group">)</span><span class="re-op">+</span><span class="re-group">(</span> <span class="re-op">+</span><span class="re-op">|</span><span class="re-char">$</span><span class="re-group">)</span></span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_SYMBOLS"></a>
<h3>_SYMBOLS</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>dict</code>
</dd>
<span title="{'xi': 1, '>=': 1, 'lArr': 1, 'Chi': 1, 'omega': 1, 'ge': 1, 'sube': 1, 'asymp': 1, 'otimes': 1, 'zeta': 1, 'prop': 1, 'Nu': 1, 'equiv': 1, 'Psi': 1, 'integral': 1, 'cup': 1, 'chi': 1, 'Eta': 1, 'Beta': 1, 'perp': 1, 'Delta': 1, 'there4': 1, 'Upsilon': 1, 'Lambda': 1, 'iota': 1, 'empty': 1, 'notin': 1, 'Kappa': 1, 'darr': 1, 'sup': 1, 'part': 1, 'delta': 1, 'upsilon': 1, 'copy': 1, '^': 1, 'Tau': 1, 'Xi': 1, 'kappa': 1, 'dArr': 1, 'cap': 1, 'nu': 1, 'mu': 1, 'v': 1, 'isin': 1, 'Zeta': 1, '->': 1, 'theta': 1, 'and': 1, 'tau': 1, 'nsub': 1, 'ang': 1, 'int': 1, '<=': 1, 'product': 1, 'crarr': ..."> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
{'>=': 1,
'Chi': 1,
'asymp': 1,
'ge': 1,
'lArr': 1,
'omega': 1,
'otimes': 1,
'sube': 1,
<span class="variable-ellipsis">...</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_TARGET_RE"></a>
<h3>_TARGET_RE</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>SRE_Pattern</code>
</dd>
<span title="<_sre.SRE_Pattern object at 0x82a3038>"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="re"><span class="re-char">^</span><span class="re-group">(</span><span class="re-char">.</span><span class="re-op">*?</span><span class="re-group">)</span><span class="re-char">\s</span><span class="re-op">*</span><<span class="re-group">(?:</span>URI:<span class="re-op">|</span>L:<span class="re-group">)</span><span class="re-op">?</span><span class="re-group">(</span><span class="re-group">[</span><span class="re-group">^</span><><span class="re-group">]</span><span class="re-op">+</span><span class="re-group">)</span>><span class="re-char">$</span></span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="epydoc-module.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 2.0</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Mar 20 17:46:14 2004</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>
|
