Documentation generation
========================

HTML documentation
------------------

The Nagare documentation is written in
the `reStrucuturedText <http://docutils.sourceforge.net/rst.html>`_ format.

If you want it in HTML, first do a developer installation as described in
:wiki:`NagareInstallation#developers-framework-installation`, then go to the
``nagare/core`` directory and enter the command:

.. code-block:: sh

   <NAGARE_HOME>/bin/python setup.py generate_html docs/*.txt

The HTML documentation is generated into the ``nagare/core/docs/html`` directory.

API documentation
-----------------

If you want an HTML extraction of the Nagare classes and API, first do a
developer installation as described in
:wiki:`NagareInstallation#developers-framework-installation`, then go to the
``nagare/core`` directory and enter the command:

.. code-block:: sh

   <NAGARE_HOME>/bin/python setup.py generate_api

The HTML documentation is generated into the ``nagare/core/docs/api`` directory
(start with the ``index.html`` file).

.. wikiname: DocumentationGeneration



