HappyDoc Generated Documentation HappyDoc3-r3_1/happydoclib

HappyDoc3-r3_1 / happydoclib 

HappyDoc Components

The happydoclib library can be used to create a variety of programs which can process source files and extract documentation.

Classes   
Python files   

CommandLineApp.py

Base class for building command line applications.

appclass.py

Command line application class for HappyDoc.

cvsignore.py

Class to encapsulate the .cvsignore logic.

cvsversion.py

Get the CVS version information based on the $Name: r3_1 $ token.

happydocstring.py

Base class for docstring converters.

optiontools.py

Functions for handling options and arguments.

packagetree.py

Tree representing the input data.

pluginloader.py

Define a class to handle pluggable module loading.

scanner.py

Scanner for Python source files.

status.py

Module interface for providing status messages to the user.

sysmodules.py

Utilities for working with Python system modules.

test_cvsignore.py

Test the cvsignore module.

test_packagetree.py

Tests for packagetree module.

test_scanner.py

Tests for the scanner module.

tests.py

Tests for HappyDoc.

trace.py

A debugging trace module.

utils.py

Utility functions which do not seem to fit elsewhere.

Subdirectories   

docset

Documentation Sets

docstring

Python docstring converter plugins.

parseinfo

Extract information from a Python code parse tree.

parsers

Parser plugins.


This document was automatically generated Tue Dec 5 08:30:26 2006 by HappyDoc version 3.1