diff --git a/.github/ISSUE_TEMPLATE/bump_gmt_checklist.md b/.github/ISSUE_TEMPLATE/bump_gmt_checklist.md index b87f8fba11b..a4591f12847 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 minimum required versions in `doc/minversions.rst` + - [ ] Update minimum required versions in `doc/minversions.md` - [ ] 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 51c85f0a5ee..b7c9db32e7d 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/minversions.rst` - - [ ] Add minimum required version information `doc/minversions.rst` + - [ ] Add the documentation link `doc/minversions.md` + - [ ] Add minimum required version information `doc/minversions.md` - [ ] 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/index.rst b/doc/index.rst index 3f22b1db16b..d9fdf3dbf89 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -40,7 +40,7 @@ api/index.rst changes.md - minversions.rst + minversions.md .. toctree:: :maxdepth: 2 diff --git a/doc/maintenance.md b/doc/maintenance.md index 914b30a6a49..f2f3a35f3be 100644 --- a/doc/maintenance.md +++ b/doc/maintenance.md @@ -218,7 +218,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 `doc/minversions.rst` with new information on the new release version, +8. Update `doc/minversions.md` with new information on the new release version, including a vX.Y.Z documentation link, and minimum required versions of GMT, Python and core package dependencies (NumPy/Pandas/Xarray). Follow [SPEC 0](https://scientific-python.org/specs/spec-0000/) for updates. diff --git a/doc/minversions.md b/doc/minversions.md new file mode 100644 index 00000000000..a970fa13e02 --- /dev/null +++ b/doc/minversions.md @@ -0,0 +1,69 @@ +# Minimum Supported Versions + +PyGMT has adopted [SPEC 0](https://scientific-python.org/specs/spec-0000/) alongside the +rest of the Scientific Python ecosystem, and therefore: + +- Support for Python versions be dropped 3 years after their initial release. +- Support for core package dependencies (NumPy/Pandas/Xarray) be dropped 2 years after + their initial release. + +| PyGMT Version | GMT | Python | NumPy | Pandas | Xarray | +|---|---|---|---|---|---| +| [Dev][]* [[Docs][Docs Dev]] | >=6.3.0 | >=3.10 | >=1.23 | >=1.5 | >=2022.03 | +| [v0.11.0][] [[Docs][Docs v0.11.0]] | >=6.3.0 | >=3.9 | >=1.23 | | | +| [v0.10.0][] [[Docs][Docs v0.10.0]] | >=6.3.0 | >=3.9 | >=1.22 | | | +| [v0.9.0][] [[Docs][Docs v0.9.0]] | >=6.3.0 | >=3.8 | >=1.21 | | | +| [v0.8.0][] [[Docs][Docs v0.8.0]] | >=6.3.0 | >=3.8 | >=1.20 | | | +| [v0.7.0][] [[Docs][Docs v0.7.0]] | >=6.3.0 | >=3.8 | >=1.20 | | | +| [v0.6.1][] [[Docs][Docs v0.6.1]] | >=6.3.0 | >=3.8 | >=1.19 | | | +| [v0.6.0][] [[Docs][Docs v0.6.0]] | >=6.3.0 | >=3.8 | >=1.19 | | | +| [v0.5.0][] [[Docs][Docs v0.5.0]] | >=6.2.0 | >=3.7 | >=1.18 | | | +| [v0.4.1][] [[Docs][Docs v0.4.1]] | >=6.2.0 | >=3.7 | >=1.17 | | | +| [v0.4.0][] [[Docs][Docs v0.4.0]] | >=6.2.0 | >=3.7 | >=1.17 | | | +| [v0.3.1][] [[Docs][Docs v0.3.1]] | >=6.1.1 | >=3.7 | | | | +| [v0.3.0][] [[Docs][Docs v0.3.0]] | >=6.1.1 | >=3.7 | | | | +| [v0.2.1][] [[Docs][Docs v0.2.1]] | >=6.1.1 | >=3.6 | | | | +| [v0.2.0][] [[Docs][Docs v0.2.0]] | >=6.1.1 | 3.6 - 3.8 | | | | +| [v0.1.2][] [[Docs][Docs v0.1.2]] | >=6.0.0 | 3.6 - 3.8 | | | | +| [v0.1.1][] [[Docs][Docs v0.1.1]] | >=6.0.0 | 3.6 - 3.8 | | | | +| [v0.1.0][] [[Docs][Docs v0.1.0]] | >=6.0.0 | 3.6 - 3.8 | | | | + +*Dev reflects the main branch and is for the upcoming release. + +[Dev]: https://github.com/GenericMappingTools/pygmt/milestones +[v0.11.0]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.11.0 +[v0.10.0]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.10.0 +[v0.9.0]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.9.0 +[v0.8.0]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.8.0 +[v0.7.0]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.7.0 +[v0.6.1]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.6.1 +[v0.6.0]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.6.0 +[v0.5.0]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.5.0 +[v0.4.1]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.4.1 +[v0.4.0]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.4.0 +[v0.3.1]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.3.1 +[v0.3.0]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.3.0 +[v0.2.1]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.2.1 +[v0.2.0]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.2.0 +[v0.1.2]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.1.2 +[v0.1.1]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.1.1 +[v0.1.0]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.1.0 + +[Docs Dev]: https://www.pygmt.org/dev +[Docs v0.11.0]: https://www.pygmt.org/v0.11.0 +[Docs v0.10.0]: https://www.pygmt.org/v0.10.0 +[Docs v0.9.0]: https://www.pygmt.org/v0.9.0 +[Docs v0.8.0]: https://www.pygmt.org/v0.8.0 +[Docs v0.7.0]: https://www.pygmt.org/v0.7.0 +[Docs v0.6.1]: https://www.pygmt.org/v0.6.1 +[Docs v0.6.0]: https://www.pygmt.org/v0.6.0 +[Docs v0.5.0]: https://www.pygmt.org/v0.5.0 +[Docs v0.4.1]: https://www.pygmt.org/v0.4.1 +[Docs v0.4.0]: https://www.pygmt.org/v0.4.0 +[Docs v0.3.1]: https://www.pygmt.org/v0.3.1 +[Docs v0.3.0]: https://www.pygmt.org/v0.3.0 +[Docs v0.2.1]: https://www.pygmt.org/v0.2.1 +[Docs v0.2.0]: https://www.pygmt.org/v0.2.0 +[Docs v0.1.2]: https://www.pygmt.org/v0.1.2 +[Docs v0.1.1]: https://www.pygmt.org/v0.1.1 +[Docs v0.1.0]: https://www.pygmt.org/v0.1.0 diff --git a/doc/minversions.rst b/doc/minversions.rst deleted file mode 100644 index d73a67c42ae..00000000000 --- a/doc/minversions.rst +++ /dev/null @@ -1,130 +0,0 @@ -Minimum Supported Versions --------------------------- - -PyGMT has adopted `SPEC 0 `__ alongside -the rest of the Scientific Python ecosystem, and therefore: - -* Support for Python versions be dropped 3 years after their initial release. -* Support for core package dependencies (NumPy/Pandas/Xarray) be dropped 2 years after their initial release. - -.. list-table:: - :widths: 25 15 15 15 15 15 - :header-rows: 1 - :align: center - - * - PyGMT Version - - GMT - - Python - - NumPy - - Pandas - - Xarray - * - `Dev `_ * [`Docs `__] - - >=6.3.0 - - >=3.10 - - >=1.23 - - >=1.5 - - >=2022.03 - * - `v0.11.0 `_ [`Docs `__] - - >=6.3.0 - - >=3.9 - - >=1.23 - - - - - * - `v0.10.0 `_ [`Docs `__] - - >=6.3.0 - - >=3.9 - - >=1.22 - - - - - * - `v0.9.0 `_ [`Docs `__] - - >=6.3.0 - - >=3.8 - - >=1.21 - - - - - * - `v0.8.0 `_ [`Docs `__] - - >=6.3.0 - - >=3.8 - - >=1.20 - - - - - * - `v0.7.0 `_ [`Docs `__] - - >=6.3.0 - - >=3.8 - - >=1.20 - - - - - * - `v0.6.1 `_ [`Docs `__] - - >=6.3.0 - - >=3.8 - - >=1.19 - - - - - * - `v0.6.0 `_ [`Docs `__] - - >=6.3.0 - - >=3.8 - - >=1.19 - - - - - * - `v0.5.0 `_ [`Docs `__] - - >=6.2.0 - - >=3.7 - - >=1.18 - - - - - * - `v0.4.1 `_ [`Docs `__] - - >=6.2.0 - - >=3.7 - - >=1.17 - - - - - * - `v0.4.0 `_ [`Docs `__] - - >=6.2.0 - - >=3.7 - - >=1.17 - - - - - * - `v0.3.1 `_ [`Docs `__] - - >=6.1.1 - - >=3.7 - - - - - - - * - `v0.3.0 `_ [`Docs `__] - - >=6.1.1 - - >=3.7 - - - - - - - * - `v0.2.1 `_ [`Docs `__] - - >=6.1.1 - - >=3.6 - - - - - - - * - `v0.2.0 `_ [`Docs `__] - - >=6.1.1 - - 3.6 - 3.8 - - - - - - - * - `v0.1.2 `_ [`Docs `__] - - >=6.0.0 - - 3.6 - 3.8 - - - - - - - * - `v0.1.1 `_ [`Docs `__] - - >=6.0.0 - - 3.6 - 3.8 - - - - - - - * - `v0.1.0 `_ [`Docs `__] - - >=6.0.0 - - 3.6 - 3.8 - - - - - - - -*Dev reflects the main branch and is for the upcoming release.