docs

Documentation

Using Sphinx to generate HTML documentation and the following Sphinx extensions:

• AutoDoc for pulling in documentation from docstrings in a semi-automatic way.
• Napoleon to support NumPy and Google style docstrings

Prerequisites

Install sphinx

Building the Docs

make clean ; make html

HTML output will be in _build/html

Locally Hosting Docs for Testing

After build, to host locally on a dev machine:

cd _build/html
python3 -m http.server

Navigate to http://localhost:8000/ in a browser