source: trunk/docs/manual/source/developers/guides/builddoc.rst @ 10

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

add build doc procedure

File size: 928 bytes

Build documentation

Documentation is based on :

All these inputs files have to be checked : typo free, expected results, ...

cf. coding rules ++ lint

|sphinx| is used to produce HTML and PDF files.

?
.. todo::
   These files are shipped with distribution ++.
cd ${PROJECT}/docs/manual/
make clean
make html
make linkcheck

Check if no broken links are identified by this last command.

Check the HTML result by opening a browser on the main entry file:

xdg-open _build/html/index.html &

Check by opening the PDF file

xdg-open _build/latex/igcmg_doc.pdf &

Next step

?
.. todo:: decide URI, authorized people, etc.
   cf. :ref:`installdoc`

Docutils System Messages

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