Skip to content

Commit 685202f

Browse files
authored
Convert minversions from ReST to Markdown (#3056)
1 parent e473a38 commit 685202f

File tree

6 files changed

+74
-135
lines changed

6 files changed

+74
-135
lines changed

.github/ISSUE_TEMPLATE/bump_gmt_checklist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ using the following command:
3737
- [ ] Bump the minimum required GMT version (1 PR)
3838
- [ ] Update `required_version` in `pygmt/clib/session.py`
3939
- [ ] Update `test_get_default` in `pygmt/tests/test_clib.py`
40-
- [ ] Update minimum required versions in `doc/minversions.rst`
40+
- [ ] Update minimum required versions in `doc/minversions.md`
4141
- [ ] Remove unsupported GMT version from `.github/workflows/ci_tests_legacy.yaml`
4242
- [ ] 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
4343
- [ ] 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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ assignees: ''
3131
- [ ] Update DOI (and url for BibTeX)
3232
- [ ] Update version
3333
- [ ] Update date released
34-
- [ ] Add the documentation link `doc/minversions.rst`
35-
- [ ] Add minimum required version information `doc/minversions.rst`
34+
- [ ] Add the documentation link `doc/minversions.md`
35+
- [ ] Add minimum required version information `doc/minversions.md`
3636
- [ ] 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))
3737

3838
**Release**:

doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040

4141
api/index.rst
4242
changes.md
43-
minversions.rst
43+
minversions.md
4444

4545
.. toctree::
4646
:maxdepth: 2

