Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Move compatibility table from README to separate file #2862

Merged
merged 30 commits into from
Jan 30, 2024
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
0b67f9c
Remove compatibility table from README
Dec 8, 2023
e453d15
Add statement regarding NEP29
Dec 8, 2023
e7d5631
Save compatibility table in a separate file (rst)
Dec 8, 2023
06941b5
Add link in README to external compatibility table file
Dec 8, 2023
84f02a9
Include compatibility file in index.rst
Dec 8, 2023
7929106
Use 'compatibility table' as heading
Dec 8, 2023
e14c198
Begin with upper-case letters in headings
Dec 8, 2023
bfff5d0
Link to PyGMT docs
yvonnefroehlich Dec 8, 2023
e845c6b
Merge branch 'main' into move-comptab-to-file
yvonnefroehlich Jan 2, 2024
446857c
Use heading used in SPEC 0 | Move policy above compatibility table
yvonnefroehlich Jan 14, 2024
6bf8fa2
Merge branch 'main' into move-comptab-to-file
yvonnefroehlich Jan 14, 2024
fecd5a9
Merge branch 'main' into move-comptab-to-file
seisman Jan 15, 2024
7ed6392
Fix a typo
seisman Jan 15, 2024
0761c2a
Always mention NEP29 in the compatability table
seisman Jan 15, 2024
f138237
Hide the 'minimum required versions' section in the doc index page
seisman Jan 15, 2024
45a82cc
Short heading on the sidebar
seisman Jan 15, 2024
41fe62a
Update install instructions
seisman Jan 15, 2024
8c0bd1a
Add .rst suffix
seisman Jan 15, 2024
0e09afd
Merge branch 'main' into move-comptab-to-file
seisman Jan 15, 2024
ff1da6f
Update the installation guides
seisman Jan 15, 2024
3ba460a
Update the location of the compatibility table in release checklist a…
seisman Jan 15, 2024
b4ff03e
Merge branch 'main' into move-comptab-to-file
seisman Jan 16, 2024
1449f68
Merge branch 'main' into move-comptab-to-file
seisman Jan 17, 2024
315595b
Merge branch 'main' into move-comptab-to-file
seisman Jan 19, 2024
c9c1dd7
Rename compatibility.rst to minversion.rst
seisman Jan 19, 2024
17a925f
Merge branch 'main' into move-comptab-to-file
seisman Jan 23, 2024
8dfe0a3
Fix a typo
seisman Jan 23, 2024
7fd4577
Merge branch 'main' into move-comptab-to-file
seisman Jan 24, 2024
63eaa06
Merge branch 'main' into move-comptab-to-file
seisman Jan 27, 2024
2b70ea7
Merge branch 'main' into move-comptab-to-file
seisman Jan 28, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 11 additions & 94 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -252,97 +252,14 @@ Other non-official Python wrappers for GMT (not maintained):
Compatibility with GMT/Python/NumPy versions
--------------------------------------------
yvonnefroehlich marked this conversation as resolved.
Show resolved Hide resolved

.. 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.22
* - `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
-
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>`__.

PyGMT has adopted `NEP29 <https://numpy.org/neps/nep-0029-deprecation_policy>`__
seisman marked this conversation as resolved.
Show resolved Hide resolved
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.
yvonnefroehlich marked this conversation as resolved.
Show resolved Hide resolved
97 changes: 97 additions & 0 deletions doc/compatibility.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
Compatibility Table
-------------------
yvonnefroehlich marked this conversation as resolved.
Show resolved Hide resolved

.. 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.22
* - `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
-
1 change: 1 addition & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@

api/index.rst
changes.md
compatibility.rst

.. toctree::
:maxdepth: 2
Expand Down