Contributing

make check        # lint, type-check, and tests
make tox          # the suite across Python 3.11, 3.12, and 3.13
make bench-report # regenerate the quality + speed tables into a dated docs/bench/ report
make fargate      # import and fit timing under one CPU cap (docker --cpus=0.5 --memory=2g)
make constrained  # fit and cluster timing under 0.5, 1 and 2 vCPU, into a dated report

The docs site

This site is built with MkDocs and Material, from docs/site/:

uv sync --extra docs
uv run mkdocs serve             # local preview at 127.0.0.1:8000
uv run mkdocs build --strict    # exactly what CI runs before publishing

Every prose page pulls its text from README.md with pymdownx snippets (--8<-- "README.md:section"), so the README is the single source of truth and the site cannot drift from it. To add a page, mark a new section in the README with page to nav in mkdocs.yml.