HappyDoc is a documentation generation/extraction tool which does
not depend on being able to import modules.
The data extraction library used by this app is based on the
Demos/parser/example.py module distributed with the Python source
distribution.
|
Methods
|
|
|
|
|
|
_showOptionItemsDescription
|
_showOptionItemsDescription (
self,
title,
items,
)
|
|
|
addIgnoreDirectoryPattern
|
addIgnoreDirectoryPattern ( self, *dirNamePatterns )
Add one or more directory name patterns to the list which should be ignored.
|
|
|
appInit
|
appInit ( self )
|
|
|
ignoreDirectoryTest
|
ignoreDirectoryTest ( self, dirName )
Determines whether dirName matches pattern to be ignored.
Arguments
-
dirName
- Full path of the directory to be tested.
Returns true value if dirName should be ignored, false value
otherwise.
|
|
|
main
|
main ( self, *args )
|
Exceptions
|
|
self.HelpRequested, 'No input file(s) specified.'
|
|
|
|
optionHandler_F
|
optionHandler_F ( self, format )
Specify the output format.
Defaults to HTMLTable.
|
|
|
optionHandler_T
|
optionHandler_T ( self, docset_type )
Specify the documentation set type.
Defaults to multifile_docset.
|
|
|
optionHandler_author
|
optionHandler_author ( self, authorNameAndEmail )
Specify the author identification to be inserted for
references.
|
|
|
optionHandler_d
|
optionHandler_d ( self, outputDirectory )
Specify an outputDirectory.
Defaults to ./doc.
|
|
|
optionHandler_dia
|
optionHandler_dia ( self )
Generate UML diagram in Gnome dia format.
|
|
|
optionHandler_i
|
optionHandler_i ( self, ignoreDirectory )
Specify a directory basename to be ignored.
Use just the base name of the directory.
For instance, to ignore all directories
with the name CVS, specify: -i CVS.
Defaults to ignore:
CVS, dist, build, doc, docs.
|
|
|
optionHandler_no_comments
|
optionHandler_no_comments ( self )
Do not include comment text as though it was
a __doc__ string.
|
|
|
optionHandler_no_private_names
|
optionHandler_no_private_names ( self )
Do not include names beginning with _.
|
|
|
optionHandler_o
|
optionHandler_o ( self )
Specify that output should go to stdout.
|
|
|
optionHandler_p
|
optionHandler_p ( self, packageDescriptionFile )
Specify a file with a description of the package.
The default packageDescriptionFile is README.txt.
|
|
|
optionHandler_r
|
optionHandler_r ( self )
Disable recursion into subdirectories.
|
|
|
optionHandler_t
|
optionHandler_t ( self, title )
Specify a title for the documentation set.
|
|
|
set_docset_type
|
set_docset_type ( self, docset_type )
Set the docset to be used.
|
Exceptions
|
|
ValueError( 'docset_type must be one of %s' % self.supported_docset_types.keys(), docset_type )
|
|
|
|
set_format
|
set_format ( self, format )
Set the formatter to be used.
|
Exceptions
|
|
ValueError( 'format must be one of %s' % self.supported_formats.keys(), format )
|
|
|
|
showVerboseSyntaxHelp
|
showVerboseSyntaxHelp ( self )
Overloaded to show supported docset and format types.
|