.. -*- coding: utf-8 -*-

===============================
 Generation of Developer Manual 
===============================

The generation of the developer manual relies on on the `Sphinx` tool.
Currently, it works fine with the 0.6.4 version of Sphinx.

Generating the html manual with Sphinx
--------------------------------------

To generate the HTML Developer Manual, just use ``make``::

 $ make clean
 $ make html

All the generated documentation is in ``_build/html``.

Generating the manual in other formats
--------------------------------------

If you type ``make``, you will see a help message showing the various 
documentation formats that can be generated with Sphinx. For example,
``make latex`` will produce the documentation in LaTeX format, that can 
then be transformed in PDF.
