From 0b67f9c3ea21c3ec46dcf0361521a2f328622799 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yvonne=20Fr=C3=B6hlich?= Date: Fri, 8 Dec 2023 13:17:48 +0100 Subject: [PATCH 01/19] Remove compatibility table from README --- README.rst | 95 ------------------------------------------------------ 1 file changed, 95 deletions(-) diff --git a/README.rst b/README.rst index 9c013253999..3880663fc7f 100644 --- a/README.rst +++ b/README.rst @@ -251,98 +251,3 @@ Other non-official Python wrappers for GMT (not maintained): Compatibility with GMT/Python/NumPy versions -------------------------------------------- - -.. list-table:: - :widths: 25 30 15 20 15 - :header-rows: 1 - - * - PyGMT Version - - Documentation - - GMT - - Python - - NumPy - * - `Dev `_ (upcoming release) - - `Dev Documentation `_ (reflects `main branch `_) - - >=6.3.0 - - >=3.9 - - >=1.22 - * - `v0.10.0 `_ (latest release) - - `v0.10.0 Documentation `_ - - >=6.3.0 - - >=3.9 - - >=1.22 - * - `v0.9.0 `_ - - `v0.9.0 Documentation `_ - - >=6.3.0 - - >=3.8 - - >=1.21 - * - `v0.8.0 `_ - - `v0.8.0 Documentation `_ - - >=6.3.0 - - >=3.8 - - >=1.20 - * - `v0.7.0 `_ - - `v0.7.0 Documentation `_ - - >=6.3.0 - - >=3.8 - - >=1.20 - * - `v0.6.1 `_ - - `v0.6.1 Documentation `_ - - >=6.3.0 - - >=3.8 - - >=1.19 - * - `v0.6.0 `_ - - `v0.6.0 Documentation `_ - - >=6.3.0 - - >=3.8 - - >=1.19 - * - `v0.5.0 `_ - - `v0.5.0 Documentation `_ - - >=6.2.0 - - >=3.7 - - >=1.18 - * - `v0.4.1 `_ - - `v0.4.1 Documentation `_ - - >=6.2.0 - - >=3.7 - - >=1.17 - * - `v0.4.0 `_ - - `v0.4.0 Documentation `_ - - >=6.2.0 - - >=3.7 - - >=1.17 - * - `v0.3.1 `_ - - `v0.3.1 Documentation `_ - - >=6.1.1 - - >=3.7 - - - * - `v0.3.0 `_ - - `v0.3.0 Documentation `_ - - >=6.1.1 - - >=3.7 - - - * - `v0.2.1 `_ - - `v0.2.1 Documentation `_ - - >=6.1.1 - - >=3.6 - - - * - `v0.2.0 `_ - - `v0.2.0 Documentation `_ - - >=6.1.1 - - 3.6 - 3.8 - - - * - `v0.1.2 `_ - - `v0.1.2 Documentation `_ - - >=6.0.0 - - 3.6 - 3.8 - - - * - `v0.1.1 `_ - - `v0.1.1 Documentation `_ - - >=6.0.0 - - 3.6 - 3.8 - - - * - `v0.1.0 `_ - - `v0.1.0 Documentation `_ - - >=6.0.0 - - 3.6 - 3.8 - - From e453d15a5fefa09ab399cbbe71d0da6bddbeeb6f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yvonne=20Fr=C3=B6hlich?= Date: Fri, 8 Dec 2023 13:20:27 +0100 Subject: [PATCH 02/19] Add statement regarding NEP29 --- README.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.rst b/README.rst index 3880663fc7f..ef81c844882 100644 --- a/README.rst +++ b/README.rst @@ -251,3 +251,11 @@ Other non-official Python wrappers for GMT (not maintained): Compatibility with GMT/Python/NumPy versions -------------------------------------------- + +PyGMT has adopted `NEP29 `__ +alongside the rest of the Scientific Python ecosystem, and therefore supports: + +* All minor versions of Python released 42 months prior to the project, + and at minimum the two latest minor versions. +* All minor versions of NumPy released in the 24 months prior to the project, + and at minimum the last three minor versions. From e7d56318898d505d941d16326adca1b616666e19 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yvonne=20Fr=C3=B6hlich?= Date: Fri, 8 Dec 2023 13:21:24 +0100 Subject: [PATCH 03/19] Save compatibility table in a separate file (rst) --- doc/compatibility.rst | 97 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 97 insertions(+) create mode 100644 doc/compatibility.rst diff --git a/doc/compatibility.rst b/doc/compatibility.rst new file mode 100644 index 00000000000..1b781aec432 --- /dev/null +++ b/doc/compatibility.rst @@ -0,0 +1,97 @@ +Compatibility with GMT/Python/NumPy versions +-------------------------------------------- + +.. list-table:: + :widths: 25 30 15 20 15 + :header-rows: 1 + + * - PyGMT Version + - Documentation + - GMT + - Python + - NumPy + * - `Dev `_ (upcoming release) + - `Dev Documentation `_ (reflects `main branch `_) + - >=6.3.0 + - >=3.9 + - >=1.22 + * - `v0.10.0 `_ (latest release) + - `v0.10.0 Documentation `_ + - >=6.3.0 + - >=3.9 + - >=1.22 + * - `v0.9.0 `_ + - `v0.9.0 Documentation `_ + - >=6.3.0 + - >=3.8 + - >=1.21 + * - `v0.8.0 `_ + - `v0.8.0 Documentation `_ + - >=6.3.0 + - >=3.8 + - >=1.20 + * - `v0.7.0 `_ + - `v0.7.0 Documentation `_ + - >=6.3.0 + - >=3.8 + - >=1.20 + * - `v0.6.1 `_ + - `v0.6.1 Documentation `_ + - >=6.3.0 + - >=3.8 + - >=1.19 + * - `v0.6.0 `_ + - `v0.6.0 Documentation `_ + - >=6.3.0 + - >=3.8 + - >=1.19 + * - `v0.5.0 `_ + - `v0.5.0 Documentation `_ + - >=6.2.0 + - >=3.7 + - >=1.18 + * - `v0.4.1 `_ + - `v0.4.1 Documentation `_ + - >=6.2.0 + - >=3.7 + - >=1.17 + * - `v0.4.0 `_ + - `v0.4.0 Documentation `_ + - >=6.2.0 + - >=3.7 + - >=1.17 + * - `v0.3.1 `_ + - `v0.3.1 Documentation `_ + - >=6.1.1 + - >=3.7 + - + * - `v0.3.0 `_ + - `v0.3.0 Documentation `_ + - >=6.1.1 + - >=3.7 + - + * - `v0.2.1 `_ + - `v0.2.1 Documentation `_ + - >=6.1.1 + - >=3.6 + - + * - `v0.2.0 `_ + - `v0.2.0 Documentation `_ + - >=6.1.1 + - 3.6 - 3.8 + - + * - `v0.1.2 `_ + - `v0.1.2 Documentation `_ + - >=6.0.0 + - 3.6 - 3.8 + - + * - `v0.1.1 `_ + - `v0.1.1 Documentation `_ + - >=6.0.0 + - 3.6 - 3.8 + - + * - `v0.1.0 `_ + - `v0.1.0 Documentation `_ + - >=6.0.0 + - 3.6 - 3.8 + - From 06941b5b5aa8f7b2e5f0f1451d2093b4e6db4cdb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yvonne=20Fr=C3=B6hlich?= Date: Fri, 8 Dec 2023 13:30:10 +0100 Subject: [PATCH 04/19] Add link in README to external compatibility table file --- README.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.rst b/README.rst index ef81c844882..ba22cffdcb5 100644 --- a/README.rst +++ b/README.rst @@ -252,6 +252,10 @@ Other non-official Python wrappers for GMT (not maintained): Compatibility with GMT/Python/NumPy versions -------------------------------------------- +For the supported GMT versions as well as the minimum required Python and NumPy +versions please see the +`Compatibility table `__. + PyGMT has adopted `NEP29 `__ alongside the rest of the Scientific Python ecosystem, and therefore supports: From 84f02a916b229995b9a2ec4f3eb14578c8e44443 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yvonne=20Fr=C3=B6hlich?= Date: Fri, 8 Dec 2023 14:35:11 +0100 Subject: [PATCH 05/19] Include compatibility file in index.rst --- doc/index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/index.rst b/doc/index.rst index e938d96d03b..5172611f143 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -39,6 +39,7 @@ api/index.rst changes.md + compatibility.rst .. toctree:: :maxdepth: 2 From 79291069d0af10b86bc64a423f7c6e56d23b00da Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yvonne=20Fr=C3=B6hlich?= Date: Fri, 8 Dec 2023 15:15:32 +0100 Subject: [PATCH 06/19] Use 'compatibility table' as heading --- doc/compatibility.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/compatibility.rst b/doc/compatibility.rst index 1b781aec432..dfe717260ce 100644 --- a/doc/compatibility.rst +++ b/doc/compatibility.rst @@ -1,5 +1,5 @@ -Compatibility with GMT/Python/NumPy versions --------------------------------------------- +Compatibility table +------------------- .. list-table:: :widths: 25 30 15 20 15 From e14c198d7ca60931fc39899a0adb9649db7e2ef9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yvonne=20Fr=C3=B6hlich?= Date: Fri, 8 Dec 2023 15:19:02 +0100 Subject: [PATCH 07/19] Begin with upper-case letters in headings --- README.rst | 2 +- doc/compatibility.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index ba22cffdcb5..05d5fc87d63 100644 --- a/README.rst +++ b/README.rst @@ -254,7 +254,7 @@ Compatibility with GMT/Python/NumPy versions For the supported GMT versions as well as the minimum required Python and NumPy versions please see the -`Compatibility table `__. +`Compatibility Table `__. PyGMT has adopted `NEP29 `__ alongside the rest of the Scientific Python ecosystem, and therefore supports: diff --git a/doc/compatibility.rst b/doc/compatibility.rst index dfe717260ce..c80d0ae6291 100644 --- a/doc/compatibility.rst +++ b/doc/compatibility.rst @@ -1,4 +1,4 @@ -Compatibility table +Compatibility Table ------------------- .. list-table:: From bfff5d0cdbc33c9b8e76feb4236fc96d6c2e449a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yvonne=20Fr=C3=B6hlich?= <94163266+yvonnefroehlich@users.noreply.github.com> Date: Fri, 8 Dec 2023 15:59:47 +0100 Subject: [PATCH 08/19] Link to PyGMT docs Co-authored-by: Dongdong Tian --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 05d5fc87d63..b08cf4b40e6 100644 --- a/README.rst +++ b/README.rst @@ -254,7 +254,7 @@ Compatibility with GMT/Python/NumPy versions For the supported GMT versions as well as the minimum required Python and NumPy versions please see the -`Compatibility Table `__. +`Compatibility Table `__. PyGMT has adopted `NEP29 `__ alongside the rest of the Scientific Python ecosystem, and therefore supports: From 446857ca910f5a1502430b4b3b8e7f5a4580fbd1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yvonne=20Fr=C3=B6hlich?= <94163266+yvonnefroehlich@users.noreply.github.com> Date: Sun, 14 Jan 2024 20:02:03 +0100 Subject: [PATCH 09/19] Use heading used in SPEC 0 | Move policy above compatibility table Co-authored-by: Dongdong Tian --- README.rst | 12 ++++++------ doc/compatibility.rst | 4 ++-- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index e7778438fc1..584956c35f1 100644 --- a/README.rst +++ b/README.rst @@ -252,12 +252,8 @@ Other non-official Python wrappers for GMT (not maintained): * `PyGMT `__ by `Magnus Hagdorn `__ -Compatibility with GMT/Python/NumPy versions --------------------------------------------- - -For the supported GMT versions as well as the minimum required Python and NumPy -versions please see the -`Compatibility Table `__. +Minimum Supported GMT/Python/NumP Versions +------------------------------------------ PyGMT has adopted `NEP29 `__ alongside the rest of the Scientific Python ecosystem, and therefore supports: @@ -266,3 +262,7 @@ alongside the rest of the Scientific Python ecosystem, and therefore supports: and at minimum the two latest minor versions. * All minor versions of NumPy released in the 24 months prior to the project, and at minimum the last three minor versions. + +For the supported GMT versions as well as the minimum required Python and NumPy +versions please see the +`Compatibility Table `__. diff --git a/doc/compatibility.rst b/doc/compatibility.rst index c80d0ae6291..2a8ba745848 100644 --- a/doc/compatibility.rst +++ b/doc/compatibility.rst @@ -1,5 +1,5 @@ -Compatibility Table -------------------- +Minimum Supported GMT/Python/NumP Versions +------------------------------------------ .. list-table:: :widths: 25 30 15 20 15 From 7ed63927d69ef64898a7108ba88c8fedc525c4f3 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Mon, 15 Jan 2024 14:04:42 +0800 Subject: [PATCH 10/19] Fix a typo --- README.rst | 4 ++-- doc/compatibility.rst | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 714a9d332f2..087b38cf81a 100644 --- a/README.rst +++ b/README.rst @@ -255,8 +255,8 @@ Other non-official Python wrappers for GMT (not maintained): * `PyGMT `__ by `Magnus Hagdorn `__ -Minimum Supported GMT/Python/NumP Versions ------------------------------------------- +Minimum Supported GMT/Python/NumPy Versions +------------------------------------------- PyGMT has adopted `NEP29 `__ alongside the rest of the Scientific Python ecosystem, and therefore supports: diff --git a/doc/compatibility.rst b/doc/compatibility.rst index 7d93e967081..e9bab38e016 100644 --- a/doc/compatibility.rst +++ b/doc/compatibility.rst @@ -1,5 +1,5 @@ -Minimum Supported GMT/Python/NumP Versions ------------------------------------------- +Minimum Supported GMT/Python/NumPy Versions +------------------------------------------- .. list-table:: :widths: 25 30 15 20 15 From 0761c2adc45ac5d9ac12e91a7d80d774e3ab0ce1 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Mon, 15 Jan 2024 14:16:46 +0800 Subject: [PATCH 11/19] Always mention NEP29 in the compatability table --- README.rst | 15 +++++++-------- doc/compatibility.rst | 8 ++++++++ 2 files changed, 15 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index 087b38cf81a..22c75c0cc92 100644 --- a/README.rst +++ b/README.rst @@ -261,11 +261,10 @@ Minimum Supported GMT/Python/NumPy Versions PyGMT has adopted `NEP29 `__ alongside the rest of the Scientific Python ecosystem, and therefore supports: -* All minor versions of Python released 42 months prior to the project, - and at minimum the two latest minor versions. -* All minor versions of NumPy released in the 24 months prior to the project, - and at minimum the last three minor versions. - -For the supported GMT versions as well as the minimum required Python and NumPy -versions please see the -`Compatibility Table `__. +* All minor versions of Python released 42 months prior to the project, and at minimum + the two latest minor versions. +* All minor versions of NumPy released in the 24 months prior to the project, and at + minimum the last three minor versions. + +For the supported GMT versions as well as the minimum required Python and NumPy versions +please see the `Compatibility Table `__. diff --git a/doc/compatibility.rst b/doc/compatibility.rst index e9bab38e016..99ff919274f 100644 --- a/doc/compatibility.rst +++ b/doc/compatibility.rst @@ -1,6 +1,14 @@ Minimum Supported GMT/Python/NumPy Versions ------------------------------------------- +PyGMT has adopted `NEP29 `__ +alongside the rest of the Scientific Python ecosystem, and therefore supports: + +* All minor versions of Python released 42 months prior to the project, and at minimum + the two latest minor versions. +* All minor versions of NumPy released in the 24 months prior to the project, and at + minimum the last three minor versions. + .. list-table:: :widths: 25 30 15 20 15 :header-rows: 1 From f1382373d3f886e367a279ff4b0a22c3e22ba728 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Mon, 15 Jan 2024 14:41:50 +0800 Subject: [PATCH 12/19] Hide the 'minimum required versions' section in the doc index page --- README.rst | 3 ++- doc/index.rst | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 22c75c0cc92..b079e41d03b 100644 --- a/README.rst +++ b/README.rst @@ -50,7 +50,7 @@ PyGMT :alt: Twitter URL :target: https://twitter.com/gmt_dev -.. placeholder-for-doc-index +.. doc-index-start-after Why PyGMT? @@ -254,6 +254,7 @@ Other non-official Python wrappers for GMT (not maintained): * `pygmt `__ by `Ian Rose `__ * `PyGMT `__ by `Magnus Hagdorn `__ +.. doc-index-end-before Minimum Supported GMT/Python/NumPy Versions ------------------------------------------- diff --git a/doc/index.rst b/doc/index.rst index 52bcc5d823e..f8c26cba177 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -11,7 +11,8 @@ .. include:: ../README.rst - :start-after: placeholder-for-doc-index + :start-after: doc-index-start-after + :end-before: doc-index-end-before .. toctree:: :maxdepth: 2 From 45a82ccad857a21e1a6c057576b0880e022aa30f Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Mon, 15 Jan 2024 14:42:47 +0800 Subject: [PATCH 13/19] Short heading on the sidebar --- doc/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/index.rst b/doc/index.rst index f8c26cba177..81f0cf54d43 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -40,7 +40,7 @@ api/index.rst changes.md - compatibility.rst + Minimum Supported Versions .. toctree:: :maxdepth: 2 From 41fe62a8a7ed38999edadb6cd756edb5315447c1 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Mon, 15 Jan 2024 15:27:05 +0800 Subject: [PATCH 14/19] Update install instructions --- doc/install.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/doc/install.rst b/doc/install.rst index e9de9422ffb..f33b022c130 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -94,12 +94,16 @@ Dependencies PyGMT requires the following libraries to be installed: -* `numpy `__ (>= 1.23) +* `numpy `__ * `pandas `__ * `xarray `__ * `netCDF4 `__ * `packaging `__ +.. note:: + + For the minimum supported versions of the dependencies, please see {doc}`compatibility`. + The following are optional dependencies: * `IPython `__: For embedding the figures in Jupyter notebooks (recommended). From 8c0bd1a2388742a5d4de21abc807f5dee61db5d5 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Mon, 15 Jan 2024 15:38:28 +0800 Subject: [PATCH 15/19] Add .rst suffix --- doc/install.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/install.rst b/doc/install.rst index f33b022c130..67e538bc8de 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -102,7 +102,7 @@ PyGMT requires the following libraries to be installed: .. note:: - For the minimum supported versions of the dependencies, please see {doc}`compatibility`. + For the minimum supported versions of the dependencies, please see {doc}`compatibility.rst`. The following are optional dependencies: From ff1da6fa2940324553fbf352a1c0f5501ba10a86 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Mon, 15 Jan 2024 16:26:58 +0800 Subject: [PATCH 16/19] Update the installation guides --- doc/install.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/doc/install.md b/doc/install.md index 4ae00878cc7..635558c7de1 100644 --- a/doc/install.md +++ b/doc/install.md @@ -83,12 +83,16 @@ We recommend following the instructions further on to install GMT 6. PyGMT requires the following libraries to be installed: -- [numpy](https://numpy.org) (>= 1.23) +- [numpy](https://numpy.org) - [pandas](https://pandas.pydata.org) - [xarray](https://xarray.dev/) - [netCDF4](https://unidata.github.io/netcdf4-python) - [packaging](https://packaging.pypa.io) +:::{note} +For the minimum supported versions of the dependencies, please see {doc}`compatibility`. +::: + The following are optional dependencies: - [IPython](https://ipython.org): For embedding the figures in Jupyter notebooks (recommended). From 3ba460a9c8a3a2082ec210e52543b4d408ba1f69 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Mon, 15 Jan 2024 17:38:16 +0800 Subject: [PATCH 17/19] Update the location of the compatibility table in release checklist and maintenance guides --- .github/ISSUE_TEMPLATE/bump_gmt_checklist.md | 2 +- .github/ISSUE_TEMPLATE/release_checklist.md | 4 ++-- doc/maintenance.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bump_gmt_checklist.md b/.github/ISSUE_TEMPLATE/bump_gmt_checklist.md index 146d9f42c04..783ba84af14 100644 --- a/.github/ISSUE_TEMPLATE/bump_gmt_checklist.md +++ b/.github/ISSUE_TEMPLATE/bump_gmt_checklist.md @@ -35,7 +35,7 @@ assignees: '' - [ ] Bump the minimum required GMT version (1 PR) - [ ] Update `required_version` in `pygmt/clib/session.py` - [ ] Update `test_get_default` in `pygmt/tests/test_clib.py` - - [ ] Update compatibility table in `README.rst` + - [ ] Update compatibility table in `doc/compatibility.rst` - [ ] Remove unsupported GMT version from `.github/workflows/ci_tests_legacy.yaml` - [ ] Remove [xfail](https://docs.pytest.org/en/stable/skipping.html#xfail-mark-test-functions-as-expected-to-fail) pytest markers on tests that are now xpass - [ ] Update deprecated syntax in source code and examples based on the [GMT Changelog](https://docs.generic-mapping-tools.org/latest/changes.html) diff --git a/.github/ISSUE_TEMPLATE/release_checklist.md b/.github/ISSUE_TEMPLATE/release_checklist.md index 3e9ad6815f9..d3b1225d442 100644 --- a/.github/ISSUE_TEMPLATE/release_checklist.md +++ b/.github/ISSUE_TEMPLATE/release_checklist.md @@ -30,8 +30,8 @@ assignees: '' - [ ] Update DOI (and url for BibTeX) - [ ] Update version - [ ] Update date released - - [ ] Add the documentation link https://github.com/GenericMappingTools/pygmt#compatibility-with-gmtpythonnumpy-versions - - [ ] Add compatibility information https://github.com/GenericMappingTools/pygmt#compatibility-with-gmtpythonnumpy-versions + - [ ] Add the documentation link `doc/compatibility.rst` + - [ ] Add compatibility information `doc/compatibility.rst` - [ ] Copy draft changelog from Release Drafter and edit it to look nice ([see maintainers guide for details](https://www.pygmt.org/dev/maintenance.html#updating-the-changelog)) **Release**: diff --git a/doc/maintenance.md b/doc/maintenance.md index 42f5c2904a6..e546d032f7e 100644 --- a/doc/maintenance.md +++ b/doc/maintenance.md @@ -220,7 +220,7 @@ publishing the actual release notes at {doc}`changes`. 7. Edit the list of people who contributed to the release, linking to their GitHub accounts. Sort their names by the number of commits made since the last release (e.g., use `git shortlog HEAD...v0.4.0 -sne`). -8. Update `README.rst` with new information on the new release version, +8. Update `doc/compatibility.rst` with new information on the new release version, including a vX.Y.Z documentation link, and compatibility with GMT/Python/NumPy versions. Follow [NEP 29](https://numpy.org/neps/nep-0029-deprecation_policy.html#detailed-description) From c9c1dd72e286531bd6dfab1f7a0a73c6cb142dcd Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Fri, 19 Jan 2024 19:25:36 +0800 Subject: [PATCH 18/19] Rename compatibility.rst to minversion.rst --- .github/ISSUE_TEMPLATE/bump_gmt_checklist.md | 2 +- .github/ISSUE_TEMPLATE/release_checklist.md | 4 ++-- README.rst | 2 +- doc/index.rst | 2 +- doc/install.md | 2 +- doc/maintenance.md | 8 ++++---- doc/{compatibility.rst => minversions.rst} | 0 7 files changed, 10 insertions(+), 10 deletions(-) rename doc/{compatibility.rst => minversions.rst} (100%) diff --git a/.github/ISSUE_TEMPLATE/bump_gmt_checklist.md b/.github/ISSUE_TEMPLATE/bump_gmt_checklist.md index f99d6cc64ef..b87f8fba11b 100644 --- a/.github/ISSUE_TEMPLATE/bump_gmt_checklist.md +++ b/.github/ISSUE_TEMPLATE/bump_gmt_checklist.md @@ -37,7 +37,7 @@ using the following command: - [ ] Bump the minimum required GMT version (1 PR) - [ ] Update `required_version` in `pygmt/clib/session.py` - [ ] Update `test_get_default` in `pygmt/tests/test_clib.py` - - [ ] Update compatibility table in `doc/compatibility.rst` + - [ ] Update minimum required versions in `doc/minversions.rst` - [ ] Remove unsupported GMT version from `.github/workflows/ci_tests_legacy.yaml` - [ ] Remove [xfail](https://docs.pytest.org/en/stable/skipping.html#xfail-mark-test-functions-as-expected-to-fail) pytest markers on tests that are now xpass - [ ] Update deprecated syntax in source code and examples based on the [GMT Changelog](https://docs.generic-mapping-tools.org/latest/changes.html) diff --git a/.github/ISSUE_TEMPLATE/release_checklist.md b/.github/ISSUE_TEMPLATE/release_checklist.md index 12304e5e2bf..1f8a6e7585e 100644 --- a/.github/ISSUE_TEMPLATE/release_checklist.md +++ b/.github/ISSUE_TEMPLATE/release_checklist.md @@ -31,8 +31,8 @@ assignees: '' - [ ] Update DOI (and url for BibTeX) - [ ] Update version - [ ] Update date released - - [ ] Add the documentation link `doc/compatibility.rst` - - [ ] Add compatibility information `doc/compatibility.rst` + - [ ] Add the documentation link `doc/minversions.rst` + - [ ] Add minimum required vesion information `doc/minversions.rst` - [ ] Copy draft changelog from Release Drafter and edit it to look nice ([see maintainers guide for details](https://www.pygmt.org/dev/maintenance.html#updating-the-changelog)) **Release**: diff --git a/README.rst b/README.rst index b079e41d03b..39d49b22ce8 100644 --- a/README.rst +++ b/README.rst @@ -268,4 +268,4 @@ alongside the rest of the Scientific Python ecosystem, and therefore supports: minimum the last three minor versions. For the supported GMT versions as well as the minimum required Python and NumPy versions -please see the `Compatibility Table `__. +please see `Minimum Required Versions `__. diff --git a/doc/index.rst b/doc/index.rst index a5c92864e83..4130e5e51b5 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -40,7 +40,7 @@ api/index.rst changes.md - Minimum Supported Versions + Minimum Supported Versions .. toctree:: :maxdepth: 2 diff --git a/doc/install.md b/doc/install.md index 635558c7de1..887e971ce55 100644 --- a/doc/install.md +++ b/doc/install.md @@ -90,7 +90,7 @@ PyGMT requires the following libraries to be installed: - [packaging](https://packaging.pypa.io) :::{note} -For the minimum supported versions of the dependencies, please see {doc}`compatibility`. +For the minimum supported versions of the dependencies, please see {doc}`minversions`. ::: The following are optional dependencies: diff --git a/doc/maintenance.md b/doc/maintenance.md index e546d032f7e..20007c272eb 100644 --- a/doc/maintenance.md +++ b/doc/maintenance.md @@ -220,11 +220,11 @@ publishing the actual release notes at {doc}`changes`. 7. Edit the list of people who contributed to the release, linking to their GitHub accounts. Sort their names by the number of commits made since the last release (e.g., use `git shortlog HEAD...v0.4.0 -sne`). -8. Update `doc/compatibility.rst` with new information on the new release version, - including a vX.Y.Z documentation link, and compatibility with - GMT/Python/NumPy versions. Follow +8. Update `doc/minversions.rst` with new information on the new release version, + including a vX.Y.Z documentation link, and minimum required GMT/Python/NumPy + versions. Follow [NEP 29](https://numpy.org/neps/nep-0029-deprecation_policy.html#detailed-description) - for compatibility updates. + for updates. 9. Refresh citation information. Specifically, the BibTeX in `README.rst` and `CITATION.cff` needs to be updated with any metadata changes, including the DOI, release date, and version information. Please also follow diff --git a/doc/compatibility.rst b/doc/minversions.rst similarity index 100% rename from doc/compatibility.rst rename to doc/minversions.rst From 8dfe0a3102a9c8b65d86a6382119fb8ff18d6459 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Tue, 23 Jan 2024 16:22:03 +0800 Subject: [PATCH 19/19] Fix a typo --- .github/ISSUE_TEMPLATE/release_checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/release_checklist.md b/.github/ISSUE_TEMPLATE/release_checklist.md index 1f8a6e7585e..225cb3e8737 100644 --- a/.github/ISSUE_TEMPLATE/release_checklist.md +++ b/.github/ISSUE_TEMPLATE/release_checklist.md @@ -32,7 +32,7 @@ assignees: '' - [ ] Update version - [ ] Update date released - [ ] Add the documentation link `doc/minversions.rst` - - [ ] Add minimum required vesion information `doc/minversions.rst` + - [ ] Add minimum required version information `doc/minversions.rst` - [ ] Copy draft changelog from Release Drafter and edit it to look nice ([see maintainers guide for details](https://www.pygmt.org/dev/maintenance.html#updating-the-changelog)) **Release**: