source: trunk/docs/docs_dev/source/guides/builddoc.rst

Last change on this file was 645, checked in by pinsard, 10 years ago

suppression reference page perso fplod pour les docs
  • Property mime-type set to text/x-rst
File size: 1.3 KB

Build Documentation

Documentation VARAMMA

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 et PDF:

cd ${VARAMMA}/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):

make all
Note: See TracBrowser for help on using the repository browser.