Skip to content

Document how to publish the release documentation #152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stefanv merged 2 commits into from
Sep 14, 2026
Merged

Document how to publish the release documentation #152

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3b22af3
Document how to publish the release documentation
stefanv Sep 11, 2026
a9fe13f
Document how to publish the release documentation
stefanv Sep 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,24 @@ PyPI trusted publishing. Do not build or upload artifacts by hand.

rm ${CHANGES}

- Publish the documentation for the release. A GH workflow builds
`dev/` from `main`; the released versions have to be published by
hand. Skip this step for a pre-release.

- wait for the workflow to rebuild `dev/` from the release
commit, and check that https://numpy.org/numpy-financial/dev/
shows ${VERSION}. Do this before the version bump below, which
returns `dev/` to a development version.

- in a clone of the `gh-pages` branch, copy those docs to their
permanent location and point `latest` at them:

cp -r dev version/${VERSION}
rm -rf latest
ln -s version/${VERSION} latest

- commit and push `gh-pages`

- Update https://github.com/numpy/numpy-financial/milestones:

- close old milestone
Expand Down
Loading