From cf1356ca1716d236de9d106c047edad37549114b Mon Sep 17 00:00:00 2001 From: Lourens Veen Date: Sun, 14 Jun 2026 09:32:17 +0200 Subject: [PATCH 1/7] Update to pyproject.toml --- docs/source/releasing.rst | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/docs/source/releasing.rst b/docs/source/releasing.rst index fb9745be..7a583aaa 100644 --- a/docs/source/releasing.rst +++ b/docs/source/releasing.rst @@ -27,7 +27,7 @@ exactly the same process, so it's best to check. Check metadata -------------- -- Check the metadata in ``setup.py``, and update as necessary +- Check the metadata in ``pyproject.toml``, and update as necessary - Check the dependencies, and fix them to an appropriate range of versions - Check the copyright date and owners in ``README.rst`` and ``docs/source/conf.py`` and update as necessary. @@ -165,12 +165,7 @@ can start using it. To build, use: .. code-block:: bash - rm -r ./build - python3 setup.py sdist bdist_wheel - -Note that we remove ``./build``, which is the build directory setuptools uses, -to ensure that we're doing a clean build, I've seen some weird mixes of versions -on occasion so it's better to be safe than sorry. + python3 -m build We can then check to see if everything is okay using From bc775811e4544f49edd39c644b7c0943b58da2ad Mon Sep 17 00:00:00 2001 From: Lourens Veen Date: Sun, 14 Jun 2026 09:33:10 +0200 Subject: [PATCH 2/7] Fix docs file location --- docs/source/releasing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/releasing.rst b/docs/source/releasing.rst index 7a583aaa..35bc5e27 100644 --- a/docs/source/releasing.rst +++ b/docs/source/releasing.rst @@ -84,7 +84,7 @@ shows up: It may give some warnings about missing references, that's a known issue and normally harmless. Next, point your web browser to -``docs/build/html/index.html`` and verify that the documentation built +``docs/build/index.html`` and verify that the documentation built correctly. In particular, the new version number should be in the browser's title bar as well as in the blue box on the top left of the page. From af8036586a745780cc0ce2d697b135403e627114 Mon Sep 17 00:00:00 2001 From: Lourens Veen Date: Sun, 14 Jun 2026 09:33:59 +0200 Subject: [PATCH 3/7] Update to newer version of RTD theme --- docs/source/releasing.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/releasing.rst b/docs/source/releasing.rst index 35bc5e27..ec5b9e06 100644 --- a/docs/source/releasing.rst +++ b/docs/source/releasing.rst @@ -85,8 +85,8 @@ shows up: It may give some warnings about missing references, that's a known issue and normally harmless. Next, point your web browser to ``docs/build/index.html`` and verify that the documentation built -correctly. In particular, the new version number should be in the browser's -title bar as well as in the blue box on the top left of the page. +correctly. Also check that the new version number is in the browser's +title bar. Run tests --------- From 736d6da1f3e8526f23423756801947b99c7b9f8b Mon Sep 17 00:00:00 2001 From: Lourens Veen Date: Sun, 14 Jun 2026 09:34:55 +0200 Subject: [PATCH 4/7] Remove CHANGELOG as it's no longer on the release branch --- docs/source/releasing.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/source/releasing.rst b/docs/source/releasing.rst index ec5b9e06..027ad77b 100644 --- a/docs/source/releasing.rst +++ b/docs/source/releasing.rst @@ -201,9 +201,8 @@ that we want to have back on the develop branch. So we'll merge it back in: We use --no-commit to give ourselves a chance to edit the changes before committing them. Make sure that README.rst is taken from the develop side, -CHANGELOG.md comes from the release branch, and VERSION is given a new number, -probably x.y.{z+1}-dev unless you have big plans. When done, commit the merge -and continue developing. +and that VERSION is given a new number, probably x.y.{z+1}-dev unless you have big +plans. When done, commit the merge and continue developing. Update issues ------------- From 31e1586f08bead158ebc3c52fe9c9b630797f80b Mon Sep 17 00:00:00 2001 From: Lourens Veen Date: Sun, 14 Jun 2026 09:41:05 +0200 Subject: [PATCH 5/7] Update version scheme to follow PEP440 --- docs/source/releasing.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/releasing.rst b/docs/source/releasing.rst index 027ad77b..f90095aa 100644 --- a/docs/source/releasing.rst +++ b/docs/source/releasing.rst @@ -67,7 +67,7 @@ Update version Next, the version should be updated. There is a single version tag in the ``VERSION`` file in the root of the repository. On the development branch, the -version should be set to ``x.y.z-dev``, where ``x.y.z`` is the next expected +version should be set to ``x.y.z-dev0``, where ``x.y.z`` is the next expected version (it's fine if that changes later, e.g. because you end up releasing 2.0.0 rather than 1.4.0). On the release branch, it should be set to the number of this release of course. @@ -201,7 +201,7 @@ that we want to have back on the develop branch. So we'll merge it back in: We use --no-commit to give ourselves a chance to edit the changes before committing them. Make sure that README.rst is taken from the develop side, -and that VERSION is given a new number, probably x.y.{z+1}-dev unless you have big +and that VERSION is given a new number, probably x.y.{z+1}-dev0 unless you have big plans. When done, commit the merge and continue developing. Update issues From 69bccf1f462d3814a65ad11a28778e92add01e46 Mon Sep 17 00:00:00 2001 From: Lourens Veen Date: Wed, 17 Jun 2026 20:58:10 +0200 Subject: [PATCH 6/7] Fix version dash/dot mistake Co-authored-by: Maarten Sebregts <110895564+maarten-ic@users.noreply.github.com> --- docs/source/releasing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/releasing.rst b/docs/source/releasing.rst index f90095aa..8fbf1094 100644 --- a/docs/source/releasing.rst +++ b/docs/source/releasing.rst @@ -67,7 +67,7 @@ Update version Next, the version should be updated. There is a single version tag in the ``VERSION`` file in the root of the repository. On the development branch, the -version should be set to ``x.y.z-dev0``, where ``x.y.z`` is the next expected +version should be set to ``x.y.z.dev0``, where ``x.y.z`` is the next expected version (it's fine if that changes later, e.g. because you end up releasing 2.0.0 rather than 1.4.0). On the release branch, it should be set to the number of this release of course. From b4de60cbd646b636d0e5a127499ea94c5a994312 Mon Sep 17 00:00:00 2001 From: Lourens Veen Date: Thu, 18 Jun 2026 09:30:08 +0200 Subject: [PATCH 7/7] Fix another version dash/dot mistake Co-authored-by: Maarten Sebregts <110895564+maarten-ic@users.noreply.github.com> --- docs/source/releasing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/releasing.rst b/docs/source/releasing.rst index 8fbf1094..65e50c92 100644 --- a/docs/source/releasing.rst +++ b/docs/source/releasing.rst @@ -201,7 +201,7 @@ that we want to have back on the develop branch. So we'll merge it back in: We use --no-commit to give ourselves a chance to edit the changes before committing them. Make sure that README.rst is taken from the develop side, -and that VERSION is given a new number, probably x.y.{z+1}-dev0 unless you have big +and that VERSION is given a new number, probably x.y.{z+1}.dev0 unless you have big plans. When done, commit the merge and continue developing. Update issues