Development

Setting up a development environment

Make sure to install the development dependencies. This includes testing and (optionally) documentation dependencies.

pip install .[test]
pip install .[docs]

Running the tests

Then run the tests:

cd test
pytest tests

Building documentation

cd docs
make html

We recommend sphinx-autobuild for live-reloading the documentation:

pip install sphinx-autobuild
sphinx-autobuild docs/source docs/build/html