Skip to content

Development setup

Use the locked workspace and checks in the contributor quickstart. Keep library diagnostics in named loggers and public APIs typed. Run uv run pre-commit install to enable the repository hooks.

Build documentation in an isolated environment, separate from the workspace:

python3 -m venv .venv-docs
.venv-docs/bin/python -m pip install -r docs/requirements.txt
.venv-docs/bin/python -m mkdocs build --strict
python3 tests/docs/test_internal_links.py

The link check uses only Python's standard library and also runs under pytest. The documentation CI job is paused until December 1, 2026; local builds remain required during the pause. Remove the temporary environment when finished.

Before building wheels, set export PYTHONDONTWRITEBYTECODE=1. Benchmark entry points disable bytecode writes too, but wheel builds run separately. See the runtime build instructions for the three wheels and release manifest required before preparing benchmark requests.