lesscode.org

pudge

Pudge package.

The pudge.generator.Generator class can be used to generate Python documentation:

from pudge.generator import Generator
generator = Generator()
generator.title = 'Foo Documentation'
generator.license = 'gnu'
generator.dest_dir = '/tmp/documentation'
generator.modules = ['foo']
generator()

This package contains modules for generating documentation from Python source code. The pudge.generator.Generator class uses the peruser and scanner modules to inspect a package/module hierarchy, the colorizer and rst modules to generate HTML files and fragments.

Attributes

a __url__

'$URL: svn://lesscode.org/pudge/trunk/pudge/__init__.py $'

Modules

The pudge module exposes 7 submodules:

browser
cli
Command line interface.
colorizer
Python source code colorizer.
generator
Generate Python documentation and other stuff.
log
A simple log mechanism styled after PEP 282.
rst
Restructured Text Support Module
scanner
A rudamentary Python source code scanner.

See the source for more information.