Developing Akara Docs

Quick start with Sphinx

Sphinx is the official document processor for Python itself and many Python projects. e.g. see http://docs.python.org/. Following to set up Sphinx to automatically generate documentation for a project:

cd dev/project
mkdir doc; cd doc
sphinx-quickstart

Answer the questions (the defaults are fine, except be sure to say ‘yes’ to the autodoc extension). Then, edit the generated index.rst file to add this:

.. automodule:: projectname

This is the place to put any extra documentation that’s not in your docstrings. Be sure to put index.rst and Sphinx’ conf.py under version control:

svn add index.rst conf.py

You can generate your documentation by running sphinx-build in the doc/ directory:

sphinx-build . html/

(You will need to have the module in your PYTHONPATH for this to work.)

This will put the HTML documentation in doc/html/

Some bits taken from http://infinitemonkeycorps.net/docs/pph/ , though for the most part Akara doesn't go along with that resource