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.

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

Use :gmt-docs: instead of full links #2682

Merged
merged 5 commits into from
Sep 14, 2023
Merged

Use :gmt-docs: instead of full links #2682

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
069a06d
Use :gmt-docs: instead of full links
seisman Sep 11, 2023
afaed93
Check if gmt-docs works for image paths
seisman Sep 11, 2023
4e73907
Merge branch 'main' into use-gmt-docs
seisman Sep 12, 2023
6335be5
Revert "Check if gmt-docs works for image paths"
seisman Sep 12, 2023
8f73b5c
Fix the gmt-term link in contributing guides
seisman Sep 12, 2023
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
3 changes: 1 addition & 2 deletions doc/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -456,8 +456,7 @@ Linking to the GMT documentation and GMT configuration parameters can be done us
An example would be using
<code>:gmt-docs:\`makecpt.html\`</code> to link to {gmt-docs}`makecpt.html`.
For GMT configuration parameters, an example is
<code>:gmt-term:\`COLOR_FOREGROUND\`</code> to link to
{gmt-term}`https://docs.generic-mapping-tools.org/latest/gmt.conf#term-COLOR_FOREGROUND <COLOR_FOREGROUND>`.
<code>:gmt-term:\`COLOR_FOREGROUND\`</code> to link to {gmt-term}`COLOR_FOREGROUND`.

Sphinx will create a link to the automatically generated page for that
function/class/module/method.
Expand Down
2 changes: 1 addition & 1 deletion examples/gallery/embellishments/legend.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
with instructions for the layout of the legend items and pass it
to the ``spec`` parameter of :meth:`pygmt.Figure.legend`. For details on
how to set up such a file, please see the GMT documentation at
https://docs.generic-mapping-tools.org/latest/legend.html#legend-codes.
:gmt-docs:`legend.html#legend-codes`.
"""

# %%
Expand Down
2 changes: 1 addition & 1 deletion examples/gallery/lines/decorated_lines.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
For modifying the main decorated line via the ``pen`` parameter,
see the :doc:`Line styles example </gallery/lines/linestyles>`.
For details on the input data see the upstream GMT documentation
at https://docs.generic-mapping-tools.org/latest/plot.html#s.
at :gmt-docs:`plot.html#s`.
Furthermore, there are so-called *line fronts*, which are often
used to plot fault lines, subduction zones, or weather fronts;
for details see the
Expand Down
2 changes: 1 addition & 1 deletion examples/gallery/lines/quoted_lines.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
For modifying the main quoted line via the ``pen`` parameter,
see the :doc:`Line styles example </gallery/lines/linestyles>`.
For details on the input data see the upstream GMT documentation
at https://docs.generic-mapping-tools.org/latest/plot.html#s.
at :gmt-docs:`plot.html#s`.
"""

# %%
Expand Down
2 changes: 1 addition & 1 deletion examples/gallery/symbols/patterns.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
*pattern* can either be a number in the range 1-90 or the name of a
1-, 8-, or 24-bit image raster file. The former will result in one of the 90
predefined 64 x 64 bit-patterns provided by GMT; an overview can by found at
https://docs.generic-mapping-tools.org/latest/cookbook/predefined-patterns.html.
:gmt-docs:`cookbook/predefined-patterns.html`.
The latter allows the user to create customized, repeating images using image
raster files.
By specifying upper case **P** instead of **p** the image will be
Expand Down