Summary
Following the MkDocs setup in #456, we need a GitHub Actions workflow to
automatically build and deploy the documentation to GitHub Pages whenever
changes are merged into main.
What this adds
A .github/workflows/docs.yml workflow that:
- Triggers on every push to
main and on pull requests
- Sets up Python 3.10 and
uv
- Installs the
docs dependency group (mkdocs, mkdocs-material,
mkdocstrings)
- Builds the docs with
mkdocs build --strict (fails on warnings)
- Deploys to GitHub Pages via
mkdocs gh-deploy on merges to main
Why This Matters
Related
Summary
Following the MkDocs setup in #456, we need a GitHub Actions workflow to
automatically build and deploy the documentation to GitHub Pages whenever
changes are merged into
main.What this adds
A
.github/workflows/docs.ymlworkflow that:mainand on pull requestsuvdocsdependency group (mkdocs,mkdocs-material,mkdocstrings)mkdocs build --strict(fails on warnings)mkdocs gh-deployon merges tomainWhy This Matters
Related