Building Documentation

We use Sphinx with the Book Theme for maintaining the documentation.

Note: To build the documentation, we recommend creating a virtual environment to avoid any conflicts with system installed dependencies.

Execute the following instructions to build the documentation (assumed from the top of the repository):

1. Install the dependencies for Sphinx:

   # enter the location where this readme exists
   cd docs
   # install dependencies
   pip install -r requirements.txt

2. Generate the documentation file via:

   # make the html version
   make html

3. The documentation is now available at docs/_build/html/index.html:

   # open on default browser
   xdg-open _build/html/index.html