Configure GitHub Pages for HTML docs previews#21
Open
jdillard wants to merge 1 commit intosphinx-contrib:masterfrom
Open
Configure GitHub Pages for HTML docs previews#21jdillard wants to merge 1 commit intosphinx-contrib:masterfrom
jdillard wants to merge 1 commit intosphinx-contrib:masterfrom
Conversation
94a21bf to
b0b2fbf
Compare
b0b2fbf to
082d859
Compare
This was referenced Jan 26, 2026
Open
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.
Summary of changes
sphinx-contrib, a Read the Docs configuration would be simpler, but more tied to the maintainer.TODO (after merge)
After merging the workflow, GitHub Pages will need to be configure for the repository:
Settings→PagesDeploy from a branchgh-pages// (root)The workflow will create the
gh-pagesbranch and the.nojekyllfile automatically on the first run.The docs will then be available at:
https://sphinx-contrib.github.io/mcp/https://sphinx-contrib.github.io/mcp/pr-preview/pr-<number>/