Skip to content

doc: Simplify the "minimum required versions" page using MyST customized URL schemes #3383

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.

Sign up for GitHub

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

Merged
seisman merged 3 commits into from
Aug 9, 2024
Merged

doc: Simplify the "minimum required versions" page using MyST customized URL schemes #3383

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6aef358
doc: Simplify the "minimum required versions" page using MyST customi…
seisman Aug 7, 2024
668741a
Fix a typo
seisman Aug 8, 2024
46f093c
Merge branch 'main' into doc/minversions
seisman Aug 8, 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
93 changes: 36 additions & 57 deletions doc/minversions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
---
myst:
# Customized URI schemes that are converted to external links
Copy link
Member

@yvonnefroehlich yvonnefroehlich Aug 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm. Based on how I understand the documentation so far and being consistent with url_schemes:, using "URL" seem to be better, here. If we use "URI" I feel it can make sense to introduce this shortcut.

Suggested change
# Customized URI schemes that are converted to external links
# Customized URL schemes that are converted to external links

Copy link
Member

@michaelgrund michaelgrund Aug 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For me it seems URI is still the right term here since an URL is already a link (a location) while an URI is just the identifier that is then converted to an URL.

Copy link
Member Author

@seisman seisman Aug 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The MyST documentation uses URI: https://myst-parser.readthedocs.io/en/latest/configuration.html

For the difference between URI and URL, see https://www.godaddy.com/resources/ae/skills/uri-vs-url.

I agree with @michaelgrund that URI is the right term.

Copy link
Member

@yvonnefroehlich yvonnefroehlich Aug 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, looks like the MyST documentation is not 100 % consistent here 🙃:

at https://myst-parser.readthedocs.io/en/latest/syntax/cross-referencing.html#customising-external-url-resolution

To specify a custom list of URL schemes, you can set the myst_url_schemes configuration option. By default this is set to ["http", "https", "ftp", "mailto"].

but at https://myst-parser.readthedocs.io/en/latest/configuration.html

myst_url_schemes | URI schemes that are converted to external links (default: {'http': None, 'https': None, 'mailto': None, 'ftp': None})

Copy link
Member Author

@seisman seisman Aug 8, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Anyway, it's just one comment line and it doesn't hurt if it's correct or not.

Copy link
Member

@yvonnefroehlich yvonnefroehlich Aug 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reading https://www.godaddy.com/resources/ae/skills/uri-vs-url

URIs can be further divided into two categories: URLs and URNs. [...]
The key difference is: all URLs are URIs, but not all URIs are URLs.

So, let's keep URIs here.

# References:
# - https://myst-parser.readthedocs.io/en/latest/syntax/cross-referencing.html#customising-external-url-resolution
# - https://myst-parser.readthedocs.io/en/latest/configuration.html#frontmatter-local-configuration
url_schemes:
http: null
https: null
tag:
url: "https://github.com/GenericMappingTools/pygmt/releases/tag/{{path}}"
title: "{{path}}"
doc:
url: "https://www.pygmt.org/{{path}}"
title: "Docs"
---

# Minimum Supported Versions

PyGMT has adopted [SPEC 0](https://scientific-python.org/specs/spec-0000/) alongside the
Expand All @@ -12,64 +29,26 @@ after their initial release.

| PyGMT Version | GMT | Python | NumPy | Pandas | Xarray |
|---|---|---|---|---|---|
| [Dev][]* [[Docs][Docs Dev]] | {{ requires.gmt }} | {{ requires.python }} | {{ requires.numpy }} | {{ requires.pandas }} | {{ requires.xarray }} |
| [v0.12.0][] [[Docs][Docs v0.12.0]] | >=6.3.0 | >=3.10 | >=1.23 | >=1.5 | >=2022.06 |
| [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][]* [<doc:dev>] | {{ requires.gmt }} | {{ requires.python }} | {{ requires.numpy }} | {{ requires.pandas }} | {{ requires.xarray }} |
| <tag:v0.12.0> [<doc:v0.12.0>] | >=6.3.0 | >=3.10 | >=1.23 | >=1.5 | >=2022.06 |
| <tag:v0.11.0> [<doc:v0.11.0>] | >=6.3.0 | >=3.9 | >=1.23 | | |
| <tag:v0.10.0> [<doc:v0.10.0>] | >=6.3.0 | >=3.9 | >=1.22 | | |
| <tag:v0.9.0> [<doc:v0.9.0>] | >=6.3.0 | >=3.8 | >=1.21 | | |
| <tag:v0.8.0> [<doc:v0.8.0>] | >=6.3.0 | >=3.8 | >=1.20 | | |
| <tag:v0.7.0> [<doc:v0.7.0>] | >=6.3.0 | >=3.8 | >=1.20 | | |
| <tag:v0.6.1> [<doc:v0.6.1>] | >=6.3.0 | >=3.8 | >=1.19 | | |
| <tag:v0.6.0> [<doc:v0.6.0>] | >=6.3.0 | >=3.8 | >=1.19 | | |
| <tag:v0.5.0> [<doc:v0.5.0>] | >=6.2.0 | >=3.7 | >=1.18 | | |
| <tag:v0.4.1> [<doc:v0.4.1>] | >=6.2.0 | >=3.7 | >=1.17 | | |
| <tag:v0.4.0> [<doc:v0.4.0>] | >=6.2.0 | >=3.7 | >=1.17 | | |
| <tag:v0.3.1> [<doc:v0.3.1>] | >=6.1.1 | >=3.7 | | | |
| <tag:v0.3.0> [<doc:v0.3.0>] | >=6.1.1 | >=3.7 | | | |
| <tag:v0.2.1> [<doc:v0.2.1>] | >=6.1.1 | >=3.6 | | | |
| <tag:v0.2.0> [<doc:v0.2.0>] | >=6.1.1 | 3.6 - 3.8 | | | |
| <tag:v0.1.2> [<doc:v0.1.2>] | >=6.0.0 | 3.6 - 3.8 | | | |
| <tag:v0.1.1> [<doc:v0.1.1>] | >=6.0.0 | 3.6 - 3.8 | | | |
| <tag:v0.1.0> [<doc: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.12.0]: https://github.com/GenericMappingTools/pygmt/releases/tag/v0.12.0
[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.12.0]: https://www.pygmt.org/v0.12.0
[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