Contributing

Build

./gradlew build

Build the docs locally

python -m pip install -r requirements-docs.txt
mkdocs build --strict
mkdocs serve

Preferred release/tag flow:

python3 scripts/publish_release.py 1.10.0 --dry-run
python3 scripts/publish_release.py 1.10.0

Deploy versioned docs (maintainers)

Manual docs deployment:

mike deploy --update-aliases 1.10.0 stable
mike set-default stable

For dev docs:

mike deploy --update-aliases dev latest
mike set-default latest