Contributing

Dev setup

python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
pip install -e .

Lint & test

ruff check .
black --check .
pytest -q

Docs: build & serve

Install doc dependencies:

pip install mkdocs mkdocs-material mkdocstrings[python]

Build/serve locally (auto-reload):

mkdocs serve

Deploy (manual):

mkdocs gh-deploy --clean

We use NumPy-style docstrings for API reference via mkdocstrings.