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, or easy_install Breathe. On windows, it might first be necessary to install the pip package via conda.

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.

Compiling the Documentation

The code must be installed and accessible before trying to compile the documentation, at least when the python bindings are compiled. This means:

1. The library is in the PATH (windows), DYLD_LIBRARY_PATH (Mac), or the LD_LIBRARY_PATH (Linux)
2. The python bindings are in the PYTHONPATH (e.g. python -c "import dcprogs.likelihood" does not fail)

The reason for this is that python documentation software will interrogate the package to find out what it contains. Hence the package needs to be available and loadable. Please refer to the wiki for instructions on installing DCProgs.