Documentation

Source code

The documentation generated by Doxygen is available here.

Generating documentation

Both doxygen and docbook documentation HTML are generated by going in the doc/ folder and using make doc. To generate only a part of the documentation, go in the corresponding folder and use make doc again. This will generate HTML documentation in docbook/user_manual for docbook and doxygen/pangolin_ref for Doxygen.

To upload the documentation online, copy the files on the server. An example is given in the Makefile for uploading the pages to a CERFACS personal webpage.

Warning

When uploading the HTML documentation to a server, it is important to preserve the directory structure, otherwise relative link fails. This means you must upload docbook/user_manual and doxygen/pangolin_ref as they are.

A PDF version of the documentation can be generated by running make pdf in the appropriate directory (doc/docbook or doc/doxygen). It will generate a single pdf named pangolin_manual.pdf or pangolin_ref.pdf. To generate the pdf with doxygen, you must be able to use pdflatex. To customize this command, edit doxygen/Makefile as needed.