Skip to content

Development

Run tests

python -m pytest -q

Lint

ruff check .

Type check

mypy src

Build package artifacts

python -m build

Build documentation locally

pip install -e ".[png]"
pip install mkdocs mkdocs-material mkdocstrings[python]
mkdocs serve

GitHub Actions

The provided workflow does two things:

  1. Runs unit tests on every push, pull request, and manual dispatch.
  2. Builds and deploys the MkDocs site to GitHub Pages only on pushes to main.

Before the Pages deployment works, set the repository's Pages source to GitHub Actions in repository settings.