Skip to content

Commit c471769

Browse files
DOC: Use MyST syntax for linking other files (#3499)
Co-authored-by: Yvonne Fröhlich <[email protected]>
1 parent 130d0cb commit c471769

File tree

5 files changed

+39
-39
lines changed

5 files changed

+39
-39
lines changed

doc/install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ PyGMT requires the following libraries to be installed:
9494
- [packaging](https://packaging.pypa.io)
9595

9696
:::{note}
97-
For the minimum supported versions of the dependencies, please see {doc}`minversions`.
97+
For the minimum supported versions of the dependencies, please see [](minversions.md).
9898
:::
9999

100100
The following are optional dependencies:

doc/maintenance.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
This page contains instructions for project maintainers about how our setup works,
44
making releases, creating packages, etc.
55

6-
If you want to make a contribution to the project, see the {doc}`contributing` instead.
6+
If you want to make a contribution to the project, see the [](contributing.md) instead.
77

88
## Onboarding/Offboarding Access Checklist
99

@@ -22,7 +22,7 @@ communication tools we use.
2222
### As a Maintainer
2323

2424
- Add to the [pygmt-maintainers team](https://github.com/orgs/GenericMappingTools/teams/pygmt-maintainers) (gives 'maintain' permission to the repository)
25-
- Add to "Active Maintainers" on the {doc}`Team Gallery page <team>`
25+
- Add to "Active Maintainers" on the [Team Gallery page](team.md)
2626
- Add as a moderator on the [GMT forum](https://forum.generic-mapping-tools.org) (to see mod-only discussions) [optional]
2727
- Add as a maintainer on [ReadtheDocs](https://readthedocs.org/projects/pygmt-dev) [optional]
2828
- Add as a curator to the [GMT community](https://zenodo.org/communities/generic-mapping-tools/) on Zenodo (for making releases) [optional]
@@ -38,7 +38,7 @@ the onboarding access checklist:
3838

3939
- Move from the [pygmt-maintainers team](https://github.com/orgs/GenericMappingTools/teams/pygmt-maintainers)
4040
to the [pygmt-contributors team](https://github.com/orgs/GenericMappingTools/teams/pygmt-contributors)
41-
- Move from "Active Maintainers" to "Distinguished Contributors" on the {doc}`Team Gallery page <team>`
41+
- Move from "Active Maintainers" to "Distinguished Contributors" on the [Team Gallery page](team.md)
4242
- Remove 'maintain' permission from GMT forum, ReadTheDocs, Zenodo
4343

4444
## Branches
@@ -201,7 +201,7 @@ at `.github/release-drafter.yml`. Configuration settings can be found at
201201
<https://github.com/release-drafter/release-drafter>.
202202

203203
The drafted release notes are not perfect, so we will need to tidy it prior to
204-
publishing the actual release notes at {doc}`changes`.
204+
publishing the actual release notes at [](changes.md).
205205

206206
1. Go to <https://github.com/GenericMappingTools/pygmt/releases> and click on the
207207
'Edit' button next to the current draft release note. Copy the text of the

doc/team.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ We are an international team dedicated to building a Pythonic API for the Generi
44
Tools (GMT).
55

66
All are welcome to become involved with the PyGMT project! For more information about how
7-
to get involved, see the {doc}`contributing`. A more complete list of contributors
7+
to get involved, see the [](contributing.md). A more complete list of contributors
88
is available in the [`AUTHORS.md`](https://github.com/GenericMappingTools/pygmt/blob/main/AUTHORS.md)
99
file in the source repository.
1010

1111
Distinguished Contributors are recognized for their substantial contributions to PyGMT,
1212
which may include code, documentation, pull request review, triaging, forum responses,
1313
community building and engagement, outreach, and inclusion and diversity. Maintainers
1414
are recognized for their responsibilities in maintaining the project, as detailed in
15-
the {doc}`maintenance`.
15+
the [](maintenance.md).
1616

1717
New Distinguished Contributors and Active Maintainers are selected and voted by current
1818
Active Maintainers before each release. Maintainers that are inactive for more than one

doc/techref/fonts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ PyGMT supports the 35 standard PostScript fonts. The table below lists them with
88
font numbers and font names. When specifying fonts in PyGMT, you can either give the
99
font name or just the font number. For example, to use the font "Helvetica", you can use
1010
either `"Helvetica"` or `"0"`. For the special fonts "Symbol" (**12**) and
11-
"ZapfDingbats" (**34**), see the {doc}`/techref/encodings` for the character set.
11+
"ZapfDingbats" (**34**), see the [](/techref/encodings.md) for the character set.
1212
The image below the table shows a visual sample for each font.
1313

1414
```{code-cell}

doc/techref/projections.md

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -16,34 +16,34 @@ The table below shows the projection codes for the 31 GMT map projections:
1616

1717
| PyGMT Projection Argument | Projection Name |
1818
| --- | --- |
19-
| **A**{{ lon0 }}/{{ lat0 }}[/*horizon*]/*width* | {doc}`/projections/azim/azim_lambert` |
20-
| **B**{{ lon0 }}/{{ lat0 }}/{{ lat1 }}/{{ lat2 }}/*width* | {doc}`/projections/conic/conic_albers` |
21-
| **C**{{ lon0 }}/{{ lat0 }}/*width* | {doc}`/projections/cyl/cyl_cassini` |
22-
| **Cyl_stere**/[{{ lon0 }}/[{{ lat0 }}/]]*width* | {doc}`/projections/cyl/cyl_stereographic` |
23-
| **D**{{ lon0 }}/{{ lat0 }}/{{ lat1 }}/{{ lat2 }}/*width* | {doc}`/projections/conic/conic_equidistant` |
24-
| **E**{{ lon0 }}/{{ lat0 }}[/*horizon*]/*width* | {doc}`/projections/azim/azim_equidistant` |
25-
| **F**{{ lon0 }}/{{ lat0 }}[/*horizon*]/*width* | {doc}`/projections/azim/azim_gnomonic` |
26-
| **G**{{ lon0 }}/{{ lat0 }}[/*horizon*]/*width* | {doc}`/projections/azim/azim_orthographic` |
27-
| **G**{{ lon0 }}/{{ lat0 }}/*width*[**+a***azimuth*][**+t***tilt*][**+v***vwidth*/*vheight*][**+w***twist*][**+z***altitude*] | {doc}`/projections/azim/azim_general_perspective` |
28-
| **H**[{{ lon0 }}/]*width* | {doc}`/projections/misc/misc_hammer` |
29-
| **I**[{{ lon0 }}/]*width* | {doc}`/projections/misc/misc_sinusoidal` |
30-
| **J**[{{ lon0 }}/]*width* | {doc}`/projections/cyl/cyl_miller` |
31-
| **Kf**[{{ lon0 }}/]*width* | {doc}`/projections/misc/misc_eckertIV` |
32-
| **Ks**[{{ lon0 }}/]*width* | {doc}`/projections/misc/misc_eckertVI` |
33-
| **L**{{ lon0 }}/{{ lat0 }}/{{ lat1 }}/{{ lat2 }}/*width* | {doc}`/projections/conic/conic_lambert` |
34-
| **M**[{{ lon0 }}/[{{ lat0 }}/]]*width* | {doc}`/projections/cyl/cyl_mercator` |
35-
| **N**[{{ lon0 }}/]*width* | {doc}`/projections/misc/misc_robinson` |
36-
| **Oa**{{ lon0 }}/{{ lat0 }}/*azimuth*/*width*[**+v**] | Oblique Mercator projection: {doc}`1. origin and azimuth </projections/cyl/cyl_oblique_mercator>` |
37-
| **Ob**{{ lon0 }}/{{ lat0 }}/{{ lon1 }}/{{ lat1 }}/*width*[**+v**] | Oblique Mercator projection: {doc}`2. two points </projections/cyl/cyl_oblique_mercator>` |
38-
| **Oc**{{ lon0 }}/{{ lat0 }}/{{ lonp }}/{{ latp }}/*width*[**+v**] | Oblique Mercator projection: {doc}`3. origin and projection pole </projections/cyl/cyl_oblique_mercator>` |
39-
| **P***width*[**+a**][**+f**[**e**\|**p**\|*radius*]][**+r***offset*][**+t***origin*][**+z**[**p**\|*radius*]] | Polar {doc}`azimuthal </projections/nongeo/polar>` ({math}`\theta, r`) or cylindrical |
40-
| **Poly**/[{{ lon0 }}/[{{ lat0 }}/]]*width* | {doc}`/projections/conic/polyconic` |
41-
| **Q**[{{ lon0 }}/[{{ lat0 }}/]]*width* | {doc}`/projections/cyl/cyl_equidistant` |
42-
| **R**[{{ lon0 }}/]*width* | {doc}`/projections/misc/misc_winkel_tripel` |
43-
| **S**{{ lon0 }}/{{ lat0 }}[/*horizon*]/*width* | {doc}`/projections/azim/azim_general_stereographic` |
44-
| **T**{{ lon0 }}[/{{ lat0 }}]/*width* | {doc}`/projections/cyl/cyl_transverse_mercator` |
45-
| **U***zone*/*width* | {doc}`/projections/cyl/cyl_universal_transverse_mercator` |
46-
| **V**[{{ lon0 }}/]*width* | {doc}`/projections/misc/misc_van_der_grinten` |
47-
| **W**[{{ lon0 }}/]*width* | {doc}`/projections/misc/misc_mollweide` |
48-
| **X***width*[**l**\|**p***exp*\|**T**\|**t**][/*height*[**l**\|**p***exp*\|**T**\|**t**]][**d**] | Cartesian {doc}`linear </projections/nongeo/cartesian_linear>`, {doc}`logarithmic </projections/nongeo/cartesian_logarithmic>`, {doc}`power </projections/nongeo/cartesian_power>`, and time |
49-
| **Y**{{ lon0 }}/{{ lat0 }}/*width* | {doc}`/projections/cyl/cyl_equal_area` |
19+
| **A**{{ lon0 }}/{{ lat0 }}[/*horizon*]/*width* | [](/projections/azim/azim_lambert.rst) |
20+
| **B**{{ lon0 }}/{{ lat0 }}/{{ lat1 }}/{{ lat2 }}/*width* | [](/projections/conic/conic_albers.rst) |
21+
| **C**{{ lon0 }}/{{ lat0 }}/*width* | [](/projections/cyl/cyl_cassini.rst) |
22+
| **Cyl_stere**/[{{ lon0 }}/[{{ lat0 }}/]]*width* | [](/projections/cyl/cyl_stereographic.rst) |
23+
| **D**{{ lon0 }}/{{ lat0 }}/{{ lat1 }}/{{ lat2 }}/*width* | [](/projections/conic/conic_equidistant.rst) |
24+
| **E**{{ lon0 }}/{{ lat0 }}[/*horizon*]/*width* | [](/projections/azim/azim_equidistant.rst) |
25+
| **F**{{ lon0 }}/{{ lat0 }}[/*horizon*]/*width* | [](/projections/azim/azim_gnomonic.rst) |
26+
| **G**{{ lon0 }}/{{ lat0 }}[/*horizon*]/*width* | [](/projections/azim/azim_orthographic.rst) |
27+
| **G**{{ lon0 }}/{{ lat0 }}/*width*[**+a***azimuth*][**+t***tilt*][**+v***vwidth*/*vheight*][**+w***twist*][**+z***altitude*] | [](/projections/azim/azim_general_perspective.rst) |
28+
| **H**[{{ lon0 }}/]*width* | [](/projections/misc/misc_hammer.rst) |
29+
| **I**[{{ lon0 }}/]*width* | [](/projections/misc/misc_sinusoidal.rst) |
30+
| **J**[{{ lon0 }}/]*width* | [](/projections/cyl/cyl_miller.rst) |
31+
| **Kf**[{{ lon0 }}/]*width* | [](/projections/misc/misc_eckertIV.rst) |
32+
| **Ks**[{{ lon0 }}/]*width* | [](/projections/misc/misc_eckertVI.rst) |
33+
| **L**{{ lon0 }}/{{ lat0 }}/{{ lat1 }}/{{ lat2 }}/*width* | [](/projections/conic/conic_lambert.rst) |
34+
| **M**[{{ lon0 }}/[{{ lat0 }}/]]*width* | [](/projections/cyl/cyl_mercator.rst) |
35+
| **N**[{{ lon0 }}/]*width* | [](/projections/misc/misc_robinson.rst) |
36+
| **Oa**{{ lon0 }}/{{ lat0 }}/*azimuth*/*width*[**+v**] | Oblique Mercator projection: [1. origin and azimuth](/projections/cyl/cyl_oblique_mercator.rst) |
37+
| **Ob**{{ lon0 }}/{{ lat0 }}/{{ lon1 }}/{{ lat1 }}/*width*[**+v**] | Oblique Mercator projection: [2. two points](/projections/cyl/cyl_oblique_mercator.rst) |
38+
| **Oc**{{ lon0 }}/{{ lat0 }}/{{ lonp }}/{{ latp }}/*width*[**+v**] | Oblique Mercator projection: [3. origin and projection pole](/projections/cyl/cyl_oblique_mercator.rst) |
39+
| **P***width*[**+a**][**+f**[**e**\|**p**\|*radius*]][**+r***offset*][**+t***origin*][**+z**[**p**\|*radius*]] | Polar [azimuthal](/projections/nongeo/polar.rst) ({math}`\theta, r`) or cylindrical |
40+
| **Poly**/[{{ lon0 }}/[{{ lat0 }}/]]*width* | [](/projections/conic/polyconic.rst) |
41+
| **Q**[{{ lon0 }}/[{{ lat0 }}/]]*width* | [](/projections/cyl/cyl_equidistant.rst) |
42+
| **R**[{{ lon0 }}/]*width* | [](/projections/misc/misc_winkel_tripel.rst) |
43+
| **S**{{ lon0 }}/{{ lat0 }}[/*horizon*]/*width* | [](/projections/azim/azim_general_stereographic.rst) |
44+
| **T**{{ lon0 }}[/{{ lat0 }}]/*width* | [](/projections/cyl/cyl_transverse_mercator.rst) |
45+
| **U***zone*/*width* | [](/projections/cyl/cyl_universal_transverse_mercator.rst) |
46+
| **V**[{{ lon0 }}/]*width* | [](/projections/misc/misc_van_der_grinten.rst) |
47+
| **W**[{{ lon0 }}/]*width* | [](/projections/misc/misc_mollweide.rst) |
48+
| **X***width*[**l**\|**p***exp*\|**T**\|**t**][/*height*[**l**\|**p***exp*\|**T**\|**t**]][**d**] | Cartesian [linear](/projections/nongeo/cartesian_linear.rst), [logarithmic](/projections/nongeo/cartesian_logarithmic.rst), [power](/projections/nongeo/cartesian_power.rst), and time |
49+
| **Y**{{ lon0 }}/{{ lat0 }}/*width* | [](/projections/cyl/cyl_equal_area.rst) |

0 commit comments

Comments
 (0)