![(please configure the [header_logo] section in trac.ini)](/tropflux/chrome/site/your_project_logo.png){kind=logo}
source:
trunk/docs/docs_dev/source/guides/builddoc.rst
@
205
| Last change on this file since 205 was 205, checked in by pinsard, 10 years ago | |
|---|---|
|
|
| File size: 2.8 KB | |
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 TROPFLUX
La documentation est construite à partir des fichiers ReStructuredText dans :file:`${PROJECT}/adm/` et des commentaires dans les sources sous :file:`${PROJECT}/src/`.
Sphinx est utilisé pour produire la documentation sous forme HTML:
cd ${PROJECT}/adm/ make clean make before make html_dev_sphinx
et regarder le résultat dans :file:`../doc/html/index.html`.
(bientôt) 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:`${PROJECT}/adm/website`.
Sphinx est utilisé pour produire la documentation sous forme HTML:
cd ${PROJECT}/adm/
make clean
make html
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/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:
make install_all
