LBPM/docs/README.md

Dependencies for LBPM documentation

# install sphinx
pip install Sphinx

# foamatting requires sphinx read-the-docs-theme
pip install sphinx-rtd-theme

# support for doxygen requires breathe
pip install breathe

# equation rendering requires latex and dvipng command
sudo apt-get install dvipng
sudo apt-get install texlive texstudio
sudo apt-get install texlive-latex-recommended texlive-pictures texlive-latex-extra

# To build the docs
Step 1) install dependencies listed above
Step 2) build LBPM with doxygen support enabled in CMake
Step 3) From the build directory run the command 'make doc' to build html and xml from doxygen
Step 4) modify source/conf.py so that the breathe directory specifies the full path to the xml
        documentation built in Step 3
Step 5) type 'make html' from the docs/ directory (the same directory that contains this README file)
Step 6) point your browser at ~/local/doc/build/html/index.html
#