The documentation found in the docs folder must first be built by sphinx
using the command make html
. Prebuilt documentation is also given in the
folder prebuilt_docs.
The documentation is in the form of a website which should be opened by the
file index.html
.
The project requirements can be installed by running the command
pip install -r requirements.txt
The tests must be run with the tests folder as the current working directory.
Then simply run pytest
(or maybe py.test
depending on version).