Producing this documentation

This documentation is written in reStructuredText and produced using Sphinx. The documentation source should be fairly readable without processing, but you can compile the documentation into assorted output formats using Sphinx.

Installing sphinx

You’ll need to install Sphinx (if it isn’t already installed on your system):

$ easy_install Sphinx

Building the documentation

To build the documentation, run:

$ make html

in this directory, which will generate static HTML in _build/html. Browse to _build/html/index.html to get the title page.

Sphinx can also generate a number of other formats. Run:

$ make

to get a complete list.

Writing the documentation

See the reStructuredText quick reference for an introduction to the documentation syntax.