For contributors

All contributions are welcome, feel free to make a pull request on GitHub.

Documentation

We use sphinx & ReadTheDocs for documenting.

Test your changes locally:

  • Install the documentation dependencies (setup.cfg: docs).

  • Local build: from the docs directory make html (on Windows: .\make.bat html).

Testing

We use pytest for unit testing.