Building the project documentation

Building documentation with `Sphinx`

Documentation in RST format throughout the code can be exported to HTML as described below.

Prerequisites:

First install the required Python modules:

pip install -r requirements.txt

and then build the documentation calling:

make html

Using the settings file doc/Doxyfile, Doxygen will generate documentation from formatted comments in C/C++ code in the subdirectories...

by running the following in the doc directory...

doxygen Doxyfile

The entry point html file is found at doc/doxygenOut/html/index.html