Publish docs to GitHub Pages¶
This repository now includes a dedicated workflow:
.github/workflows/docs.yml
It builds MkDocs and deploys to GitHub Pages via GitHub Actions.
One-time GitHub setup¶
- Open repository Settings → Pages
- Set Source to GitHub Actions
Triggering publication¶
- Automatic on push to
mainwhen docs-related files change - Manual via Actions → Docs → Run workflow
Local preview¶
make docs-serve
Local strict build¶
make docs-build