.happydoc.ClassicStructuredText.py :  » Development » HappyDoc » HappyDoc3-r3_1 » happydoclib » docstring » StructuredText » Python Open Source

Home
Python Open Source
1.3.1.2 Python
2.Ajax
3.Aspect Oriented
4.Blog
5.Build
6.Business Application
7.Chart Report
8.Content Management Systems
9.Cryptographic
10.Database
11.Development
12.Editor
13.Email
14.ERP
15.Game 2D 3D
16.GIS
17.GUI
18.IDE
19.Installer
20.IRC
21.Issue Tracker
22.Language Interface
23.Log
24.Math
25.Media Sound Audio
26.Mobile
27.Network
28.Parser
29.PDF
30.Project Management
31.RSS
32.Search
33.Security
34.Template Engines
35.Test
36.UML
37.USB Serial
38.Web Frameworks
39.Web Server
40.Web Services
41.Web Unit
42.Wiki
43.Windows
44.XML
Python Open Source » Development » HappyDoc 
HappyDoc » HappyDoc3 r3_1 » happydoclib » docstring » StructuredText » .happydoc.ClassicStructuredText.py
(S'89d3a293f803c84c84300a58f888dacd'
p1
(ihappydoclib.parseinfo.moduleinfo
ModuleInfo
p2
(dp3
S'_namespaces'
p4
((dp5
S'Table'
p6
(ihappydoclib.parseinfo.classinfo
ClassInfo
p7
(dp8
g4
((dp9
(dp10
S'create'
p11
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p12
(dp13
g4
((dp14
(dp15
tp16
sS'_exception_info'
p17
(dp18
sS'_parameter_names'
p19
(S'self'
p20
S'aPar'
p21
S'td_reg'
p22
tp23
sS'_parameter_info'
p24
(dp25
g22
(I1
S"re.compile( r'[ \\t\\n]*\\|\\|([^\\0|]*)' )"
Ntp26
sg20
(NNNtp27
sg21
(NNNtp28
ssS'_filename'
p29
S'../HappyDoc3-r3_1/happydoclib/docstring/StructuredText/ClassicStructuredText.py'
p30
sS'_docstring'
p31
S'parses a table and returns nested list representing the\n        table'
p32
sS'_name'
p33
g11
sS'_parent'
p34
g7
sS'_comment_info'
p35
(dp36
sS'_configuration_values'
p37
(dp38
sS'_class_info'
p39
g14
sS'_function_info'
p40
g15
sS'_comments'
p41
S''
sbsS'html'
p42
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p43
(dp44
g4
((dp45
(dp46
tp47
sg17
(dp48
sg19
(S'self'
p49
tp50
sg24
(dp51
g49
(NNNtp52
ssg29
g30
sg31
S'Creates an HTML representation of table'
p53
sg33
g42
sg34
g7
sg35
g36
sg37
(dp54
sg39
g45
sg40
g46
sg41
S''
sbstp55
sg29
g30
sg31
S''
sS'_class_member_info'
p56
(lp57
S'CELL'
p58
aS'ROW'
p59
aS'TABLE'
p60
asg33
g6
sg34
g2
sg35
g36
sS'_base_class_info'
p61
(lp62
sg37
(dp63
sg39
g9
sg40
g10
sg41
S''
sbsS'StructuredText'
p64
(ihappydoclib.parseinfo.classinfo
ClassInfo
p65
(dp66
g4
((dp67
(dp68
S'__str__'
p69
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p70
(dp71
g4
((dp72
(dp73
tp74
sg17
(dp75
sg19
(S'self'
p76
tp77
sg24
(dp78
g76
(NNNtp79
ssg29
g30
sg31
S''
sg33
g69
sg34
g65
sg35
g36
sg37
(dp80
sg39
g72
sg40
g73
sg41
S''
sbsS'__init__'
p81
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p82
(dp83
g4
((dp84
(dp85
tp86
sg17
(dp87
sg19
(S'self'
p88
S'aStructuredString'
p89
S'level'
p90
S'paragraph_divider'
p91
tp92
sg24
(dp93
g91
(I1
S"ts_regex.compile( '\\(\\r?\\n *\\)+\\r?\\n' )"
Ntp94
sg88
(NNNtp95
sg89
(NNNtp96
sg90
(I1
S'0'
Ntp97
ssg29
g30
sg31
S'Convert a structured text string into a structured text object.\n\n        Aguments:\n\n          aStructuredString -- The string to be parsed.\n          level -- The level of top level headings to be created.\n        '
p98
sg33
g81
sg34
g65
sg35
g36
sg37
(dp99
sg39
g84
sg40
g85
sg41
S''
sbstp100
sg29
g30
sg31
S'Model text as structured collection of paragraphs.\n\n    Structure is implied by the indentation level.\n\n    This class is intended as a base classes that do actual text\n    output formatting.\n    '
p101
sg56
(lp102
sg33
g64
sg34
g2
sg35
g36
sg61
(lp103
sg37
(dp104
sg39
g67
sg40
g68
sg41
S''
sbsS'HTML'
p105
(ihappydoclib.parseinfo.classinfo
ClassInfo
p106
(dp107
g4
((dp108
(dp109
S'pre'
p110
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p111
(dp112
g4
((dp113
(dp114
tp115
sg17
(dp116
sg19
(S'self'
p117
S'structure'
p118
S'tagged'
p119
tp120
sg24
(dp121
g117
(NNNtp122
sg119
(I1
S'0'
Ntp123
sg118
(NNNtp124
ssg29
g30
sg31
S''
sg33
g110
sg34
g106
sg35
g36
sg37
(dp125
sg39
g113
sg40
g114
sg41
S''
sbsS'head'
p126
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p127
(dp128
g4
((dp129
(dp130
tp131
sg17
(dp132
sg19
(S'self'
p133
S'before'
p134
S't'
S'level'
p135
S'd'
tp136
sg24
(dp137
S'd'
(NNNtp138
sg133
(NNNtp139
sg135
(NNNtp140
sS't'
(NNNtp141
sg134
(NNNtp142
ssg29
g30
sg31
S''
sg33
g126
sg34
g106
sg35
g36
sg37
(dp143
sg39
g129
sg40
g130
sg41
S''
sbsS'ol'
p144
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p145
(dp146
g4
((dp147
(dp148
tp149
sg17
(dp150
sg19
(S'self'
p151
S'before'
p152
S'p'
S'after'
p153
tp154
sg24
(dp155
S'p'
(NNNtp156
sg151
(NNNtp157
sg153
(NNNtp158
sg152
(NNNtp159
ssg29
g30
sg31
S''
sg33
g144
sg34
g106
sg35
g36
sg37
(dp160
sg39
g147
sg40
g148
sg41
S''
sbsS'normal'
p161
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p162
(dp163
g4
((dp164
(dp165
tp166
sg17
(dp167
sg19
(S'self'
p168
S'before'
p169
S'p'
S'after'
p170
tp171
sg24
(dp172
S'p'
(NNNtp173
sg168
(NNNtp174
sg170
(NNNtp175
sg169
(NNNtp176
ssg29
g30
sg31
S''
sg33
g161
sg34
g106
sg35
g36
sg37
(dp177
sg39
g164
sg40
g165
sg41
S''
sbsS'__str__'
p178
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p179
(dp180
g4
((dp181
(dp182
tp183
sg17
(dp184
sg19
(S'self'
p185
S'extra_dl'
p186
S'extra_ul'
p187
S'extra_ol'
p188
tp189
sg24
(dp190
g188
(I1
S're.compile( "</ol>\\n<ol>" )'
Ntp191
sg186
(I1
S're.compile( "</dl>\\n<dl>" )'
Ntp192
sg185
(NNNtp193
sg187
(I1
S're.compile( "</ul>\\n<ul>" )'
Ntp194
ssg29
g30
sg31
S'        Return an HTML string representation of the structured text data.\n\n        '
p195
sg33
g178
sg34
g106
sg35
g36
sg37
(dp196
sg39
g181
sg40
g182
sg41
S''
sbsS'_str'
p197
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p198
(dp199
g4
((dp200
(dp201
tp202
sg17
(dp203
sg19
(S'self'
p204
S'structure'
p205
S'level'
p206
S'bullet'
p207
S'example'
p208
S'dl'
p209
S'nl'
p210
S'ol'
p211
S'olp'
p212
tp213
sg24
(dp214
g209
(I1
S"ts_regex.compile( '\\([^\\n]+\\)[ \\t]+--[ \\t\\n]+\\([^\\0]*\\)' ).match_group"
Ntp215
sg211
(I1
S"ts_regex.compile( '[ \\t]*\\(\\([0-9]+\\|[%s]+\\)[.)]\\)+[ \\t\\n]+\\([^\\0]*\\|$\\)' % string.letters ).match_group"
Ntp216
sg210
(I1
S"ts_regex.compile( '\\n' ).search"
Ntp217
sg207
(I1
S"ts_regex.compile( '[ \\t\\n]*[o*-][ \\t\\n]+\\([^\\0]*\\)' ).match_group"
Ntp218
sg206
(NNNtp219
sg204
(NNNtp220
sg212
(I1
S"ts_regex.compile( '[ \\t]*([0-9]+)[ \\t\\n]+\\([^\\0]*\\|$\\)' ).match_group"
Ntp221
sg208
(I1
S"ts_regex.compile( '[\\0- ]examples?:[\\0- ]*$' ).search"
Ntp222
sg205
(NNNtp223
ssg29
g30
sg31
S''
sg33
g197
sg34
g106
sg35
g36
sg37
(dp224
sg39
g200
sg40
g201
sg41
S''
sbsS'dl'
p225
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p226
(dp227
g4
((dp228
(dp229
tp230
sg17
(dp231
sg19
(S'self'
p232
S'before'
p233
S't'
S'd'
S'after'
p234
tp235
sg24
(dp236
S'd'
(NNNtp237
sg232
(NNNtp238
sg234
(NNNtp239
sS't'
(NNNtp240
sg233
(NNNtp241
ssg29
g30
sg31
S''
sg33
g225
sg34
g106
sg35
g36
sg37
(dp242
sg39
g228
sg40
g229
sg41
S''
sbsS'ul'
p243
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p244
(dp245
g4
((dp246
(dp247
tp248
sg17
(dp249
sg19
(S'self'
p250
S'before'
p251
S'p'
S'after'
p252
tp253
sg24
(dp254
S'p'
(NNNtp255
sg250
(NNNtp256
sg252
(NNNtp257
sg251
(NNNtp258
ssg29
g30
sg31
S''
sg33
g243
sg34
g106
sg35
g36
sg37
(dp259
sg39
g246
sg40
g247
sg41
S''
sbsS'table'
p260
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p261
(dp262
g4
((dp263
(dp264
tp265
sg17
(dp266
sg19
(S'self'
p267
S'before'
p268
S'table'
p269
S'after'
p270
tp271
sg24
(dp272
g269
(NNNtp273
sg267
(NNNtp274
sg270
(NNNtp275
sg268
(NNNtp276
ssg29
g30
sg31
S''
sg33
g260
sg34
g106
sg35
g36
sg37
(dp277
sg39
g263
sg40
g264
sg41
S''
sbstp278
sg29
g30
sg31
S'    An HTML structured text formatter.\n    '
p279
sg56
(lp280
sg33
g105
sg34
g2
sg35
g36
sg61
(lp281
S'StructuredText'
p282
asg37
(dp283
sg39
g108
sg40
g109
sg41
S''
sbs(dp284
S'ctag'
p285
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p286
(dp287
g4
((dp288
(dp289
tp290
sg17
(dp291
sg19
(S's'
S'em'
p292
S'strong'
p293
S'under'
p294
S'code'
p295
tp296
sg24
(dp297
g292
(I1
S're.compile( ctag_prefix +(ctag_middle %(( "*", ) * 6 ) ) + ctag_suffix )'
Ntp298
sg295
(I1
S're.compile( ctag_prefix +(ctag_middle %(( "\\\'", ) * 6 ) ) + ctag_suffix )'
Ntp299
sS's'
(NNNtp300
sg293
(I1
S're.compile( ctag_prefix +(ctag_middl2 %(( "*", ) * 8 ) ) + ctag_suffix )'
Ntp301
sg294
(I1
S're.compile( ctag_prefix +(ctag_middle %(( "_", ) * 6 ) ) + ctag_suffix )'
Ntp302
ssg29
g30
sg31
S''
sg33
g285
sg34
g2
sg35
g36
sg37
(dp303
sg39
g288
sg40
g289
sg41
S''
sbsS'main'
p304
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p305
(dp306
g4
((dp307
(dp308
tp309
sg17
(dp310
sg19
(tsg24
(dp311
sg29
g30
sg31
S''
sg33
g304
sg34
g2
sg35
g36
sg37
(dp312
sg39
g307
sg40
g308
sg41
S''
sbsS'indent'
p313
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p314
(dp315
g4
((dp316
(dp317
tp318
sg17
(dp319
sg19
(S'aString'
p320
S'indent'
p321
tp322
sg24
(dp323
g321
(I1
S'2'
Ntp324
sg320
(NNNtp325
ssg29
g30
sg31
S'Indent a string the given number of spaces'
p326
sg33
g313
sg34
g2
sg35
g36
sg37
(dp327
sg39
g316
sg40
g317
sg41
S''
sbsS'reindent'
p328
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p329
(dp330
g4
((dp331
(dp332
tp333
sg17
(dp334
sg19
(S'aString'
p335
S'indent'
p336
S'already_untabified'
p337
tp338
sg24
(dp339
g336
(I1
S'2'
Ntp340
sg335
(NNNtp341
sg337
(I1
S'0'
Ntp342
ssg29
g30
sg31
S'reindent a block of text, so that the minimum indent is as given'
p343
sg33
g328
sg34
g2
sg35
g36
sg37
(dp344
sg39
g331
sg40
g332
sg41
S''
sbsS'untabify'
p345
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p346
(dp347
g4
((dp348
(dp349
tp350
sg17
(dp351
sg19
(S'aString'
p352
S'indent_tab'
p353
tp354
sg24
(dp355
g353
(I1
S"ts_regex.compile( '\\(\\n\\|^\\)\\( *\\)\\t' ).search_group"
Ntp356
sg352
(NNNtp357
ssg29
g30
sg31
S'    Convert indentation tabs to spaces.\n    '
p358
sg33
g345
sg34
g2
sg35
g36
sg37
(dp359
sg39
g348
sg40
g349
sg41
S''
sbsS'paragraphs'
p360
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p361
(dp362
g4
((dp363
(dp364
tp365
sg17
(dp366
sg19
(S'list'
p367
S'start'
p368
tp369
sg24
(dp370
g368
(NNNtp371
sg367
(NNNtp372
ssg29
g30
sg31
S''
sg33
g360
sg34
g2
sg35
g36
sg37
(dp373
sg39
g363
sg40
g364
sg41
S''
sbsS'html_with_references'
p374
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p375
(dp376
g4
((dp377
(dp378
tp379
sg17
(dp380
sg19
(S'text'
p381
S'level'
p382
tp383
sg24
(dp384
g381
(NNNtp385
sg382
(I1
S'1'
Ntp386
ssg29
g30
sg31
S''
sg33
g374
sg34
g2
sg35
g36
sg37
(dp387
sg39
g377
sg40
g378
sg41
S''
sbsS'html_quote'
p388
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p389
(dp390
g4
((dp391
(dp392
tp393
sg17
(dp394
sg19
(S'v'
S'character_entities'
p395
tp396
sg24
(dp397
g395
(I1
S'(( re.compile( \'&\' ), \'&amp;\' ), ( re.compile( "<" ), \'&lt;\' ), ( re.compile( ">" ), \'&gt;\' ), ( re.compile( \'"\' ), \'&quot;\' ) )'
Ntp398
sS'v'
(NNNtp399
ssg29
g30
sg31
S''
sg33
g388
sg34
g2
sg35
g36
sg37
(dp400
sg39
g391
sg40
g392
sg41
S''
sbsS'structure'
p401
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p402
(dp403
g4
((dp404
(dp405
tp406
sg17
(dp407
sg19
(S'list'
p408
tp409
sg24
(dp410
g408
(NNNtp411
ssg29
g30
sg31
S''
sg33
g401
sg34
g2
sg35
g36
sg37
(dp412
sg39
g404
sg40
g405
sg41
S''
sbsS'indent_level'
p413
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p414
(dp415
g4
((dp416
(dp417
tp418
sg17
(dp419
sg19
(S'aString'
p420
S'indent_space'
p421
tp422
sg24
(dp423
g421
(I1
S"ts_regex.compile( '\\n\\( *\\)' ).search_group"
Ntp424
sg420
(NNNtp425
ssg29
g30
sg31
S'    Find the minimum indentation for a string, not counting blank lines.\n    '
p426
sg33
g413
sg34
g2
sg35
g36
sg37
(dp427
sg39
g416
sg40
g417
sg41
S''
sbstp428
sS'_import_info'
p429
(ihappydoclib.parseinfo.imports
ImportInfo
p430
(dp431
S'_named_imports'
p432
(dp433
sS'_straight_imports'
p434
(lp435
sbsg29
g30
sg31
S'\'\'\'Structured Text Manipulation\n\nParse a structured text string into a form that can be used with\nstructured formats, like html.\n\nStructured text is text that uses indentation and simple\nsymbology to indicate the structure of a document.\n\nA structured string consists of a sequence of paragraphs separated by\none or more blank lines.  Each paragraph has a level which is defined\nas the minimum indentation of the paragraph.  A paragraph is a\nsub-paragraph of another paragraph if the other paragraph is the last\npreceding paragraph that has a lower level.\n\nSpecial symbology is used to indicate special constructs:\n\n- A single-line paragraph whose immediately succeeding paragraphs are lower\n  level is treated as a header.\n\n- A paragraph that begins with a \'-\', \'*\', or \'o\' is treated as an\n  unordered list (bullet) element.\n\n- A paragraph that begins with a sequence of digits followed by a\n  white-space character is treated as an ordered list element.\n\n- A paragraph that begins with a sequence of sequences, where each\n  sequence is a sequence of digits or a sequence of letters followed\n  by a period, is treated as an ordered list element.\n\n- A paragraph with a first line that contains some text, followed by\n  some white-space and \'--\' is treated as\n  a descriptive list element. The leading text is treated as the\n  element title.\n\n- Sub-paragraphs of a paragraph that ends in the word \'example\' or the\n  word \'examples\', or \'::\' is treated as example code and is output as is.\n\n- Text enclosed single quotes (with white-space to the left of the\n  first quote and whitespace or punctuation to the right of the second quote)\n  is treated as example code.\n\n- Text surrounded by \'*\' characters (with white-space to the left of the\n  first \'*\' and whitespace or punctuation to the right of the second \'*\')\n  is emphasized.\n\n- Text surrounded by \'**\' characters (with white-space to the left of the\n  first \'**\' and whitespace or punctuation to the right of the second \'**\')\n  is made strong.\n\n- Text surrounded by \'_\' underscore characters (with whitespace to the left\n  and whitespace or punctuation to the right) is made underlined.\n\n- Text encloded by double quotes followed by a colon, a URL, and concluded\n  by punctuation plus white space, *or* just white space, is treated as a\n  hyper link. For example:\n\n    "Zope":http://www.zope.org/ is ...\n\n  Is interpreted as \'<a href="http://www.zope.org/">Zope</a> is ....\'\n  Note: This works for relative as well as absolute URLs.\n\n- Text enclosed by double quotes followed by a comma, one or more spaces,\n  an absolute URL and concluded by punctuation plus white space, or just\n  white space, is treated as a hyper link. For example:\n\n    "mail me", mailto:amos@digicool.com.\n\n  Is interpreted as \'<a href="mailto:amos@digicool.com">mail me</a>.\'\n\n- Text enclosed in brackets which consists only of letters, digits,\n  underscores and dashes is treated as hyper links within the document.\n  For example:\n\n    As demonstrated by Smith [12] this technique is quite effective.\n\n  Is interpreted as \'... by Smith <a href="#12">[12]</a> this ...\'. Together\n  with the next rule this allows easy coding of references or end notes.\n\n- Text enclosed in brackets which is preceded by the start of a line, two\n  periods and a space is treated as a named link. For example:\n\n    .. [12] "Effective Techniques" Smith, Joe ...\n\n  Is interpreted as \'<a name="12">[12]</a> "Effective Techniques" ...\'.\n  Together with the previous rule this allows easy coding of references or\n  end notes.\n\n\n- A paragraph that has blocks of text enclosed in \'||\' is treated as a\n  table. The text blocks correspond to table cells and table rows are\n  denoted by newlines. By default the cells are center aligned. A cell\n  can span more than one column by preceding a block of text with an\n  equivalent number of cell separators \'||\'. Newlines and \'|\' cannot\n  be a part of the cell text. For example:\n\n      |||| **Ingredients** ||\n      || *Name* || *Amount* ||\n      ||Spam||10||\n      ||Eggs||3||\n\n  is interpreted as::\n\n    <TABLE BORDER=1 CELLPADDING=2>\n     <TR>\n      <TD ALIGN=CENTER COLSPAN=2> <strong>Ingredients</strong> </TD>\n     </TR>\n     <TR>\n      <TD ALIGN=CENTER COLSPAN=1> <em>Name</em> </TD>\n      <TD ALIGN=CENTER COLSPAN=1> <em>Amount</em> </TD>\n     </TR>\n     <TR>\n      <TD ALIGN=CENTER COLSPAN=1>Spam</TD>\n      <TD ALIGN=CENTER COLSPAN=1>10</TD>\n     </TR>\n     <TR>\n      <TD ALIGN=CENTER COLSPAN=1>Eggs</TD>\n      <TD ALIGN=CENTER COLSPAN=1>3</TD>\n     </TR>\n    </TABLE>\n\n\'\'\''
p436
sg33
S'ClassicStructuredText'
p437
sg34
Nsg35
g36
sg37
(dp438
S'include_comments'
p439
I1
sS'cacheFilePrefix'
p440
S'.happydoc.'
p441
sS'useCache'
p442
I1
sS'docStringFormat'
p443
S'StructuredText'
p444
ssg39
g5
sg40
g284
sg41
S''
sbt.
www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.