Contributing

Build or serve the docs locally

This project uses Great Docs for documentation.

First install Great Docs:

pip install git+https://github.com/rich-iannone/great-docs.git

Then from the project root:

# Build docs into great-docs/_site/
great-docs build

# Preview with live reload
great-docs preview

Running tests

From the repo root:

cargo fmt && cargo check && cargo test && cargo build && cargo clippy
.venv/bin/pip install -e . --no-build-isolation
.venv/bin/python -m pytest tests_py