/ HappyDoc3-r3_1 / happydoclib / appclass.py / HappyDoc
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
|
|
|
main
|
main ( self, *args )
Exceptions
|
|
self.HelpRequested, 'No input file(s) specified.'
|
|
|
_showOptionItemsDescription
|
_showOptionItemsDescription (
self,
title,
items,
)
|
|
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 )
|
|
|
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|docs?|.*pyc|.*~|tmp)$
trace.txt
|
|
optionHandler_no_cache
|
optionHandler_no_cache ( self )
Disable caching of parse results.
|
|
optionHandler_d
|
optionHandler_d ( self, outputDirectory )
Specify an outputDirectory.
Defaults to ./doc .
|
|
optionHandler_T
|
optionHandler_T ( self, docset_type )
Specify the documentation set type.
Defaults to MultiHTMLFile .
|
|
optionHandler_t
|
optionHandler_t ( self, template_name )
The name of the template set.
The value is expected to correspond to the name of a directory
containing a template set. If the path exists, it will be
used. If it does not exist, HappyDoc will look for a
directory with the same name in happydoclib/templates .
|
|
optionHandler_no_comments
|
optionHandler_no_comments ( self )
Do not include comment text as though it was
a __doc__ string.
|
|
optionHandler_title
|
optionHandler_title ( self, title )
Specify a title for the documentation set.
|
|
optionHandler_template_path
|
optionHandler_template_path ( self, template_path_directory )
Set the parent directory of the template directory.
|
|
showVerboseSyntaxHelp
|
showVerboseSyntaxHelp ( self )
Overloaded to show supported docset types.
|
|
getParameterGroupsFromArguments
|
getParameterGroupsFromArguments ( self, args )
|
|
addMimetype
|
addMimetype (
self,
extension,
mimetypeSpec,
)
|
|
addIgnoreDirectoryPattern
|
addIgnoreDirectoryPattern ( self, *dirNamePatterns )
Add one or more directory name patterns to the list which should be ignored.
|
|
optionHandler_no_private_names
|
optionHandler_no_private_names ( self )
Do not include names beginning with _.
|
|
optionHandler_mimetype
|
optionHandler_mimetype ( self, extensionAndMimetype )
Specify a filename extension and mimetype mapping.
This is useful if input files are named in a way that the
Python mimetypes module cannot determine their mimetype
automatically.
For example:
--mimetype stx=text/x-structured
--mimetype .gif=image/gif
Exceptions
|
|
ValueError( 'Could not understand "%s". Use --mimetype "ext=mimetype"' % extensionAndMimetype )
|
|
|
optionHandler_cache_prefix
|
optionHandler_cache_prefix ( self, cacheFilePrefix )
Set the prefix of parse cache files.
Defaults to .happydoc.
|
|
|