docs(build): add canonical build instructions, pyproject.toml, and add more radio presets (#7222)

Co-authored-by: raphaelcoeffic <1050031+raphaelcoeffic@users.noreply.github.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Peter Feerick <peter.feerick@gmail.com>
This commit is contained in:
Raphael Coeffic
2026-09-03 10:58:04 +10:00
committed by GitHub
co-authored by raphaelcoeffic Claude Opus 4.6 Peter Feerick
parent 1ca4e58274
commit a9f89323a9
15 changed files with 609 additions and 62 deletions
+5 -5
View File
@@ -7,7 +7,7 @@ on:
paths:
- 'docs/**'
- 'mkdocs.yml'
- 'docs-requirements.txt'
- 'pyproject.toml'
- '.github/workflows/docs.yml'
tags:
- 'v[0-9]+.[0-9]+.[0-9]+' # release tags only, not -rc
@@ -15,7 +15,7 @@ on:
paths:
- 'docs/**'
- 'mkdocs.yml'
- 'docs-requirements.txt'
- 'pyproject.toml'
- '.github/workflows/docs.yml'
workflow_dispatch:
@@ -41,15 +41,15 @@ jobs:
- name: Build docs (PR check)
if: github.event_name == 'pull_request'
run: uv run --with-requirements docs-requirements.txt mkdocs build --strict
run: uv run --extra docs -- mkdocs build --strict
- name: Deploy as latest (main branch)
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
run: uv run --with-requirements docs-requirements.txt mike deploy --push --update-aliases latest
run: uv run --extra docs -- mike deploy --push --update-aliases latest
- name: Deploy release version
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
run: |
# Extract minor version from tag, e.g. v2.11.2 -> v2.11
VERSION=$(echo "${GITHUB_REF_NAME}" | sed 's/\.[0-9]*$//')
uv run --with-requirements docs-requirements.txt mike deploy --push --update-aliases "${VERSION}" stable
uv run --extra docs -- mike deploy --push --update-aliases "${VERSION}" stable