doc/maintenance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ publishing the actual release notes at {doc}`changes`.
218218
7. Edit the list of people who contributed to the release, linking to their
219219
GitHub accounts. Sort their names by the number of commits made since the
220220
last release (e.g., use `git shortlog HEAD...v0.4.0 -sne`).
221-
8. Update `doc/minversions.rst` with new information on the new release version,
221+
8. Update `doc/minversions.md` with new information on the new release version,
222222
including a vX.Y.Z documentation link, and minimum required versions of GMT, Python
223223
and core package dependencies (NumPy/Pandas/Xarray). Follow
224224
[SPEC 0](https://scientific-python.org/specs/spec-0000/) for updates.

doc/minversions.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Minimum Supported Versions
2+
3+
PyGMT has adopted [SPEC 0](https://scientific-python.org/specs/spec-0000/) alongside the
4+
rest of the Scientific Python ecosystem, and therefore:
5+
6+
- Support for Python versions be dropped 3 years after their initial release.
7+
- Support for core package dependencies (NumPy/Pandas/Xarray) be dropped 2 years after
8+
their initial release.
9+
10+
| PyGMT Version | GMT | Python | NumPy | Pandas | Xarray |
11+
|---|---|---|---|---|---|
12+
| [Dev][]* [[Docs][Docs Dev]] | >=6.3.0 | >=3.10 | >=1.23 | >=1.5 | >=2022.03 |
13+
| [v0.11.0][] [[Docs][Docs v0.11.0]] | >=6.3.0 | >=3.9 | >=1.23 | | |
14+
| [v0.10.0][] [[Docs][Docs v0.10.0]] | >=6.3.0 | >=3.9 | >=1.22 | | |
15+
| [v0.9.0][] [[Docs][Docs v0.9.0]] | >=6.3.0 | >=3.8 | >=1.21 | | |
16+
| [v0.8.0][] [[Docs][Docs v0.8.0]] | >=6.3.0 | >=3.8 | >=1.20 | | |
17+
| [v0.7.0][] [[Docs][Docs v0.7.0]] | >=6.3.0 | >=3.8 | >=1.20 | | |
18+
| [v0.6.1][] [[Docs][Docs v0.6.1]] | >=6.3.0 | >=3.8 | >=1.19 | | |
19+
| [v0.6.0][] [[Docs][Docs v0.6.0]] | >=6.3.0 | >=3.8 | >=1.19 | | |
20+
| [v0.5.0][] [[Docs][Docs v0.5.0]] | >=6.2.0 | >=3.7 | >=1.18 | | |
21+
| [v0.4.1][] [[Docs][Docs v0.4.1]] | >=6.2.0 | >=3.7 | >=1.17 | | |
22+
| [v0.4.0][] [[Docs][Docs v0.4.0]] | >=6.2.0 | >=3.7 | >=1.17 | | |
23+
| [v0.3.1][] [[Docs][Docs v0.3.1]] | >=6.1.1 | >=3.7 | | | |
24+
| [v0.3.0][] [[Docs][Docs v0.3.0]] | >=6.1.1 | >=3.7 | | | |
25+
| [v0.2.1][] [[Docs][Docs v0.2.1]] | >=6.1.1 | >=3.6 | | | |
26+
| [v0.2.0][] [[Docs][Docs v0.2.0]] | >=6.1.1 | 3.6 - 3.8 | | | |
27+
| [v0.1.2][] [[Docs][Docs v0.1.2]] | >=6.0.0 | 3.6 - 3.8 | | | |
28+
| [v0.1.1][] [[Docs][Docs v0.1.1]] | >=6.0.0 | 3.6 - 3.8 | | | |
29+
| [v0.1.0][] [[Docs][Docs v0.1.0]] | >=6.0.0 | 3.6 - 3.8 | | | |
30+
31+
*Dev reflects the main branch and is for the upcoming release.
32+
33+
[Dev]: https://github.com/GenericMappingTools/pygmt/milestones
34+
[v0.11.0]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.11.0
35+
[v0.10.0]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.10.0
36+
[v0.9.0]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.9.0
37+
[v0.8.0]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.8.0
38+
[v0.7.0]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.7.0
39+
[v0.6.1]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.6.1
40+
[v0.6.0]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.6.0
41+
[v0.5.0]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.5.0
42+
[v0.4.1]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.4.1
43+
[v0.4.0]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.4.0
44+
[v0.3.1]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.3.1
45+
[v0.3.0]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.3.0
46+
[v0.2.1]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.2.1
47+
[v0.2.0]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.2.0
48+
[v0.1.2]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.1.2
49+
[v0.1.1]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.1.1
50+
[v0.1.0]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.1.0
51+
52+
[Docs Dev]: https://www.pygmt.org/dev
53+
[Docs v0.11.0]: https://www.pygmt.org/v0.11.0
54+
[Docs v0.10.0]: https://www.pygmt.org/v0.10.0
55+
[Docs v0.9.0]: https://www.pygmt.org/v0.9.0
56+
[Docs v0.8.0]: https://www.pygmt.org/v0.8.0
57+
[Docs v0.7.0]: https://www.pygmt.org/v0.7.0
58+
[Docs v0.6.1]: https://www.pygmt.org/v0.6.1
59+
[Docs v0.6.0]: https://www.pygmt.org/v0.6.0
60+
[Docs v0.5.0]: https://www.pygmt.org/v0.5.0
61+
[Docs v0.4.1]: https://www.pygmt.org/v0.4.1
62+
[Docs v0.4.0]: https://www.pygmt.org/v0.4.0
63+
[Docs v0.3.1]: https://www.pygmt.org/v0.3.1
64+
[Docs v0.3.0]: https://www.pygmt.org/v0.3.0
65+
[Docs v0.2.1]: https://www.pygmt.org/v0.2.1
66+
[Docs v0.2.0]: https://www.pygmt.org/v0.2.0
67+
[Docs v0.1.2]: https://www.pygmt.org/v0.1.2
68+
[Docs v0.1.1]: https://www.pygmt.org/v0.1.1
69+
[Docs v0.1.0]: https://www.pygmt.org/v0.1.0

doc/minversions.rst

Lines changed: 0 additions & 130 deletions
This file was deleted.

0 commit comments

Comments
 (0)