Compiling the documentation

The documentation is written using doxygen for c++, sphinx for python, and breathe to tie them together. It yields this

Pre-requisites

Installing doxygen

• Linux: apt-get, yum, or other package manager
• Mac: brew install doxygen
• Windows: binaries can be found here

Installing Sphinx

• Linux: apt-get, yum, or pip (same as Mac)
• Mac: pip install sphinx
• Windows: Depending on your setup
  • conda.bat install sphinx
  • or, pip install sphinx

Installing Breathe

In all cases, do pip install Breathe

Installing Sphinx plugin for citation

sphinxcontrib.bibtext makes it possible to use a bibtex file, documentation/source/bibliography.bib, to hold reference to papers. It can be installed with pip install sphinxcontrib-bibtex

NOTE: On Mac, with python2.7 installed from brew, I've had to add an empty __init__.py file in site-packages/sphinxcontrib for its bibtex subpackage to be found.