Overview

Pudge is a documentation system for Python projects.

• Generate documentation for Python packages, modules, classes, functions, and methods.
• Module and Class index hierarchies (hierarchy example)
• Support for Restructured Text in docstrings.
• Easily apply common free documentation licenses (GNU, CC).
• Syntax colored source HTML generation with anchors for line numbers (source example).
• Generated reference documents link to source for all modules, classes, functions, and methods.
• Basic Restructured Text document templating (brings external documents into the flow of generated pages).
• Support for HTML 4.01 or XHTML 1.0 output.
• Basic Trac integration (adds Trac project links to navigational elements).
• Uses a combination of runtime inspection and Python source code scanning.
• Extensible and customizable using kid templates.

Status

Pudge is currently under heavy development. We're still adding features and breaking stuff.

Right now Pudge provides the glue that holds the various pieces of this site together. Once things come together a bit more there will be normal releases and distributables.

If you'd like to take an early peek, you can grab the latest sources using subversion:

svn co svn://lesscode.org/pudge/trunk pudge

Pudge news, articles, and ramblings are posted to the lesscode.org blog tagged with pudge.