Building Documentation

The main documentation and Python documentation is written in reStructuredText and generated by sphinx. The C++ API documentation is generated by Doxygen.

Prerequisites

1. Build FastGA from source

Clone and build FastGA from source.

2. Install Sphinx

# For pip
pip install sphinx sphinx-autobuild

# Or, for Conda
conda install sphinx sphinx-autobuild

3. Install Doxygen

Ubuntu

sudo apt-get -y install doxygen

macOS

brew install doxygen

Windows

Visit Doxygen downloads page to checkout the source or binaries.

Build

cd docs

# You may optionally select the --sphinx flag
python make_docs.py --sphinx

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