Project documentation is built using Sphinx docs, which uses ReST for markup. This allows the docs to cover a vast amount of topics without using a thousand-line README file.

Sphinx docs is pip-installable via python3.7 -m pip install sphinx. Once installed, open a command line in the docs folder and run the following commands:

sudo python3.7 -m pip install -r requirements.txt

This will install the requirements needed for the generating the docs. Afterwards you can run:

make html

The docs will be generated, the output files will be placed in the build/html/ directory, and can be browsed (locally) with any browser.

Alternatively, you can see browse the generated documentation hosted on Read the Docs here.