Skip to content

Commit

Permalink
Rename compatibility.rst to minversion.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
seisman committed Jan 19, 2024
1 parent 315595b commit c9c1dd7
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bump_gmt_checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/release_checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**:
Expand Down
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.pygmt.org/dev/compatibility.html>`__.
please see `Minimum Required Versions <https://www.pygmt.org/dev/minvesrions.html>`__.
2 changes: 1 addition & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@

api/index.rst
changes.md
Minimum Supported Versions <compatibility.rst>
Minimum Supported Versions <minversions.rst>

.. toctree::
:maxdepth: 2
Expand Down
2 changes: 1 addition & 1 deletion doc/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
8 changes: 4 additions & 4 deletions doc/maintenance.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
File renamed without changes.

0 comments on commit c9c1dd7

Please sign in to comment.