source: trunk/adm/guides/builddoc.rst @ 154

.. +
..
.. DESCRIPTION
.. ===========
..
.. procedure to build and install doc
..
.. TODO
.. =====
..
.. translation
..
.. doxygen
..
.. wiki
..
.. checklink
..
.. PDF pas encore diffusé car pb numérotation exotique par sphinx de graphiques
..
.. EVOLUTIONS
.. ==========
..
.. $Id$
..
.. $URL$
..
.. - fplod 20120223
..
..   * replace $TROPFLUX by $PROJECT
..   * add a ref to profile_project.sh
..
.. - fplod 20120209
..
..   * as this file is know cited in index_guide.rst, change section levels
..
.. - fplod 20110628T133328Z aedon.locean-ipsl.upmc.fr (Darwin)
..
..   * add instruction for website processing
..
.. - fplod 20110628T132733Z aedon.locean-ipsl.upmc.fr (Darwin)
..
..   * add instruction for website
..
.. - fplod 20101220T114850Z aedon.locean-ipsl.upmc.fr (Darwin)
..
..   * creation
.. -

.. |project| replace:: TROPFLUX
.. |project_id| replace:: tropflux

.. _builddoc:

Build Documentation
===================

You will find here
how to build HTML, PDF and troff versions of documentations.

.. note::

   Please refer to :ref:`project_profile.sh` to know how :envvar:`PROJECT` must
   be defined

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:

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

.. parsed-literal::

   $ cd ${PROJECT}/adm/
   $ make clean
   $ make before
   $ make html_dev_sphinx

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

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

.. parsed-literal::

   $ make all_dev

Website |project|
-----------------

La documentation est construite à partir des fichiers ReStructuredText_
dans :file:`${PROJECT}/adm/website`.

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

.. parsed-literal::

   $ cd ${PROJECT}/adm/
   $ make clean
   $ make before
   $ make html_user

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

Install Documentation |project|
-------------------------------

La mise à disposition des documentations produites ci-dessus sur l'URL
http://www.locean-ipsl.upmc.fr/~fplod/tropflux/tropflux_ws/doc/html/sphinx/index.html et sur l'URL http://www.locean-ipsl.upmc.fr/tropflux/
est réservée à Françoise Pinsard pour des raisons de protections de fichiers et
de politique de login.

L'installation se fait ainsi:

.. parsed-literal::

   $ make install_all