.. +
..
.. TODO
.. =====
..
.. translation
..
.. doxygen
..
.. idldoc
..
.. wiki
..
.. checklink
..
.. EVOLUTIONS
.. ==========
..
.. $Id$
..
.. $URL$
..
.. - fplod 20140729T100347Z callisto.locean-ipsl.upmc.fr (Linux)
..
..   * suppression références page perso fplod
..
.. - fplod 20100830T134840Z aedon.locean-ipsl.upmc.fr (Darwin)
..
..   * usage of parsed-literal
..   * inform on restriction for websites update (reserved to fplod)
..
.. - fplod 20100603T081607Z aedon.locean-ipsl.upmc.fr (Darwin)
..
..   * migration de varamma_doc.xml
..
.. -

.. |project| replace:: VARAMMA
.. |project_id| replace:: varamma

.. _builddoc:

Build Documentation
-------------------

Documentation |project|
~~~~~~~~~~~~~~~~~~~~~~~

La documentation est construite à partir des fichiers reStructuredText_
dans :file:`${PROJECT}/adm/` et des commentaires dans les sources
sous :file:`${PROJECT}/src/`.

.. _reStructuredText: http://docutils.sourceforge.net/rst.html

Sphinx_ est utilisé pour produire la documentation sous forme HTML et PDF:

.. _Sphinx: http://sphinx.pocoo.org/

.. parsed-literal::

   cd ${|project|}/adm/
   make clean
   make before
   make html_dev

et regarder le résultat dans :file:`../doc/html/index.html`.

Si le résultat est convainquant, on peut produire les autres formats de
documentations (HTML single, PDF et troff):

.. parsed-literal::

   make all