Table of Contents

Class: HappyDoc HappyDoc-r0_7_1/happydoc_class.py

HappyDoc is a documentation generation/extraction tool which does not depend on being able to import modules.

This app is based on the Demos/parser/example.py module distributed with the Python source distribution.

Base Classes   
CommandLineApp
Methods   
appInit
getDocsetDescription
getFileInfo
getParameters
main
mkdir
optionHandler_F
optionHandler_T
optionHandler_author
optionHandler_d
optionHandler_o
optionHandler_p
optionHandler_r
optionHandler_t
processFiles
set_docset_type
set_format
showVerboseSyntaxHelp
  appInit 
appInit ( self )

  getDocsetDescription 
getDocsetDescription ( self,  candidateFileName )

Get the description from the docset README file.

If the candidateFileName file does not exist, returns an empty string.

  getFileInfo 
getFileInfo ( self,  fileName )

Parse the file and return the parseinfo instance for it.

  getParameters 
getParameters (
        self,
        prefix,
        args,
        prefixSeparator='_',
        )

Find parameter settings in an argument sequence.

What we're going to return

Local variables are faster to access

Process candidates

Check that this is a parameter

Check that this is our parameter

Handle the parameter, it's ours.

  main 
main ( self,  *args )

Find DocSet arguments

Find Formatter parameters

Get the list of modules to input

Create output directory

Get the general description text

Create the docset

Process the files and populate the docset

Tell the docset to output its results

  mkdir 
mkdir ( self,  fullname )

Make output directory as specified by path.

This function assumes that path begins at the top of the filesystem and contains a completely specified pathname. The path is made recursively, so all parent directories which do not exist should be created.

  optionHandler_F 
optionHandler_F ( self,  format )

Specify the output format.

  optionHandler_T 
optionHandler_T ( self,  docset_type )

Specify the documentation set type.

  optionHandler_author 
optionHandler_author ( self,  authorNameAndEmail )

Specify the author identification to be inserted for references.

  optionHandler_d 
optionHandler_d ( self,  outputDirectory )

Specify an outputDirectory.

  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.

  processFiles 
processFiles (
        self,
        parsedModules,
        fileNames,
        useRecursion=1,
        moduleFileName=re.compile( r'^.*\.py$' ),
        IgnoreDirName=re.compile( r'^.*/(CVS|dist)$' ),
        )

Process a list of files.

Find modules and directories within to recurse.

  set_docset_type 
set_docset_type ( self,  docset_type )

Exceptions   
ValueError( 'docset_type must be one of %s' % self.supported_docset_types.keys(), docset_type )

  set_format 
set_format ( self,  format )

Exceptions   
ValueError( 'format must be one of %s' % self.supported_formats.keys(), format )

  showVerboseSyntaxHelp 
showVerboseSyntaxHelp ( self )

Overloaded to show supported docset and format types.


Table of Contents

This document was automatically generated on Sat Sep 9 20:27:32 2000 by HappyDoc version r0_7_1