Building the Documentation¶
To build library documentation, you need to install Graphviz and the documentation dependencies.
pip install -r docs/requirements.txt
Installing graphviz differs depending on your platform.
Linux users can simply,
sudo apt-get install graphviz
Windows users will have to install the binaries from
the official Graphviz downloads. Just be sure that
bin folder is added to your environment’s PATH variable.
Finally, build the documentation with Sphinx:
sphinx-build -E -W docs docs/_build/html
The rendered HTML files should now be located in the
docs/_build/html folder. Point your
internet browser to this path and check the changes have been rendered properly.
Linting the source code¶
This library uses pre-commit for some linting tools like
To use pre-commit, you must install it and create the cached environments that it needs.
pip install pre-commit pre-commit install
Testing the source code¶
pip install -r test/requirements.txt -r requirements.txt
Run the tests and collect the code coverage with:
coverage run -m pytest