Contributing

Installation

Make sure uv is installed. Then, run

uv python install 3.12

Simply run

make docs

This will generate the HTML doc of the project, and the index file should be at docs/index.html. To have it directly in your browser, run

make docs-browser

Don't forget to run

make

to format and check the code using ruff and typecheck it using mypy.