From 3b22af3deab4dc70b5e1940fbf2ff26894f91f9f Mon Sep 17 00:00:00 2001 From: Stefan van der Walt Date: Fri, 11 Sep 2026 23:25:20 +0000 Subject: [PATCH 1/2] Document how to publish the release documentation The workflow only builds dev/; releases are published by hand. --- RELEASE.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/RELEASE.md b/RELEASE.md index 9db841c..f54b5ad 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -84,6 +84,29 @@ PyPI trusted publishing. Do not build or upload artifacts by hand. rm ${CHANGES} +- Publish the documentation for the release. The `Publish docs to + gh-pages` workflow builds `dev/` from `main`; the released versions + are published by hand. Skip this step for a pre-release. + + - build the docs from the tag: + + git checkout v${VERSION} + spin docs + git checkout main + + - in a separate clone of the `gh-pages` branch, add the new + version and point `latest` at it: + + cp -r /doc/build/html version/${VERSION} + rm -rf latest + ln -s version/${VERSION} latest + + - commit and push `gh-pages` + + The site then serves ${VERSION} at + https://numpy.org/numpy-financial/version/${VERSION}/ and at + https://numpy.org/numpy-financial/latest/ + - Update https://github.com/numpy/numpy-financial/milestones: - close old milestone From a9fe13fe46d21950c651619cf687806c89263eab Mon Sep 17 00:00:00 2001 From: Stefan van der Walt Date: Mon, 14 Sep 2026 16:07:06 -0700 Subject: [PATCH 2/2] Document how to publish the release documentation The workflow only builds dev/; releases are published by hand. --- RELEASE.md | 25 ++++++++++--------------- 1 file changed, 10 insertions(+), 15 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index f54b5ad..fed7979 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -84,29 +84,24 @@ PyPI trusted publishing. Do not build or upload artifacts by hand. rm ${CHANGES} -- Publish the documentation for the release. The `Publish docs to - gh-pages` workflow builds `dev/` from `main`; the released versions - are published by hand. Skip this step for a pre-release. +- 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. - - build the docs from the tag: + - 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. - git checkout v${VERSION} - spin docs - git checkout main + - in a clone of the `gh-pages` branch, copy those docs to their + permanent location and point `latest` at them: - - in a separate clone of the `gh-pages` branch, add the new - version and point `latest` at it: - - cp -r /doc/build/html version/${VERSION} + cp -r dev version/${VERSION} rm -rf latest ln -s version/${VERSION} latest - commit and push `gh-pages` - The site then serves ${VERSION} at - https://numpy.org/numpy-financial/version/${VERSION}/ and at - https://numpy.org/numpy-financial/latest/ - - Update https://github.com/numpy/numpy-financial/milestones: - close old milestone