Repository navigation
ci: publish versioned release documentation to GitHub Pages - #303
Merged
Merged
Conversation
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.
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.ymlbuilds and archives the release docs.docs/tools/pages.pyupdates the version directory, menu, and stable redirect..github/workflows/Docs.ymldeploys the complete archive and can also run manually.