Align versioned docs with PyPI releases (#47)#48
Draft
ilouzl wants to merge 1 commit into
Draft
Conversation
Deploy MkDocs with mike only after a successful PyPI publish (separate workflow), migrate History.md into docs/release-notes.md, and auto-fill missing release-note sections from merged PRs on tag publish. Co-authored-by: Liron Ilouz <ilouzl@users.noreply.github.com>
Docs check
|
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
2 participants
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
Fixes #47: published docs were tracking
masterand could document APIs ahead of the PyPI package.Changes
gh-pagesbranch viamikeDeploy docsusesworkflow_runon Publish to PyPI success (plusworkflow_dispatch). Docs failure cannot fail the PyPI jobmkdocs build --strictHistory.md→docs/release-notes.md: single changelog for MkDocs + PyPI long description; releasing steps live inpublish.ymlheader commentsscripts/update_release_notes_from_prs.pyinserts a missing version section from PRs merged since the previousv*tag (does not overwrite existing sections)Maintainer follow-up (one-time)
After merge, set GitHub Pages source to Deploy from a branch →
gh-pages/(root). The first versioned docs site appears on the next successfulv*PyPI publish (or via Actions → Deploy docs → Run workflow).Test plan
mkdocs build --strictlocally0.7.0(no-op) and missing0.8.0(generates from PRs)workflow_dispatchdeploy for a version