Repository navigation
Deploy documentation as a GitHub Pages artifact - #39
Merged
Merged
Conversation
Build the Sphinx site in docs.yml and deploy it with the official Pages actions instead of pushing it to a gh-pages branch. Build the docs with warnings as errors in PR CI, as part of "CI result". Remove the stale, unserved generated HTML under docs/ and the instructions to copy it.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
docs.ymlbuilds the Sphinx site with warnings as errors and deploys it withupload-pages-artifact/deploy-pages(scopedpages: write,id-token: write), replacingpeaceiris/actions-gh-pagesand thegh-pagesbranch.docs/(last updated June 2026) and theuseful.mdsteps that copied builds into it.Before merging, the repository's Pages source must be switched from the
gh-pagesbranch to "GitHub Actions". Thegh-pagesbranch can be deleted afterward.