Documentation TROPFLUX

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

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

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

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

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

$ make all_dev

Website TROPFLUX

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

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

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

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

Install Documentation TROPFLUX

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 est réservée à Françoise Pinsard pour des raisons de protections de fichiers et de politique de login.

L'installation se fait ainsi:

$ make install_all