Skip to content

Commit

Permalink
Update "cookbook" to "reference" for links to the GMT 6.5 documentati…
Browse files Browse the repository at this point in the history
…on (#2990)
  • Loading branch information
yvonnefroehlich authored Jan 12, 2024
1 parent 9b19167 commit 3526a13
Show file tree
Hide file tree
Showing 17 changed files with 32 additions and 32 deletions.
2 changes: 1 addition & 1 deletion examples/gallery/embellishments/colorbar.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
The :meth:`pygmt.Figure.colorbar` method creates a color scalebar.
The colormap is set via the ``cmap`` parameter. A full list of available
color palette tables can be found at :gmt-docs:`cookbook/cpts.html`.
color palette tables can be found at :gmt-docs:`reference/cpts.html`.
Use the ``frame`` parameter to add labels to the **x** and **y** axes
of the colorbar by appending **+l** followed by the desired text. To Add
and adjust the annotations (**a**) and ticks (**f**) append the letter
Expand Down
2 changes: 1 addition & 1 deletion examples/gallery/embellishments/colorbars_multiple.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
This gallery example shows how to create multiple colormaps for different
subplots. To better understand how GMT modern mode maintains several levels of
colormaps, please refer to
:gmt-docs:`cookbook/features.html#gmt-modern-mode-hierarchical-levels` for
:gmt-docs:`reference/features.html#gmt-modern-mode-hierarchical-levels` for
details.
"""

Expand Down
4 changes: 2 additions & 2 deletions examples/gallery/lines/linestyles.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
requested with ``"dashed"`` or ``"-"``. Also combinations of dots and dashes,
like ``".-"`` for a dot-dashed line, are allowed.
For more advanced *pen* attributes, see the GMT cookbook
:gmt-docs:`cookbook/features.html#wpen-attrib`.
For more advanced *pen* attributes, see the GMT Technical Reference
:gmt-docs:`reference/features.html#wpen-attrib`.
"""

Expand Down
2 changes: 1 addition & 1 deletion examples/gallery/symbols/custom_symbols.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
the ``style`` parameter. In total 41 custom symbols are already included of
which the following plot shows five exemplary ones. The symbols are shown
underneath their corresponding names. For the remaining symbols see the GMT
cookbook :gmt-docs:`cookbook/custom-symbols.html`.
Technical Reference :gmt-docs:`reference/custom-symbols.html`.
"""

# %%
Expand Down
2 changes: 1 addition & 1 deletion examples/gallery/symbols/patterns.py
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
:gmt-docs:`cookbook/predefined-patterns.html`.
:gmt-docs:`reference/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
6 changes: 3 additions & 3 deletions examples/gallery/symbols/text_symbols.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
as **+j**\ *justify* to change the justification [Default is CM]. The fill
color of the text symbols can be set with the ``fill`` parameter, and the
outline width can be customized with the ``pen`` parameter.
For all supported octal codes and fonts see the GMT cookbook
:gmt-docs:`cookbook/octal-codes.html` and
:gmt-docs:`cookbook/postscript-fonts.html`.
For all supported octal codes and fonts see the GMT Technical Reference
:gmt-docs:`reference/octal-codes.html` and
:gmt-docs:`reference/postscript-fonts.html`.
"""

# %%
Expand Down
2 changes: 1 addition & 1 deletion examples/get_started/02_contour_map.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
# the Earth relief. The :meth:`pygmt.Figure.grdimage` method uses the input
# grid to relate the Earth relief values to a specific color within the CPT.
# In this case, the CPT "oleron" is used; a full list of CPTs can be found
# at :gmt-docs:`cookbook/cpts.html`.
# at :gmt-docs:`reference/cpts.html`.

fig = pygmt.Figure()
fig.grdimage(grid=grid, frame="a", projection="M10c", cmap="oleron")
Expand Down
4 changes: 2 additions & 2 deletions examples/projections/nongeo/cartesian_linear.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@
floating point data. To plot geographical data in a linear
projection, see the upstream GMT documentation
:gmt-docs:`Geographic coordinates
<cookbook/coordinate-transformations.html#geographic-coordinates>`.
<reference/coordinate-transformations.html#geographic-coordinates>`.
To make the linear plot using calendar date/time as input
coordinates, see the GMT documentation
:gmt-docs:`Calendar time coordinates
<cookbook/coordinate-transformations.html#calendar-time-coordinates>`.
<reference/coordinate-transformations.html#calendar-time-coordinates>`.
"""

# %%
Expand Down
4 changes: 2 additions & 2 deletions examples/tutorials/advanced/earth_relief.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
# :meth:`pygmt.Figure.grdimage` can take the optional parameter ``projection``
# for the map. In the example below, ``projection`` is set to ``"R12c"`` for
# a 12-centimeters-wide figure with a Winkel Tripel projection. For a list
# of available projections, see :gmt-docs:`cookbook/map-projections.html`.
# of available projections, see :gmt-docs:`reference/map-projections.html`.

fig = pygmt.Figure()
fig.grdimage(grid=grid, projection="R12c")
Expand All @@ -47,7 +47,7 @@
#
# :meth:`pygmt.Figure.grdimage` takes the ``cmap`` parameter to set the CPT of
# the figure. Examples of common CPTs for Earth relief are shown below.
# A full list of CPTs can be found at :gmt-docs:`cookbook/cpts.html`.
# A full list of CPTs can be found at :gmt-docs:`reference/cpts.html`.

# %%
# Using the *geo* CPT:
Expand Down
6 changes: 3 additions & 3 deletions examples/tutorials/basics/text.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
# the ``font`` parameter.
#
# A list of all recognized fonts can be found at
# :gmt-docs:`PostScript Fonts Used by GMT <cookbook/postscript-fonts.html>`,
# :gmt-docs:`PostScript Fonts Used by GMT <reference/postscript-fonts.html>`,
# including details of how to use non-default fonts.

fig = pygmt.Figure()
Expand Down Expand Up @@ -151,7 +151,7 @@
#
# For crafting more advanced styles, including using special symbols and
# other character sets, be sure to check out the GMT documentation
# at :gmt-docs:`text.html` and also the cookbook at
# :gmt-docs:`cookbook/features.html#placement-of-text`. Good luck!
# at :gmt-docs:`text.html` and also the GMT Technical Reference at
# :gmt-docs:`reference/features.html#placement-of-text`. Good luck!

# sphinx_gallery_thumbnail_number = 3
2 changes: 1 addition & 1 deletion pygmt/helpers/decorators.py
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@
``registration``, and the domain. The resulting increment value
depends on whether you have selected a gridline-registered or
pixel-registered grid; see :gmt-docs:`GMT File Formats
<cookbook/file-formats.html#gmt-file-formats>` for details.
<reference/file-formats.html#gmt-file-formats>` for details.
**Note**: If ``region=grdfile`` is used then the grid spacing and
the registration have already been initialized; use ``spacing`` and
Expand Down
8 changes: 4 additions & 4 deletions pygmt/src/grd2cpt.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ def grd2cpt(grid, **kwargs):
figure, subplot, panel, or inset depending on which level
:func:`pygmt.grd2cpt` is called (for details on how GMT modern mode
maintains different levels of colormaps please see
:gmt-docs:`cookbook/features.html#gmt-modern-mode-hierarchical-levels`).
:gmt-docs:`reference/features.html#gmt-modern-mode-hierarchical-levels`).
You can use ``output`` to save the CPT to a file. The CPT is based on an
existing dynamic master CPT of your choice, and the mapping from data value
to colors is through the data's cumulative distribution function (CDF), so
Expand Down Expand Up @@ -87,7 +87,7 @@ def grd2cpt(grid, **kwargs):
cmap : str
Select the master color palette table (CPT) to use in the
interpolation. Full list of built-in color palette tables can be found
at :gmt-docs:`cookbook/cpts.html#built-in-color-palette-tables-cpt`.
at :gmt-docs:`reference/cpts.html#built-in-color-palette-tables-cpt`.
background : bool or str
Select the back- and foreground colors to match the colors for lowest
and highest *z*-values in the output CPT [Default (``background=True``
Expand Down Expand Up @@ -127,7 +127,7 @@ def grd2cpt(grid, **kwargs):
Truncate the incoming CPT so that the lowest and highest z-levels are
to *zlow* and *zhigh*. If one of these equal NaN then we leave that
end of the CPT alone. The truncation takes place before any resampling.
See also :gmt-docs:`cookbook/features.html#manipulating-cpts`.
See also :gmt-docs:`reference/features.html#manipulating-cpts`.
output : str
Optional. The file name with extension .cpt to store the generated CPT
file. If not given or ``False`` [Default], saves the CPT as the current
Expand All @@ -139,7 +139,7 @@ def grd2cpt(grid, **kwargs):
of z-values in the color table. Note that this change of z-direction
happens before ``truncate`` and ``series`` values are used so the
latter must be compatible with the changed z-range. See also
:gmt-docs:`cookbook/features.html#manipulating-cpts`.
:gmt-docs:`reference/features.html#manipulating-cpts`.
overrule_bg : str
Overrule background, foreground, and NaN colors specified in the master
CPT with the values of the parameters :gmt-term:`COLOR_BACKGROUND`,
Expand Down
8 changes: 4 additions & 4 deletions pygmt/src/makecpt.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ def makecpt(**kwargs):
figure, subplot, panel, or inset depending on which level
:func:`pygmt.makecpt` is called (for details on how GMT modern mode
maintains different levels of colormaps please see
:gmt-docs:`cookbook/features.html#gmt-modern-mode-hierarchical-levels`).
:gmt-docs:`reference/features.html#gmt-modern-mode-hierarchical-levels`).
You can use ``output`` to save the CPT to a file.
You define an equidistant
set of contour intervals or pass your own z-table or list, and create a new
Expand Down Expand Up @@ -76,7 +76,7 @@ def makecpt(**kwargs):
cmap : str
Select the master color palette table (CPT) to use in the
interpolation. Full list of built-in color palette tables can be found
at :gmt-docs:`cookbook/cpts.html#built-in-color-palette-tables-cpt`.
at :gmt-docs:`reference/cpts.html#built-in-color-palette-tables-cpt`.
background : bool or str
Select the back- and foreground colors to match the colors for lowest
and highest *z*-values in the output CPT [Default (``background=True``
Expand Down Expand Up @@ -112,7 +112,7 @@ def makecpt(**kwargs):
Truncate the incoming CPT so that the lowest and highest z-levels are
to *zlow* and *zhigh*. If one of these equal NaN then we leave that
end of the CPT alone. The truncation takes place before any resampling.
See also :gmt-docs:`cookbook/features.html#manipulating-cpts`.
See also :gmt-docs:`reference/features.html#manipulating-cpts`.
output : str
Optional. The file name with extension .cpt to store the generated CPT
file. If not given or ``False`` [Default], saves the CPT as the current
Expand All @@ -124,7 +124,7 @@ def makecpt(**kwargs):
of z-values in the color table. Note that this change of z-direction
happens before ``truncate`` and ``series`` values are used so the
latter must be compatible with the changed z-range. See also
:gmt-docs:`cookbook/features.html#manipulating-cpts`.
:gmt-docs:`reference/features.html#manipulating-cpts`.
overrule_bg : str
Overrule background, foreground, and NaN colors specified in the master
CPT with the values of the parameters :gmt-term:`COLOR_BACKGROUND`,
Expand Down
4 changes: 2 additions & 2 deletions pygmt/src/select.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ def select(data=None, outfile=None, **kwargs):
*linefile*\ **+d**\ *dist*\ [**+p**].
Pass all records whose locations are within *dist* of any of the line
segments in the ASCII :gmt-docs:`multiple-segment file
<cookbook/file-formats.html#optional-segment-header-records>`
<reference/file-formats.html#optional-segment-header-records>`
*linefile*. If *dist* is zero, we will scan each sub-header in
*linefile* for an embedded **-D**\ *dist* setting that sets each
line's individual distance value. Distances are Cartesian and in
Expand All @@ -104,7 +104,7 @@ def select(data=None, outfile=None, **kwargs):
*polygonfile*.
Pass all records whose locations are within one of the closed
polygons in the ASCII :gmt-docs:`multiple-segment file
<cookbook/file-formats.html#optional-segment-header-records>`
<reference/file-formats.html#optional-segment-header-records>`
*polygonfile*. For spherical polygons (lon, lat), make sure no
consecutive points are separated by 180 degrees or more in longitude.
resolution : str
Expand Down
2 changes: 1 addition & 1 deletion pygmt/src/shift_origin.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ def shift_origin(self, xshift=None, yshift=None):
move the origin relative to its current location.
Detailed usage at
:gmt-docs:`cookbook/options.html#plot-positioning-and-layout-the-x-y-options`
:gmt-docs:`reference/options.html#plot-positioning-and-layout-the-x-y-options`
Parameters
----------
Expand Down
2 changes: 1 addition & 1 deletion pygmt/src/text.py
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ def text_( # noqa: PLR0912
The text strings passed via the ``text`` parameter can contain ASCII
characters and non-ASCII characters defined in the ISOLatin1+ encoding
(i.e., IEC_8859-1), and the Symbol and ZapfDingbats character sets.
See :gmt-docs:`cookbook/octal-codes.html` for the full list of supported
See :gmt-docs:`reference/octal-codes.html` for the full list of supported
non-ASCII characters.
Full option list at :gmt-docs:`text.html`
Expand Down
4 changes: 2 additions & 2 deletions pygmt/src/velo.py
Original file line number Diff line number Diff line change
Expand Up @@ -181,13 +181,13 @@ def velo(self, data=None, **kwargs):
will be transparent. **Note**: Using ``cmap`` and ``zvalue="+e"``
will update the uncertainty fill color based on the selected measure
in ``zvalue`` [Default is magnitude error]. More details at
:gmt-docs:`cookbook/features.html#gfill-attrib`.
:gmt-docs:`reference/features.html#gfill-attrib`.
fill : str
Set color or pattern for filling symbols [Default is no fill].
**Note**: Using ``cmap`` (and optionally ``zvalue``) will update the
symbol fill color based on the selected measure in ``zvalue``
[Default is magnitude]. More details at
:gmt-docs:`cookbook/features.html#gfill-attrib`.
:gmt-docs:`reference/features.html#gfill-attrib`.
scale : float or bool
[*scale*].
Scale symbol sizes and pen widths on a per-record basis using the
Expand Down

0 comments on commit 3526a13

Please sign in to comment.