Documentation

To build documentation

1. Install dependent packages using

   pip install -r docs/requirements.txt
   

2. Trigger a build using the Makefile located under the docs directory

   cd docs
   make html
   

   Tip

   To fail the documentation on warnings with traceback use

   make SPHINXOPTS=-WT html
   

3. Access the documentation by opening the _build/index.html in a web-browser