Project Documentation

Pre-requisites

To create the database for the first time, a virtual environment should be created, the requirements should be installed from the "requirements.txt" file using pip and the environment should be activated.

Generating Documentation

Once the pre-requisites have been completed, HTML documentation can then be created by running the following commands from the "docs" sub-folder:

Windows

$env:PYTHONPATH="$pwd\..\src;$pwd\..\tests"
.\make.bat html

Linux or MacOS

export PYTHONPATH="`pwd`/../src/:`pwd`/../tests"
make html

The resulting documentation is written to the docs/build/html folder and can be viewed by opening "index.html" in a web browser.