Skip to content

Configure GitHub Pages for HTML docs previews#21

Open
jdillard wants to merge 1 commit intosphinx-contrib:masterfrom
jdillard:feature/gh-pages
Open

Configure GitHub Pages for HTML docs previews#21
jdillard wants to merge 1 commit intosphinx-contrib:masterfrom
jdillard:feature/gh-pages

Conversation

@jdillard
Copy link

@jdillard jdillard commented Dec 15, 2025

Summary of changes

  • Configure GitHub Pages for HTML docs previews
    • I configured my fork and you can see the docs preview for that PR as a demo.
      • I'll delete GitHub pages for the fork once this merges so there aren't duplicate docs deployed.
    • I chose GitHub Pages to make ownership of the deployed docs more agnostic since this is in 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:

  1. Go to SettingsPages
  2. Under "Build and deployment":
    • Source: Deploy from a branch
    • Branch: gh-pages / / (root)

The workflow will create the gh-pages branch and the .nojekyll file automatically on the first run.

The docs will then be available at:

  • Production: https://sphinx-contrib.github.io/mcp/
  • PR previews: https://sphinx-contrib.github.io/mcp/pr-preview/pr-<number>/

@jdillard jdillard force-pushed the feature/gh-pages branch 3 times, most recently from 94a21bf to b0b2fbf Compare December 15, 2025 20:22
@jdillard jdillard changed the title Configure GitHub Pages for HTML docs previews. Configure GitHub Pages for HTML docs previews Dec 15, 2025
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