.happydoc.__init__.py :  » Development » HappyDoc » HappyDoc3-r3_1 » happydoclib » docstring » 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 » .happydoc.__init__.py
(S'70c905f6ade83cb67b90bca17cb87edd'
p1
(ihappydoclib.parseinfo.moduleinfo
ModuleInfo
p2
(dp3
S'_namespaces'
p4
((dp5
S'DocStringLoaderSingleton'
p6
(ihappydoclib.parseinfo.classinfo
ClassInfo
p7
(dp8
g4
((dp9
(dp10
S'addEntryPoint'
p11
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p12
(dp13
g4
((dp14
(dp15
tp16
sS'_exception_info'
p17
(dp18
sS'_parameter_names'
p19
(S'self'
p20
S'infoDict'
p21
tp22
sS'_parameter_info'
p23
(dp24
g20
(NNNtp25
sg21
(NNNtp26
ssS'_filename'
p27
S'../HappyDoc3-r3_1/happydoclib/docstring/__init__.py'
p28
sS'_docstring'
p29
S'Add the information about a converter to our lookup table.'
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'__init__'
p40
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p41
(dp42
g4
((dp43
(dp44
tp45
sg17
(dp46
sg19
(S'self'
p47
tp48
sg23
(dp49
g47
(NNNtp50
ssg27
g28
sg29
S''
sg31
g40
sg32
g7
sg33
g34
sg35
(dp51
sg37
g43
sg38
g44
sg39
S''
sbsS'getConverterNameForFile'
p52
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p53
(dp54
g4
((dp55
(dp56
tp57
sg17
(dp58
sg19
(S'self'
p59
S'filename'
p60
S'default'
p61
tp62
sg23
(dp63
g61
(I1
S"'PlainText'"
Ntp64
sg59
(NNNtp65
sg60
(NNNtp66
ssg27
g28
sg29
S'Return the name of the docstring converter for the file specified.'
p67
sg31
g52
sg32
g7
sg33
g34
sg35
(dp68
sg37
g55
sg38
g56
sg39
S''
sbstp69
sg27
g28
sg29
S'Load pluggable docstring converters.'
p70
sS'_class_member_info'
p71
(lp72
sg31
g6
sg32
g2
sg33
g34
sS'_base_class_info'
p73
(lp74
S'happydoclib.pluginloader.PluginLoader'
p75
asg35
(dp76
sg37
g9
sg38
g10
sg39
S''
sbs(dp77
S'getConverterFactory'
p78
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p79
(dp80
g4
((dp81
(dp82
tp83
sg17
(dp84
S'ValueError( \'Unrecognized docstring format type "%s"\' % formatType )'
p85
Nssg19
(S'formatType'
p86
tp87
sg23
(dp88
g86
(NNNtp89
ssg27
g28
sg29
S"Returns the factory for a docstring converter for 'formatType' text.\n\n    Parameters:\n\n      'formatType' -- A string representing the name of the input text\n      type.  If this string does not match a registered docstring\n      converter input format, a ValueError exception will be raised.\n\n    "
p90
sg31
g78
sg32
g2
sg33
g34
sg35
(dp91
sg37
g81
sg38
g82
sg39
S''
sbsS'DocStringLoader'
p92
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p93
(dp94
g4
((dp95
(dp96
tp97
sg17
(dp98
sg19
(tsg23
(dp99
sg27
g28
sg29
S''
sg31
g92
sg32
g2
sg33
g34
sg35
(dp100
sg37
g95
sg38
g96
sg39
S''
sbsS'getConverterFactoryForFile'
p101
(ihappydoclib.parseinfo.functioninfo
FunctionInfo
p102
(dp103
g4
((dp104
(dp105
tp106
sg17
(dp107
sg19
(S'filename'
p108
tp109
sg23
(dp110
g108
(NNNtp111
ssg27
g28
sg29
S"Returns the  factory for a docstring converter for an external file.\n\n    Parameters:\n\n      'filename' -- The name of the external file to be examined.\n    \n    "
p112
sg31
g101
sg32
g2
sg33
g34
sg35
(dp113
sg37
g104
sg38
g105
sg39
S''
sbstp114
sS'_import_info'
p115
(ihappydoclib.parseinfo.imports
ImportInfo
p116
(dp117
S'_named_imports'
p118
(dp119
sS'_straight_imports'
p120
(lp121
sbsg27
g28
sg29
S'"""Python docstring converter plugins.\n\n    *How does an author write documentation so that it will be marked\n    up and look fancy?* This is a perennial question for\n    "Python":http://www.python.org users, and seems to have introduced\n    a roadblock into the development of more robust and useful\n    documentation tools.  HappyDoc stands firmly on the fence and does\n    not attempt to resolve the issue.\n\n    By separating the docstring converter and formatter classes from\n    the docset classes, HappyDoc allows a user to create their own\n    converter and formatter to interpret comments in any way they see\n    fit.\n\n    The docstring converter plugins are responsible for translating\n    text from the input markup syntax to the output format.  This\n    translation is formatter independent, so that the same HTML\n    conversion might be used by mutliple HTML formatters.  It is,\n    however, *format* dependent, so that HTML output should not be\n    used by a plain text formatter.\n\n    The default for the \'HTMLTableFormatter\' (the default formatter\n    for HappyDoc) is to treat \'__doc__\' strings as\n    "StructuredTextNG":http://www.zope.org//Members/jim/StructuredTextWiki/StructuredTextNGRules.\n    This is the "Next Generation" version of the original\n    "StructuredText":http://www.python.org/sigs/doc-sig/stext.html\n    markup syntax.  See also the \'StructuredText\' package for a\n    description of the rules for using StructuredText.\n\n    *Don\'t like StructuredText?* Write your own docstring converter\n    that uses something different and drop it into place.  Refer to\n    the \'happydocstring.py\' module for the base class and APIs\n    required of a docstring converter.  If a defacto (or otherwise)\n    standard structured markup for Python \'__doc__\' strings emerges,\n    HappyDoc will be updated to use that format by default.\n\n"""'
p122
sg31
S'__init__'
p123
sg32
Nsg33
g34
sg35
(dp124
S'include_comments'
p125
I1
sS'cacheFilePrefix'
p126
S'.happydoc.'
p127
sS'useCache'
p128
I1
sS'docStringFormat'
p129
S'StructuredText'
p130
ssg37
g5
sg38
g77
sg39
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.