Move compatibility table from README to separate file (#2862)

Co-authored-by: Yvonne Fröhlich <[email protected]>
Co-authored-by: Dongdong Tian <[email protected]>

Author: 3 people

.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 `README.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)

.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 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/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**:

README.rst

@@ -47,7 +47,7 @@ PyGMT
     :alt: Contributor Code of Conduct
     :target: CODE_OF_CONDUCT.md
 
-.. placeholder-for-doc-index
+.. doc-index-start-after
 
 
 Why PyGMT?
@@ -251,101 +251,18 @@ Other non-official Python wrappers for GMT (not maintained):
 * `pygmt <https://github.com/ian-r-rose/pygmt>`__ by `Ian Rose <https://github.com/ian-r-rose>`__
 * `PyGMT <https://github.com/glimmer-cism/PyGMT>`__  by `Magnus Hagdorn <https://github.com/mhagdorn>`__
 
+.. doc-index-end-before
 
-Compatibility with GMT/Python/NumPy versions
---------------------------------------------
-
-.. list-table::
-    :widths: 25 30 15 20 15
-    :header-rows: 1
-
-    * - PyGMT Version
-      - Documentation
-      - GMT
-      - Python
-      - NumPy
-    * - `Dev <https://github.com/GenericMappingTools/pygmt/milestones>`_ (upcoming release)
-      - `Dev Documentation <https://www.pygmt.org/dev>`_ (reflects `main branch <https://github.com/GenericMappingTools/pygmt>`_)
-      - >=6.3.0
-      - >=3.9
-      - >=1.23
-    * - `v0.10.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.10.0>`_ (latest release)
-      - `v0.10.0 Documentation <https://www.pygmt.org/v0.10.0>`_
-      - >=6.3.0
-      - >=3.9
-      - >=1.22
-    * - `v0.9.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.9.0>`_
-      - `v0.9.0 Documentation <https://www.pygmt.org/v0.9.0>`_
-      - >=6.3.0
-      - >=3.8
-      - >=1.21
-    * - `v0.8.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.8.0>`_
-      - `v0.8.0 Documentation <https://www.pygmt.org/v0.8.0>`_
-      - >=6.3.0
-      - >=3.8
-      - >=1.20
-    * - `v0.7.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.7.0>`_
-      - `v0.7.0 Documentation <https://www.pygmt.org/v0.7.0>`_
-      - >=6.3.0
-      - >=3.8
-      - >=1.20
-    * - `v0.6.1 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.6.1>`_
-      - `v0.6.1 Documentation <https://www.pygmt.org/v0.6.1>`_
-      - >=6.3.0
-      - >=3.8
-      - >=1.19
-    * - `v0.6.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.6.0>`_
-      - `v0.6.0 Documentation <https://www.pygmt.org/v0.6.0>`_
-      - >=6.3.0
-      - >=3.8
-      - >=1.19
-    * - `v0.5.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.5.0>`_
-      - `v0.5.0 Documentation <https://www.pygmt.org/v0.5.0>`_
-      - >=6.2.0
-      - >=3.7
-      - >=1.18
-    * - `v0.4.1 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.4.1>`_
-      - `v0.4.1 Documentation <https://www.pygmt.org/v0.4.1>`_
-      - >=6.2.0
-      - >=3.7
-      - >=1.17
-    * - `v0.4.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.4.0>`_
-      - `v0.4.0 Documentation <https://www.pygmt.org/v0.4.0>`_
-      - >=6.2.0
-      - >=3.7
-      - >=1.17
-    * - `v0.3.1 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.3.1>`_
-      - `v0.3.1 Documentation <https://www.pygmt.org/v0.3.1>`_
-      - >=6.1.1
-      - >=3.7
-      -
-    * - `v0.3.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.3.0>`_
-      - `v0.3.0 Documentation <https://www.pygmt.org/v0.3.0>`_
-      - >=6.1.1
-      - >=3.7
-      -
-    * - `v0.2.1 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.2.1>`_
-      - `v0.2.1 Documentation <https://www.pygmt.org/v0.2.1>`_
-      - >=6.1.1
-      - >=3.6
-      -
-    * - `v0.2.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.2.0>`_
-      - `v0.2.0 Documentation <https://www.pygmt.org/v0.2.0>`_
-      - >=6.1.1
-      - 3.6 - 3.8
-      -
-    * - `v0.1.2 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.1.2>`_
-      - `v0.1.2 Documentation <https://www.pygmt.org/v0.1.2>`_
-      - >=6.0.0
-      - 3.6 - 3.8
-      -
-    * - `v0.1.1 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.1.1>`_
-      - `v0.1.1 Documentation <https://www.pygmt.org/v0.1.1>`_
-      - >=6.0.0
-      - 3.6 - 3.8
-      -
-    * - `v0.1.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.1.0>`_
-      - `v0.1.0 Documentation <https://www.pygmt.org/v0.1.0>`_
-      - >=6.0.0
-      - 3.6 - 3.8
-      -
+Minimum Supported GMT/Python/NumPy Versions
+-------------------------------------------
+
+PyGMT has adopted `NEP29 <https://numpy.org/neps/nep-0029-deprecation_policy>`__
+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 `Minimum Required Versions <https://www.pygmt.org/dev/minvesrions.html>`__.

doc/index.rst

@@ -11,7 +11,8 @@
     </div>
 
 .. include:: ../README.rst
-    :start-after: placeholder-for-doc-index
+    :start-after: doc-index-start-after
+    :end-before: doc-index-end-before
 
 .. toctree::
     :maxdepth: 2
@@ -39,6 +40,7 @@
 
     api/index.rst
     changes.md
+    Minimum Supported Versions <minversions.rst>
 
 .. toctree::
     :maxdepth: 2

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}`minversions`.
+:::
+
 The following are optional dependencies:
 
 - [IPython](https://ipython.org): For embedding the figures in Jupyter notebooks (recommended).

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 `README.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

doc/minversions.rst

@@ -0,0 +1,105 @@
+Minimum Supported GMT/Python/NumPy Versions
+-------------------------------------------
+
+PyGMT has adopted `NEP29 <https://numpy.org/neps/nep-0029-deprecation_policy>`__
+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
+
+    * - PyGMT Version
+      - Documentation
+      - GMT
+      - Python
+      - NumPy
+    * - `Dev <https://github.com/GenericMappingTools/pygmt/milestones>`_ (upcoming release)
+      - `Dev Documentation <https://www.pygmt.org/dev>`_ (reflects `main branch <https://github.com/GenericMappingTools/pygmt>`_)
+      - >=6.3.0
+      - >=3.9
+      - >=1.23
+    * - `v0.10.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.10.0>`_ (latest release)
+      - `v0.10.0 Documentation <https://www.pygmt.org/v0.10.0>`_
+      - >=6.3.0
+      - >=3.9
+      - >=1.22
+    * - `v0.9.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.9.0>`_
+      - `v0.9.0 Documentation <https://www.pygmt.org/v0.9.0>`_
+      - >=6.3.0
+      - >=3.8
+      - >=1.21
+    * - `v0.8.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.8.0>`_
+      - `v0.8.0 Documentation <https://www.pygmt.org/v0.8.0>`_
+      - >=6.3.0
+      - >=3.8
+      - >=1.20
+    * - `v0.7.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.7.0>`_
+      - `v0.7.0 Documentation <https://www.pygmt.org/v0.7.0>`_
+      - >=6.3.0
+      - >=3.8
+      - >=1.20
+    * - `v0.6.1 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.6.1>`_
+      - `v0.6.1 Documentation <https://www.pygmt.org/v0.6.1>`_
+      - >=6.3.0
+      - >=3.8
+      - >=1.19
+    * - `v0.6.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.6.0>`_
+      - `v0.6.0 Documentation <https://www.pygmt.org/v0.6.0>`_
+      - >=6.3.0
+      - >=3.8
+      - >=1.19
+    * - `v0.5.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.5.0>`_
+      - `v0.5.0 Documentation <https://www.pygmt.org/v0.5.0>`_
+      - >=6.2.0
+      - >=3.7
+      - >=1.18
+    * - `v0.4.1 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.4.1>`_
+      - `v0.4.1 Documentation <https://www.pygmt.org/v0.4.1>`_
+      - >=6.2.0
+      - >=3.7
+      - >=1.17
+    * - `v0.4.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.4.0>`_
+      - `v0.4.0 Documentation <https://www.pygmt.org/v0.4.0>`_
+      - >=6.2.0
+      - >=3.7
+      - >=1.17
+    * - `v0.3.1 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.3.1>`_
+      - `v0.3.1 Documentation <https://www.pygmt.org/v0.3.1>`_
+      - >=6.1.1
+      - >=3.7
+      -
+    * - `v0.3.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.3.0>`_
+      - `v0.3.0 Documentation <https://www.pygmt.org/v0.3.0>`_
+      - >=6.1.1
+      - >=3.7
+      -
+    * - `v0.2.1 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.2.1>`_
+      - `v0.2.1 Documentation <https://www.pygmt.org/v0.2.1>`_
+      - >=6.1.1
+      - >=3.6
+      -
+    * - `v0.2.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.2.0>`_
+      - `v0.2.0 Documentation <https://www.pygmt.org/v0.2.0>`_
+      - >=6.1.1
+      - 3.6 - 3.8
+      -
+    * - `v0.1.2 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.1.2>`_
+      - `v0.1.2 Documentation <https://www.pygmt.org/v0.1.2>`_
+      - >=6.0.0
+      - 3.6 - 3.8
+      -
+    * - `v0.1.1 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.1.1>`_
+      - `v0.1.1 Documentation <https://www.pygmt.org/v0.1.1>`_
+      - >=6.0.0
+      - 3.6 - 3.8
+      -
+    * - `v0.1.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.1.0>`_
+      - `v0.1.0 Documentation <https://www.pygmt.org/v0.1.0>`_
+      - >=6.0.0
+      - 3.6 - 3.8
+      -