Test gh pages docs build #180
Conversation
There was a problem hiding this comment.
Pull request overview
This PR temporarily modifies the release workflow to test GitHub Pages documentation deployment using mkdocs. The PyPI publishing jobs have been commented out while the docs build is being tested.
Key changes:
- Adds a new
deployjob that usesmkdocs gh-deployto publish documentation to GitHub Pages - Adds
permissions: contents: writeat the workflow level to enable GitHub Pages deployment - Comments out the existing PyPI build and publish jobs for testing purposes
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| name: release-dists | ||
| path: dist/ | ||
| - uses: pypa/gh-action-pypi-publish@release/v1 | ||
| - uses: astral-sh/setup-uv@v7 |
There was a problem hiding this comment.
The deploy job should run the apt-get update and install gettext before running mkdocs, similar to the CI workflow's docs job and other jobs in ci.yml. The gettext package is required by the build-system as specified in pyproject.toml (flit-gettext), and the docs build may fail without it.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
No description provided.