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 SimplifyLine from source

Clone and build SimplifyLine from source.

2. Instal Dev Requirements

# For pip
pip install -r dev-requirements.txt

# install binary dependencies
conda install -c conda-forge pandoc doxygen

Build

cd src_docs

python make_docs.py

The docs html will be saved in docs/ folder.