Building Documentation

The main documentation and Python documentation is written in reStructuredText and generated by sphinx. The C++ API documentation is generated by Doxygen with help from breathe/exhale plugins. We also include the ability to write documentation in markdown or by using juypter notebooks.

Prerequisites

1. Build LuPNT from source

Clone and build LuPNT from source.

2. Instal Dev Requirements

cd docs

# Install python requirements
pip install -r requirements.txt

# Install dependencies
sudo apt-get install doxygen pandoc # (Linux)
brew install doxygen pandoc # (Mac)

# Make docs
python make_docs.py

The docs html will be saved in build/docs folder.