How to build the distribution locally for testing
As the docs are .rst files that have to be built into HTML to be viewed, it is very useful to be able to build the docs locally to see what the HTML will look like. Sphinx uses Python, so you must have it installed. First, navigate to the ``docs`` directory of the repository, then you can then simply run (recommended in a virtual environment):
pip install -r requirements.txt
to install the required python packages. Followed by:
make html
in the same directory to create the html files in the docs/_build directory.
Simply open docs/_build/html/index.html with a web browser to see your local version of the docs.