(S'ea95ab3f4bd28470abf44fb8dfd0a60e'
p1
(ihappydoclib.parseinfo.moduleinfo
ModuleInfo
p2
(dp3
S'_namespaces'
p4
((dp5
S'MultiFileDocSet'
p6
(ihappydoclib.parseinfo.classinfo
ClassInfo
p7
(dp8
g4
((dp9
(dp10
S'processDirectory'
p11
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p12
(dp13
g4
((dp14
(dp15
tp16
sS'_exception_info'
p17
(dp18
sS'_parameter_names'
p19
(S'self'
p20
S'packageTreeNode'
p21
tp22
sS'_parameter_info'
p23
(dp24
g20
(NNNtp25
sg21
(NNNtp26
ssS'_filename'
p27
S'../HappyDoc3-r3_1/happydoclib/docset/base.py'
p28
sS'_docstring'
p29
S'Handler for application/x-directory nodes.\n\n Creates the output directory and writes the table of contents\n file.\n '
p30
sS'_name'
p31
g11
sS'_parent'
p32
g7
sS'_comment_info'
p33
(dp34
sS'_configuration_values'
p35
(dp36
sS'_class_info'
p37
g14
sS'_function_info'
p38
g15
sS'_comments'
p39
S''
sbsS'writeText'
p40
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p41
(dp42
g4
((dp43
(dp44
tp45
sg17
(dp46
sg19
(S'self'
p47
S'output'
p48
S'text'
p49
S'textFormat'
p50
tp51
sg23
(dp52
g48
(NNNtp53
sg47
(NNNtp54
sg50
(NNNtp55
sg49
(NNNtp56
ssg27
g28
sg29
S"Format and write the 'text' to the 'output'.\n\n Arguments:\n\n 'output' -- Stream to which 'text' should be written.\n\n 'text' -- String to be written.\n\n 'textFormat' -- String identifying the format of 'text' so\n the formatter can use a docstring converter to convert the\n body of 'text' to the appropriate output format.\n\n 'quote=1' -- Boolean option to control whether the text\n should be quoted to escape special characters.\n\n "
p57
sg31
g40
sg32
g7
sg33
g34
sg35
(dp58
sg37
g43
sg38
g44
sg39
S''
sbsS'writeFileHeader'
p59
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p60
(dp61
g4
((dp62
(dp63
tp64
sg17
(dp65
S"NotImplementedError( 'writeFileHeader' )"
p66
Nssg19
(S'self'
p67
S'output'
p68
S'packageTreeNode'
p69
S'title'
p70
S'subtitle'
p71
tp72
sg23
(dp73
g68
(NNNtp74
sg67
(NNNtp75
sg69
(NNNtp76
sg71
(I1
S"''"
Ntp77
sg70
(I1
S"''"
Ntp78
ssg27
g28
sg29
S'Given an open output stream, write a header using the title and subtitle.\n\n Subclasses must implement this method.\n '
p79
sg31
g59
sg32
g7
sg33
g34
sg35
(dp80
sg37
g62
sg38
g63
sg39
S''
sbsS'_computeRelativeHREF'
p81
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p82
(dp83
g4
((dp84
(dp85
tp86
sg17
(dp87
sg19
(S'self'
p88
S'source'
p89
S'destination'
p90
tp91
sg23
(dp92
g89
(NNNtp93
sg88
(NNNtp94
sg90
(NNNtp95
ssg27
g28
sg29
S'Compute the HREF to point from the output file of source to destination.\n '
p96
sg31
g81
sg32
g7
sg33
g34
sg35
(dp97
sg37
g84
sg38
g85
sg39
S''
sbsS'closeOutput'
p98
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p99
(dp100
g4
((dp101
(dp102
tp103
sg17
(dp104
sg19
(S'self'
p105
S'output'
p106
tp107
sg23
(dp108
g106
(NNNtp109
sg105
(NNNtp110
ssg27
g28
sg29
S'Close the output stream.\n\n Writes a footer to the output stream and then closes it.\n '
p111
sg31
g98
sg32
g7
sg33
g34
sg35
(dp112
sg37
g101
sg38
g102
sg39
S''
sbsS'writeFileFooter'
p113
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p114
(dp115
g4
((dp116
(dp117
tp118
sg17
(dp119
S"NotImplementedError( 'writeFileFooter' )"
p120
Nssg19
(S'self'
p121
S'output'
p122
tp123
sg23
(dp124
g122
(NNNtp125
sg121
(NNNtp126
ssg27
g28
sg29
S'Given an open output stream, write a footer using the title and subtitle.\n\n Subclasses must implement this method.\n '
p127
sg31
g113
sg32
g7
sg33
g34
sg35
(dp128
sg37
g116
sg38
g117
sg39
S''
sbsS'writeTOCFile'
p129
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p130
(dp131
g4
((dp132
(dp133
tp134
sg17
(dp135
S"NotImplementedError( 'writeTOCFile' )"
p136
Nssg19
(S'self'
p137
S'packageTreeNode'
p138
tp139
sg23
(dp140
g137
(NNNtp141
sg138
(NNNtp142
ssg27
g28
sg29
S'Write the table of contents for a directory.\n\n Subclasses must implement this method.\n\n The packageTreeNode is a directory, and the table of contents\n for that directory should be written as appropriate.\n '
p143
sg31
g129
sg32
g7
sg33
g34
sg35
(dp144
sg37
g132
sg38
g133
sg39
S''
sbsS'_initializeWriters'
p145
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p146
(dp147
g4
((dp148
(dp149
tp150
sg17
(dp151
sg19
(S'self'
p152
tp153
sg23
(dp154
g152
(NNNtp155
ssg27
g28
sg29
S'Hook to allow subclasses to register writers without having to\n override __init__ with all of its arguments.\n '
p156
sg31
g145
sg32
g7
sg33
g34
sg35
(dp157
sg37
g148
sg38
g149
sg39
S''
sbsS'noopHandler'
p158
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p159
(dp160
g4
((dp161
(dp162
tp163
sg17
(dp164
sg19
(S'self'
p165
S'packageTreeNode'
p166
tp167
sg23
(dp168
g165
(NNNtp169
sg166
(NNNtp170
ssg27
g28
sg29
S'Handler that does nothing.\n '
p171
sg31
g158
sg32
g7
sg33
g34
sg35
(dp172
sg37
g161
sg38
g162
sg39
S''
sbsS'getOutputFilenameForPackageTreeNode'
p173
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p174
(dp175
g4
((dp176
(dp177
tp178
sg17
(dp179
sg19
(S'self'
p180
S'packageTreeNode'
p181
S'includePath'
p182
tp183
sg23
(dp184
g180
(NNNtp185
sg181
(NNNtp186
sg182
(I1
S'1'
Ntp187
ssg27
g28
sg29
S'Returns a filename where documentation for packageTreeNode should be written.\n\n The filename will be in the output directory, possibly in a\n subdirectory based on the path from the input root to the\n input file.\n\n For example::\n\n input_directory : /foo/input\n containing : /foo/input/bar.py\n output_directory : /foo/output\n\n results in : /foo/output/input/bar.py\n '
p188
sg31
g173
sg32
g7
sg33
g34
sg35
(dp189
sg37
g176
sg38
g177
sg39
S''
sbsS'rmkdir'
p190
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p191
(dp192
g4
((dp193
(dp194
tp195
sg17
(dp196
sg19
(S'self'
p197
S'path'
p198
tp199
sg23
(dp200
g198
(NNNtp201
sg197
(NNNtp202
ssg27
g28
sg29
S'Create a directory and all of its children.'
p203
sg31
g190
sg32
g7
sg33
g34
sg35
(dp204
sg37
g193
sg38
g194
sg39
S''
sbsS'processPlainTextFile'
p205
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p206
(dp207
g4
((dp208
(dp209
tp210
sg17
(dp211
sg19
(S'self'
p212
S'packageTreeNode'
p213
tp214
sg23
(dp215
g212
(NNNtp216
sg213
(NNNtp217
ssg27
g28
sg29
S'Handler for text/x-structured and text/plain nodes.\n\n Converts the input file to the output file format and\n generates the output. The output directory is assumed to\n already exist.\n '
p218
sg31
g205
sg32
g7
sg33
g34
sg35
(dp219
sg37
g208
sg38
g209
sg39
S''
sbsS'formatText'
p220
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p221
(dp222
g4
((dp223
(dp224
tp225
sg17
(dp226
sg19
(S'self'
p227
S'text'
p228
S'textFormat'
p229
tp230
sg23
(dp231
g228
(NNNtp232
sg227
(NNNtp233
sg229
(NNNtp234
ssg27
g28
sg29
S"Returns text formatted appropriately for output by this docset.\n\n Arguments:\n\n 'text' -- String to be formatted.\n\n 'textFormat' -- String identifying the format of 'text' so\n the formatter can use a docstring converter to convert the\n body of 'text' to the appropriate output format.\n\n 'quote=1' -- Boolean option to control whether the text\n should be quoted to escape special characters.\n\n "
p235
sg31
g220
sg32
g7
sg33
g34
sg35
(dp236
sg37
g223
sg38
g224
sg39
S''
sbsS'processPythonFile'
p237
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p238
(dp239
g4
((dp240
(dp241
tp242
sg17
(dp243
S"NotImplementedError( 'processPythonFile' )"
p244
Nssg19
(S'self'
p245
S'packageTreeNode'
p246
tp247
sg23
(dp248
g245
(NNNtp249
sg246
(NNNtp250
ssg27
g28
sg29
S'Handler for text/x-python nodes.\n '
p251
sg31
g237
sg32
g7
sg33
g34
sg35
(dp252
sg37
g240
sg38
g241
sg39
S''
sbsS'_unquoteString'
p253
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p254
(dp255
g4
((dp256
(dp257
tp258
sg17
(dp259
sg19
(S'self'
p260
S'str'
p261
tp262
sg23
(dp263
g260
(NNNtp264
sg261
(NNNtp265
ssg27
g28
sg29
S'Remove surrounding quotes from a string.'
p266
sg31
g253
sg32
g7
sg33
g34
sg35
(dp267
sg37
g256
sg38
g257
sg39
S''
sbsS'openOutput'
p268
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p269
(dp270
g4
((dp271
(dp272
tp273
sg17
(dp274
sg19
(S'self'
p275
S'name'
p276
S'packageTreeNode'
p277
S'title'
p278
S'subtitle'
p279
tp280
sg23
(dp281
g275
(NNNtp282
sg277
(NNNtp283
sg279
(I1
S"''"
Ntp284
sg276
(NNNtp285
sg278
(I1
S"''"
Ntp286
ssg27
g28
sg29
S'Open the output stream from the name.\n\n Opens the output stream and writes a header using title and\n subtitle. Returns the stream.\n '
p287
sg31
g268
sg32
g7
sg33
g34
sg35
(dp288
sg37
g271
sg38
g272
sg39
S''
sbsS'copyInputFileToOutput'
p289
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p290
(dp291
g4
((dp292
(dp293
tp294
sg17
(dp295
sg19
(S'self'
p296
S'packageTreeNode'
p297
tp298
sg23
(dp299
g296
(NNNtp300
sg297
(NNNtp301
ssg27
g28
sg29
S'Copy the input file to the appropriate place in the output.\n '
p302
sg31
g289
sg32
g7
sg33
g34
sg35
(dp303
sg37
g292
sg38
g293
sg39
S''
sbstp304
sg27
g28
sg29
S'Base class for documentation sets which write to multiple files.\n\n This class further extends the DocSet class by adding several\n convenience methods for handling files, as well as a few basic\n handlers.\n \n '
p305
sS'_class_member_info'
p306
(lp307
S'CONVERTER_HEADER_START_LEVEL'
p308
aS'mimetype_extension_mapping'
p309
asg31
g6
sg32
g2
sg33
g34
sS'_base_class_info'
p310
(lp311
S'DocSet'
p312
asg35
(dp313
sg37
g9
sg38
g10
sg39
S''
sbsS'DocSetBase'
p314
(ihappydoclib.parseinfo.classinfo
ClassInfo
p315
(dp316
g4
((dp317
(dp318
S'write'
p319
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p320
(dp321
g4
((dp322
(dp323
tp324
sg17
(dp325
S"NotImplementedError( '%s.write' % self.__class__.__name__ )"
p326
Nssg19
(S'self'
p327
tp328
sg23
(dp329
g327
(NNNtp330
ssg27
g28
sg29
S'Called by the application to cause the docset to be written.\n '
p331
sg31
g319
sg32
g315
sg33
g34
sg35
(dp332
sg37
g322
sg38
g323
sg39
S''
sbsS'statusMessage'
p333
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p334
(dp335
g4
((dp336
(dp337
tp338
sg17
(dp339
sg19
(S'self'
p340
S'message'
p341
S'verboseLevel'
p342
tp343
sg23
(dp344
g342
(I1
S'1'
Ntp345
sg340
(NNNtp346
sg341
(I1
S"''"
Ntp347
ssg27
g28
sg29
S'Print a status message for the user.'
p348
sg31
g333
sg32
g315
sg33
g34
sg35
(dp349
sg37
g336
sg38
g337
sg39
S''
sbsS'__init__'
p350
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p351
(dp352
g4
((dp353
(dp354
tp355
sg17
(dp356
sg19
(S'self'
p357
S'scanner'
p358
S'title'
p359
S'outputDirectory'
p360
S'statusMessageFunc'
p361
S'extraParameters'
p362
tp363
sg23
(dp364
g358
(NNNtp365
sg359
(NNNtp366
sg357
(NNNtp367
sg362
(I1
S'{}'
Ntp368
sg360
(NNNtp369
sg361
(I1
S'None'
Ntp370
ssg27
g28
sg29
S'Basic Documentation Set\n\n Parameters\n\n scanner -- A directory tree scanner.\n\n title -- the title of the documentation set\n\n outputDirectory -- The base directory for writing the\n output files.\n\n statusMessageFunc -- function which will print a status\n message for the user\n \n extraParameters -- Dictionary containing parameters\n specified on the command line by\n the user.\n\n '
p371
sg31
g350
sg32
g315
sg33
g34
sg35
(dp372
sg37
g353
sg38
g354
sg39
S''
sbsS'warningMessage'
p373
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p374
(dp375
g4
((dp376
(dp377
tp378
sg17
(dp379
sg19
(S'self'
p380
S'message'
p381
tp382
sg23
(dp383
g380
(NNNtp384
sg381
(I1
S"''"
Ntp385
ssg27
g28
sg29
S''
sg31
g373
sg32
g315
sg33
g34
sg35
(dp386
sg37
g376
sg38
g377
sg39
S''
sbstp387
sg27
g28
sg29
S"Base class for documentation sets.\n\n This is the base class for all documentation set classes. The\n methods defined here are required of all docset classes. Only the\n 'write' method is actually used by the main application.\n "
p388
sg306
(lp389
sg31
g314
sg32
g2
sg33
g34
sg310
(lp390
sg35
(dp391
sg37
g317
sg38
g318
sg39
S''
sbsS'DocSet'
p392
(ihappydoclib.parseinfo.classinfo
ClassInfo
p393
(dp394
g4
((dp395
(dp396
S'_filterNames'
p397
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p398
(dp399
g4
((dp400
(dp401
tp402
sg17
(dp403
sg19
(S'self'
p404
S'nameList'
p405
tp406
sg23
(dp407
g405
(NNNtp408
sg404
(NNNtp409
ssg27
g28
sg29
S'Remove names which should be ignored.\n\n Parameters\n\n nameList -- List of strings representing names of methods,\n classes, functions, etc.\n \n This method returns a list based on the contents of nameList.\n If private names are being ignored, they are removed before\n the list is returned.\n\n '
p410
sg31
g397
sg32
g393
sg33
g34
sg35
(dp411
sg37
g400
sg38
g401
sg39
S''
sbsS'registerWriter'
p412
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p413
(dp414
g4
((dp415
(dp416
tp417
sg17
(dp418
sg19
(S'self'
p419
S'mimetype'
p420
S'writerName'
p421
tp422
sg23
(dp423
g420
(NNNtp424
sg419
(NNNtp425
sg421
(NNNtp426
ssg27
g28
sg29
S'Register a writer for the specified mimetype.\n '
p427
sg31
g412
sg32
g393
sg33
g34
sg35
(dp428
sg37
g415
sg38
g416
sg39
S''
sbsS'_initializeWriters'
p429
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p430
(dp431
g4
((dp432
(dp433
tp434
sg17
(dp435
sg19
(S'self'
p436
tp437
sg23
(dp438
g436
(NNNtp439
ssg27
g28
sg29
S'Hook to allow subclasses to register writers without having to\n override __init__ with all of its arguments.\n '
p440
sg31
g429
sg32
g393
sg33
g34
sg35
(dp441
sg37
g432
sg38
g433
sg39
S''
sbsS'write'
p442
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p443
(dp444
g4
((dp445
(dp446
tp447
sg17
(dp448
sg19
(S'self'
p449
tp450
sg23
(dp451
g449
(NNNtp452
ssg27
g28
sg29
S'Called by the application to cause the docset to be written.\n '
p453
sg31
g442
sg32
g393
sg33
g34
sg35
(dp454
sg37
g445
sg38
g446
sg39
S''
sbsS'writeCB'
p455
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p456
(dp457
g4
((dp458
(dp459
tp460
sg17
(dp461
sg19
(S'self'
p462
S'packageTreeNode'
p463
tp464
sg23
(dp465
g462
(NNNtp466
sg463
(NNNtp467
ssg27
g28
sg29
S'Callback used when walking the scanned package tree.\n '
p468
sg31
g455
sg32
g393
sg33
g34
sg35
(dp469
sg37
g458
sg38
g459
sg39
S''
sbsS'getWriterForNode'
p470
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p471
(dp472
g4
((dp473
(dp474
tp475
sg17
(dp476
sg19
(S'self'
p477
S'packageTreeNode'
p478
tp479
sg23
(dp480
g477
(NNNtp481
sg478
(NNNtp482
ssg27
g28
sg29
S'Returns the writer to be used for the node.\n '
p483
sg31
g470
sg32
g393
sg33
g34
sg35
(dp484
sg37
g473
sg38
g474
sg39
S''
sbsS'_skipInputFile'
p485
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p486
(dp487
g4
((dp488
(dp489
tp490
sg17
(dp491
sg19
(S'self'
p492
S'packageTreeNode'
p493
tp494
sg23
(dp495
g492
(NNNtp496
sg493
(NNNtp497
ssg27
g28
sg29
S'False writer method used to notify the user that a node is being\n skipped because the real writer is unknown.\n '
p498
sg31
g485
sg32
g393
sg33
g34
sg35
(dp499
sg37
g488
sg38
g489
sg39
S''
sbsS'__init__'
p500
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p501
(dp502
g4
((dp503
(dp504
tp505
sg17
(dp506
sg19
(S'self'
p507
S'scanner'
p508
S'title'
p509
S'outputDirectory'
p510
S'includeComments'
p511
S'includePrivateNames'
p512
S'sortNames'
p513
S'statusMessageFunc'
p514
S'extraParameters'
p515
tp516
sg23
(dp517
g508
(NNNtp518
sg509
(NNNtp519
sg507
(NNNtp520
sg511
(I1
S'1'
Ntp521
sg510
(NNNtp522
sg514
(I1
S'None'
Ntp523
sg512
(I1
S'1'
Ntp524
sg513
(I1
S'0'
Ntp525
sg515
(I1
S'{}'
Ntp526
ssg27
g28
sg29
S'Basic Documentation Set\n\n Parameters\n\n scanner -- A directory tree scanner.\n\n title -- the title of the documentation set\n\n outputDirectory -- The base directory for writing the\n output files.\n\n includeComments -- Boolean. False means to skip the\n comment parsing step in the parser.\n Default is True.\n \n includePrivateNames -- Boolean. False means to ignore\n names beginning with _. Default\n is True.\n\n sortNames=0 -- Boolean. True means to sort names before\n generating output. Default is False.\n\n statusMessageFunc -- function which will print a status\n message for the user\n \n extraParameters -- Dictionary containing parameters\n specified on the command line by\n the user.\n\n '
p527
sg31
g500
sg32
g393
sg33
g34
sg35
(dp528
sg37
g503
sg38
g504
sg39
S''
sbstp529
sg27
g28
sg29
S'Docset Parameters\n\n Pass parameters to the docset using the syntax:\n\n docset_<argument>=value\n\n Common parameters for all documentation sets\n\n includeComments -- Boolean. False means to skip the\n comment parsing step in the parser.\n Default is True.\n \n includePrivateNames -- Boolean. False means to ignore\n names beginning with _. Default\n is True.\n '
p530
sg306
(lp531
S'mimetype_writer_mapping'
p532
asg31
g392
sg32
g2
sg33
g34
sg310
(lp533
S'DocSetBase'
p534
asg35
(dp535
sg37
g395
sg38
g396
sg39
S''
sbs(dp536
tp537
sS'_import_info'
p538
(ihappydoclib.parseinfo.imports
ImportInfo
p539
(dp540
S'_named_imports'
p541
(dp542
sS'_straight_imports'
p543
(lp544
sbsg27
g28
sg29
S'"""Base classes for documentation sets.\n\n"""'
p545
sg31
S'base'
p546
sg32
Nsg33
g34
sg35
(dp547
S'include_comments'
p548
I1
sS'cacheFilePrefix'
p549
S'.happydoc.'
p550
sS'useCache'
p551
I1
sS'docStringFormat'
p552
S'StructuredText'
p553
ssg37
g5
sg38
g536
sg39
S''
sbt.
|