Skip to content

ci: publish versioned release documentation to GitHub Pages - #303

Merged
jonmmease merged 1 commit into
mainfrom
jonmmease/versioned-docs-pages
Sep 14, 2026
Merged

jonmmease merged 1 commit into
mainfrom
jonmmease/versioned-docs-pages

Conversation

@jonmmease

@jonmmease jonmmease commented Sep 13, 2026 •

Copy link
Copy Markdown
Collaborator

Why

Publish the new documentation with each release while keeping prereleases separate from stable docs and preserving older versions.

What

Build docs after package publication, store versioned HTML on gh-pages, and deploy through GitHub Pages Actions. Replace the version badge with a dropdown, keep stable first, and hide superseded RCs without deleting their URLs. Manual deployment also permits direct fixes to the generated site without another package release.

Tour

.github/workflows/Release.yml builds and archives the release docs. docs/tools/pages.py updates the version directory, menu, and stable redirect. .github/workflows/Docs.yml deploys the complete archive and can also run manually.

@jonmmease
jonmmease marked this pull request as ready for review September 14, 2026 10:28
@jonmmease
jonmmease merged commit 3fa7f17 into main Sep 14, 2026
11 checks passed
@jonmmease
jonmmease deleted the jonmmease/versioned-docs-pages branch September 14, 2026 10:28
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