Skip to content

Deploy documentation as a GitHub Pages artifact - #39

Merged
CarlKCarlK merged 1 commit into
mainfrom
docs-pages-artifact
Nov 14, 2026
Merged

CarlKCarlK merged 1 commit into
mainfrom
docs-pages-artifact

Conversation

@CarlKCarlK

Copy link
Copy Markdown
Contributor
  • docs.yml builds the Sphinx site with warnings as errors and deploys it with upload-pages-artifact / deploy-pages (scoped pages: write, id-token: write), replacing peaceiris/actions-gh-pages and the gh-pages branch.
  • PR CI now builds the docs strictly in a new Documentation job that "CI result" requires.
  • Remove the unserved generated HTML under docs/ (last updated June 2026) and the useful.md steps that copied builds into it.

Before merging, the repository's Pages source must be switched from the gh-pages branch to "GitHub Actions". The gh-pages branch can be deleted afterward.

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.
@CarlKCarlK
CarlKCarlK merged commit d773a3a into main Nov 14, 2026
118 of 120 checks passed
@CarlKCarlK
CarlKCarlK deleted the docs-pages-artifact branch November 14, 2026 16:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant