doc: Move compatibility table from README to separate file #2862
Conversation
yvonnefroehlich
added
the
documentation
yvonnefroehlich
changed the title
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
weiji14
changed the title
|
I've moved this PR to 0.12.0 milestone. |
That's fine for me. |
|
After thinking twice, I feel we should not wait for #2863 and go ahead with this PR. Otherwise, we'll have too much to do when addressing #2863. @yvonnefroehlich Please let me know if you have time (and your health allows) to finish this PR. |
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
If you like to finish this PR, feel free to do so. I am not sure if I can work on this in the next days. |
| @@ -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) | |||
There was a problem hiding this comment.
After adopting SPEC 0 (#2863), we will also need to pin pandas and xarray. Removing the pinned version from the installation guides because most users don't care about them. For anyone who cares about the versions, we provide the link to the "compatibility table".
doc/index.rst
Outdated
| @@ -39,6 +40,7 @@ | |||
|
|
|||
| api/index.rst | |||
| changes.md | |||
| Minimum Supported Versions <compatibility.rst> | |||
There was a problem hiding this comment.
The name "Minimum Supported GMT/Python/NumPy Versions" are too long to fit the sidebar.
| - >=6.0.0 | ||
| - 3.6 - 3.8 | ||
| - | ||
| Minimum Supported GMT/Python/NumPy Versions |
There was a problem hiding this comment.
This section is not shown on the index page (https://pygmt-dev--2862.org.readthedocs.build/en/2862/index.html) but is shown in the README file.
doc/compatibility.rst
Outdated
| @@ -0,0 +1,105 @@ | |||
| Minimum Supported GMT/Python/NumPy Versions | |||
There was a problem hiding this comment.
I'm debating if we should rename the file to minversions.md.
There was a problem hiding this comment.
I think I perfer minversions.md. It's more similar to the heading (and easier to write).
There was a problem hiding this comment.
Do we want to keep the table in ReStructuredText because of the length of the lines due to the links (see #2858 (comment)) or do we plan to have a separate PR for re-writing it to Markdown?
I think we should keep the table in ReST to make this PR small for review. We may rewrite it into Markdown in a future PR, but it depends on:
So, better to decide if we want to rewrite in Markdown after addressing PR #2863. |
yvonnefroehlich
changed the title
…Tools#2862) Co-authored-by: Yvonne Fröhlich <yfroe@gpiseis16.gpi.kit.edu> Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
Description of proposed changes
This PR aims to move the compatibility table in the README to a separate file. For context see discussion in #2858.
Preview
Fixes #2858