NAME
pudge - Generate documentation for Python projects
SYNOPSIS
pudge [OPTIONS]
DESCRIPTION
This manual page documents briefly the pudge command.
Its highlights are:
* Generate documentation for Python packages, modules, classes,
functions, and methods.
* Module and Class index hierarchies
* Support for Restructured Text in docstrings
* Easily apply common free documentation licenses (GNU, CC)
* Syntax colored source HTML generation with anchors for line numbers
* 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
OPTIONS
-d, --dest=DIR
Directory where documentation should be generated.
-i, --documents=FILE...
Comma seperated list of files
-c, --title=TEXT
The title of the documentation set. This is used in various
places in generated documentation and defaults to "Module
Reference". If you include a document named "index", the title
from that document is used.
-f, --force
Force creation of documentation files even if source files are
older or the same age.
--license=NAME Include a standard license document. Current options
are "gnu" for the GNU Free Documentation License and "cc" for a
Creative Commons Attribution, NonCommercial, Copyleft license.
-x, --xhtml
Generate XHTML 1.0 instead of HTML 4.01. HTML 4.01 is the
default due to browser compatibility issues with XHTML 1.0.
-e, --ext=TEXT
The file extension to use when writing (X)HTML files. The
default is ’.html’
--stages=LIST
Specify the list of stages that should be performed. This
allows only portions of the generation to take place. Available
stages are: copy, docs, reference, index, and source.
-t, --templates=.. The directory where we should look for templates.
See
the ’pudge.templates’ package directory for the default template
set.
--theme=NAME
The name of a built-in theme (overrides --templates).
--trac=URL
Adds navigational links to a Trac site.
-v, --verbose
Verbose output.
-q, --quiet
Shutup unless something important happens.
-h, --help
print this help screen.
EXAMPLES
Generate documentation for ’foo’ to current directory:
$ pudge -m foo
Generate documentation for ’foo’ module/package and two documents to
’build/doc’:
$ pudge --modules=foo
--documents=docs/guide.rst,docs/reference.rst --dest=build/doc
Generate documentation for the ’foo’ module/package and license the
work under the GNU Free Documentation License:
$ pudge --license=gnu --modules=foo
AUTHOR
pudge was written by Ryan Tomayko <rtomayko@gmail.com>.
This manual page was written by Piotr Ozarowski <piotr@debian.org>, for
the Debian project (but may be used by others).
September 2007