Contributing Guidelines

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

Now, every time you commit something it will run pre-commit on the changed files. You can also run pre-commit on staged files:

pre-commit run


Use the --all-files argument to run pre-commit on all files in the repository.

Building the Documentation

To build library documentation, you need to install the documentation dependencies.

pip install -r docs/requirements.txt

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.