CONTRIBUTING.rst

Contributing

Dev setup

Install dev packages

Specify the [dev] option to install the development packages:

pip install -e ".[dev]"

Running tests

Use pytest to run all unit tests.

pytest

Building docs

Generate the docs:

cd docs
make html

You can then check out the generated HTML:

cd docs/build/html
python3 -m http.server

Formatting code

mia's code is formatted using black. Run the formatter as follows:

make format