Frequently Asked Questions

Building this documentation

Sphinx

Sphinx is a tool that makes it easy to create intelligent and beautiful documentation, written by Georg Brandl and licensed under the BSD license.

Sphinx can be installed using:

  • Debian/Ubuntu: Install Sphinx using packaging system:

    apt-get install python-sphinx
    
  • Mac OS X: Install Sphinx using MacPorts:

    sudo port install py27-sphinx
    

Note

make sure to have the version 1.5 at least. This is needed for the Tikz extension.

Sphinx extensions

The following python packages are to be installed:

sudo pip install sphinxcontrib-bibtex

sudo pip install graphviz

sudo pip install sphinxcontrib-tikz

Before building your documentation, you need to initiliaze it by running:

python initialize.py

This will copy the examples from clapp/examples/django_examples.

Then you can build the documentation using:

make html

or to generate the pdf file:

make latexpdf