HappyDoc Source Documentation: happydoclib

Documentation Sets

The documentation set, or docset, defines the structure of the collected documentation being generated. All aspects of the structure are left up to the docset. Whether to use multiple or a single file, a file or a database, and what specific metadata to include in the output is left up to the docset. The docset drives the documentation generation using controls available from the formatter.

Modules and Packages

HappyDoc-r2_1/happydoclib/

CommandLineApp	Base class for building command line applications.
StreamFlushTest	Wrapper to control stdout and stderr for a TestCase.
happydoclib	HappyDoc Components
appclass	Command line application class for HappyDoc.
cvsversion	Get the CVS version information based on the $Name: r2_1 $ token.
docset	Documentation Sets
docstring	Python docstring converter plugins.
formatter	Output Formatters
happydocset	Base for docsets.
happydocstring	Base class for docstring converters.
happydom	Base class for accessing documentation extracted from inputs.
happyformatter	Base class for formatting info generated by parseinfo classes.
indentstring	Function to indent the lines of a string using a standard indent spacing.
optiontools	Functions for handling options and arguments.
parsecomments	Parse comment information from a module.
parseinfo	Extract information from a Python code parse tree.
path	Provide a common set of path management functions.
pluginloader	Define a class to handle pluggable module loading.
prettyast	Pretty print the AST for a .py file.
trace	A debugging trace module.

Table of Contents

This document was automatically generated on Sat Aug 24 16:57:23 2002 by HappyDoc version 2.1