DOC: Improve link to the GMT documentation (#3944)

seisman · web-flow · commit e8907382d85b · 2025-05-24T16:25:43.000+08:00
diff --git a/pygmt/src/basemap.py b/pygmt/src/basemap.py
@@ -36,7 +36,7 @@ def basemap(self, **kwargs):
     At least one of the parameters ``frame``, ``map_scale``, ``rose``, or
     ``compass`` must be specified if not in subplot mode.
 
-    Full option list at :gmt-docs:`basemap.html`
+    Full GMT docs at :gmt-docs:`basemap.html`.
 
     {aliases}
 
diff --git a/pygmt/src/binstats.py b/pygmt/src/binstats.py
@@ -39,7 +39,7 @@ def binstats(
     presented as is or may be normalized by the circle area to
     perhaps give density estimates.
 
-    Full option list at :gmt-docs:`gmtbinstats.html`
+    Full GMT docs at :gmt-docs:`gmtbinstats.html`.
 
     {aliases}
 
diff --git a/pygmt/src/blockm.py b/pygmt/src/blockm.py
@@ -108,7 +108,7 @@ def blockmean(
 
     Must provide either ``data`` or ``x``, ``y``, and ``z``.
 
-    Full option list at :gmt-docs:`blockmean.html`
+    Full GMT docs at :gmt-docs:`blockmean.html`.
 
     {aliases}
 
@@ -212,7 +212,7 @@ def blockmedian(
 
     Must provide either ``data`` or ``x``, ``y``, and ``z``.
 
-    Full option list at :gmt-docs:`blockmedian.html`
+    Full GMT docs at :gmt-docs:`blockmedian.html`.
 
     {aliases}
 
@@ -310,7 +310,7 @@ def blockmode(
 
     Must provide either ``data`` or ``x``, ``y``, and ``z``.
 
-    Full option list at :gmt-docs:`blockmode.html`
+    Full GMT docs at :gmt-docs:`blockmode.html`.
 
     {aliases}
 
diff --git a/pygmt/src/coast.py b/pygmt/src/coast.py
@@ -55,7 +55,7 @@ def coast(self, **kwargs):
 
     A map projection must be supplied.
 
-    Full option list at :gmt-docs:`coast.html`
+    Full GMT docs at :gmt-docs:`coast.html`.
 
     {aliases}
 
diff --git a/pygmt/src/colorbar.py b/pygmt/src/colorbar.py
@@ -42,7 +42,7 @@ def colorbar(self, **kwargs):
     linear scale, all be equal size, or by providing a file with individual
     tile widths.
 
-    Full option list at :gmt-docs:`colorbar.html`
+    Full GMT docs at :gmt-docs:`colorbar.html`.
 
     {aliases}
 
diff --git a/pygmt/src/contour.py b/pygmt/src/contour.py
@@ -49,7 +49,7 @@ def contour(
 
     Must provide either ``data`` or ``x``, ``y``, and ``z``.
 
-    Full option list at :gmt-docs:`contour.html`
+    Full GMT docs at :gmt-docs:`contour.html`.
 
     {aliases}
 
diff --git a/pygmt/src/dimfilter.py b/pygmt/src/dimfilter.py
@@ -43,7 +43,7 @@ def dimfilter(
     Thus, an additional filtering (e.g., Gaussian via :func:`pygmt.grdfilter`)
     of the DiM-filtered data is generally recommended.
 
-    Full option list at :gmt-docs:`dimfilter.html`
+    Full GMT docs at :gmt-docs:`dimfilter.html`.
 
     {aliases}
 
diff --git a/pygmt/src/filter1d.py b/pygmt/src/filter1d.py
@@ -40,7 +40,7 @@ def filter1d(
     Read a table and output as a :class:`numpy.ndarray`,
     :class:`pandas.DataFrame`, or ASCII file.
 
-    Full option list at :gmt-docs:`filter1d.html`
+    Full GMT docs at :gmt-docs:`filter1d.html`.
 
     {aliases}
 
diff --git a/pygmt/src/grd2cpt.py b/pygmt/src/grd2cpt.py
@@ -75,7 +75,7 @@ def grd2cpt(grid: PathLike | xr.DataArray, **kwargs):
     :gmt-docs:`gmt.conf <gmt.conf>` file or the ``color_model`` parameter
     will be used.
 
-    Full option list at :gmt-docs:`grd2cpt.html`
+    Full GMT docs at :gmt-docs:`grd2cpt.html`.
 
     {aliases}
 
diff --git a/pygmt/src/grd2xyz.py b/pygmt/src/grd2xyz.py
@@ -48,7 +48,7 @@ def grd2xyz(
     Read a grid and output xyz-triplets as a :class:`numpy.ndarray`,
     :class:`pandas.DataFrame`, or ASCII file.
 
-    Full option list at :gmt-docs:`grd2xyz.html`
+    Full GMT docs at :gmt-docs:`grd2xyz.html`.
 
     {aliases}
 
diff --git a/pygmt/src/grdclip.py b/pygmt/src/grdclip.py
@@ -135,7 +135,7 @@ def grdclip(
     values is required, or for reclassification of data values. The values can be any
     number or NaN (Not a Number).
 
-    Full option list at :gmt-docs:`grdclip.html`
+    Full GMT docs at :gmt-docs:`grdclip.html`.
 
     {aliases}
 
diff --git a/pygmt/src/grdcontour.py b/pygmt/src/grdcontour.py
@@ -44,7 +44,7 @@ def grdcontour(self, grid: PathLike | xr.DataArray, **kwargs):
 
     Takes a grid file name or an :class:`xarray.DataArray` object as input.
 
-    Full option list at :gmt-docs:`grdcontour.html`
+    Full GMT docs at :gmt-docs:`grdcontour.html`.
 
     {aliases}
 
diff --git a/pygmt/src/grdcut.py b/pygmt/src/grdcut.py
@@ -48,7 +48,7 @@ def grdcut(
     to determine the corresponding rectangular ``region`` that will give a grid
     that fully covers the oblique domain.
 
-    Full option list at :gmt-docs:`grdcut.html`
+    Full GMT docs at :gmt-docs:`grdcut.html`.
 
     {aliases}
 
diff --git a/pygmt/src/grdfill.py b/pygmt/src/grdfill.py
@@ -131,7 +131,7 @@ def grdfill(
     replace the hole values. If no holes are found the original unchanged grid is
     returned.
 
-    Full option list at :gmt-docs:`grdfill.html`.
+    Full GMT docs at :gmt-docs:`grdfill.html`.
 
     {aliases}
 
diff --git a/pygmt/src/grdfilter.py b/pygmt/src/grdfilter.py
@@ -38,7 +38,7 @@ def grdfilter(
     half-width of the input edges. If the filter is low-pass, then the output
     may be less frequently sampled than the input.
 
-    Full option list at :gmt-docs:`grdfilter.html`
+    Full GMT docs at :gmt-docs:`grdfilter.html`.
 
     {aliases}
 
diff --git a/pygmt/src/grdgradient.py b/pygmt/src/grdgradient.py
@@ -40,7 +40,7 @@ def grdgradient(
     Can accept ``azimuth``, ``direction``, and ``radiance`` input to create
     the resulting gradient.
 
-    Full option list at :gmt-docs:`grdgradient.html`
+    Full GMT docs at :gmt-docs:`grdgradient.html`.
 
     {aliases}
 
diff --git a/pygmt/src/grdhisteq.py b/pygmt/src/grdhisteq.py
@@ -75,7 +75,7 @@ def equalize_grid(
         the ``grid``, but the values are changed to reflect their place in the
         cumulative distribution.
 
-        Full option list at :gmt-docs:`grdhisteq.html`
+        Full GMT docs at :gmt-docs:`grdhisteq.html`.
 
         {aliases}
 
@@ -168,7 +168,7 @@ def compute_bins(
         image with :meth:`pygmt.Figure.grdimage` that has all levels of gray
         occurring equally.
 
-        Full option list at :gmt-docs:`grdhisteq.html`
+        Full GMT docs at :gmt-docs:`grdhisteq.html`.
 
         {aliases}
 
diff --git a/pygmt/src/grdimage.py b/pygmt/src/grdimage.py
@@ -70,7 +70,7 @@ def grdimage(self, grid: PathLike | xr.DataArray, **kwargs):
     The ``region`` parameter can be used to select a map region larger or
     smaller than that implied by the extent of the grid.
 
-    Full option list at :gmt-docs:`grdimage.html`
+    Full GMT docs at :gmt-docs:`grdimage.html`.
 
     {aliases}
 
diff --git a/pygmt/src/grdinfo.py b/pygmt/src/grdinfo.py
@@ -34,7 +34,7 @@ def grdinfo(grid: PathLike | xr.DataArray, **kwargs) -> str:
 
     Can read the grid from a file or given as an :class:`xarray.DataArray` grid.
 
-    Full option list at :gmt-docs:`grdinfo.html`
+    Full GMT docs at :gmt-docs:`grdinfo.html`.
 
     {aliases}
 
diff --git a/pygmt/src/grdlandmask.py b/pygmt/src/grdlandmask.py
@@ -34,7 +34,7 @@ def grdlandmask(outgrid: PathLike | None = None, **kwargs) -> xr.DataArray | Non
     water, or (2) the more detailed (hierarchical) ocean vs land vs lake vs island vs
     pond. A mask grid is created with the specified grid spacing.
 
-    Full option list at :gmt-docs:`grdlandmask.html`
+    Full GMT docs at :gmt-docs:`grdlandmask.html`.
 
     {aliases}
 
diff --git a/pygmt/src/grdproject.py b/pygmt/src/grdproject.py
@@ -47,7 +47,7 @@ def grdproject(
     set to NaN. The ``region`` parameter can be used to select a map region
     large or smaller than that implied by the extent of the grid file.
 
-    Full option list at :gmt-docs:`grdproject.html`
+    Full GMT docs at :gmt-docs:`grdproject.html`.
 
     {aliases}
 
diff --git a/pygmt/src/grdsample.py b/pygmt/src/grdsample.py
@@ -41,7 +41,7 @@ def grdsample(
     ``translate`` can be used to change the grid registration. When omitted,
     the output grid will have the same registration as the input grid.
 
-    Full option list at :gmt-docs:`grdsample.html`
+    Full GMT docs at :gmt-docs:`grdsample.html`.
 
     {aliases}
 
diff --git a/pygmt/src/grdtrack.py b/pygmt/src/grdtrack.py
@@ -74,7 +74,7 @@ def grdtrack(
     derivative normal to edge is zero) unless the grid is automatically
     recognized as periodic.)
 
-    Full option list at :gmt-docs:`grdtrack.html`
+    Full GMT docs at :gmt-docs:`grdtrack.html`.
 
     {aliases}
 
diff --git a/pygmt/src/grdview.py b/pygmt/src/grdview.py
@@ -43,7 +43,7 @@ def grdview(self, grid: PathLike | xr.DataArray, **kwargs):
     set on top of a surface, plotting of contours on top of the surface, and apply
     artificial illumination based on intensities provided in a separate grid file.
 
-    Full option list at :gmt-docs:`grdview.html`
+    Full GMT docs at :gmt-docs:`grdview.html`.
 
     {aliases}
 
diff --git a/pygmt/src/grdvolume.py b/pygmt/src/grdvolume.py
@@ -43,7 +43,7 @@ def grdvolume(
     (volume/area). Alternatively, a range of contours can be specified to
     return the volume and area inside the contour for all contour values.
 
-    Full option list at :gmt-docs:`grdvolume.html`
+    Full GMT docs at :gmt-docs:`grdvolume.html`.
 
     {aliases}
 
diff --git a/pygmt/src/histogram.py b/pygmt/src/histogram.py
@@ -44,7 +44,7 @@ def histogram(self, data: PathLike | TableLike, **kwargs):
     r"""
     Calculate and plot histograms.
 
-    Full option list at :gmt-docs:`histogram.html`
+    Full GMT docs at :gmt-docs:`histogram.html`.
 
     {aliases}
 
diff --git a/pygmt/src/image.py b/pygmt/src/image.py
@@ -28,7 +28,7 @@ def image(self, imagefile: PathLike, **kwargs):
     Reads an Encapsulated PostScript file or a raster image file and plots
     it on a map.
 
-    Full option list at :gmt-docs:`image.html`
+    Full GMT docs at :gmt-docs:`image.html`.
 
     {aliases}
 
diff --git a/pygmt/src/info.py b/pygmt/src/info.py
@@ -43,7 +43,7 @@ def info(data: PathLike | TableLike, **kwargs) -> np.ndarray | str:
     parameter ``nearest_multiple`` will provide a :class:`numpy.ndarray` in the form
     of [*zmin*, *zmax*, *dz*] for makecpt.
 
-    Full option list at :gmt-docs:`gmtinfo.html`
+    Full GMT docs at :gmt-docs:`gmtinfo.html`.
 
     {aliases}
 
diff --git a/pygmt/src/inset.py b/pygmt/src/inset.py
@@ -30,7 +30,7 @@ def inset(self, **kwargs):
     inside of the larger figure. Plotting methods that are called within the
     context manager are added to the inset figure.
 
-    Full option list at :gmt-docs:`inset.html`
+    Full GMT docs at :gmt-docs:`inset.html`.
 
     {aliases}
 
diff --git a/pygmt/src/legend.py b/pygmt/src/legend.py
@@ -45,7 +45,7 @@ def legend(
     noted, annotations will be made using the primary annotation font and
     size in effect (i.e., :gmt-term:`FONT_ANNOT_PRIMARY`).
 
-    Full option list at :gmt-docs:`legend.html`
+    Full GMT docs at :gmt-docs:`legend.html`.
 
     {aliases}
 
diff --git a/pygmt/src/logo.py b/pygmt/src/logo.py
@@ -27,7 +27,7 @@ def logo(self, **kwargs):
     Use various options to change this and to place a transparent or
     opaque rectangular map panel behind the GMT logo.
 
-    Full option list at :gmt-docs:`gmtlogo.html`.
+    Full GMT docs at :gmt-docs:`gmtlogo.html`.
 
     {aliases}
 
diff --git a/pygmt/src/makecpt.py b/pygmt/src/makecpt.py
@@ -64,7 +64,7 @@ def makecpt(**kwargs):
     master CPT, the :gmt-term:`COLOR_MODEL` specified in the
     :gmt-docs:`gmt.conf <gmt.conf>` file will be used.
 
-    Full option list at :gmt-docs:`makecpt.html`
+    Full GMT docs at :gmt-docs:`makecpt.html`.
 
     {aliases}
 
diff --git a/pygmt/src/meca.py b/pygmt/src/meca.py
@@ -194,7 +194,7 @@ def meca(  # noqa: PLR0913
          - | values in :math:`10 ^ {{exponent}}` dyn cm;
            | azimuths and plunges in degrees
 
-    Full option list at :gmt-docs:`supplements/seis/meca.html`
+    Full GMT docs at :gmt-docs:`supplements/seis/meca.html`.
 
     {aliases}
 
diff --git a/pygmt/src/nearneighbor.py b/pygmt/src/nearneighbor.py
@@ -72,7 +72,7 @@ def nearneighbor(
 
     Must provide either ``data`` or ``x``, ``y``, and ``z``.
 
-    Full option list at :gmt-docs:`nearneighbor.html`
+    Full GMT docs at :gmt-docs:`nearneighbor.html`.
 
     {aliases}
 
diff --git a/pygmt/src/plot.py b/pygmt/src/plot.py
@@ -83,7 +83,7 @@ def plot(  # noqa: PLR0912
     polygon outline is drawn or not. If a symbol is selected, ``fill`` and
     ``pen`` determine the fill and outline/no outline, respectively.
 
-    Full option list at :gmt-docs:`plot.html`
+    Full GMT docs at :gmt-docs:`plot.html`.
 
     {aliases}
 
diff --git a/pygmt/src/plot3d.py b/pygmt/src/plot3d.py
@@ -85,7 +85,7 @@ def plot3d(  # noqa: PLR0912
     polygon outline is drawn or not. If a symbol is selected, ``fill`` and
     ``pen`` determine the fill and outline/no outline, respectively.
 
-    Full option list at :gmt-docs:`plot3d.html`
+    Full GMT docs at :gmt-docs:`plot3d.html`.
 
     {aliases}
 
diff --git a/pygmt/src/project.py b/pygmt/src/project.py
@@ -107,7 +107,7 @@ def project(
     back-azimuths or azimuths are better done using :gmt-docs:`mapproject` as
     project is strictly spherical.
 
-    Full option list at :gmt-docs:`project.html`
+    Full GMT docs at :gmt-docs:`project.html`.
 
     {aliases}
 
diff --git a/pygmt/src/psconvert.py b/pygmt/src/psconvert.py
@@ -34,7 +34,7 @@ def psconvert(self, **kwargs):
     (see :class:`pygmt.Figure`). In this case, an output name must be given
     using parameter ``prefix``.
 
-    Full option list at :gmt-docs:`psconvert.html`
+    Full GMT docs at :gmt-docs:`psconvert.html`.
 
     {aliases}
 
diff --git a/pygmt/src/rose.py b/pygmt/src/rose.py
@@ -59,7 +59,7 @@ def rose(
     of the windrose is drawn with the same color as
     :gmt-term:`MAP_DEFAULT_PEN`.
 
-    Full option list at :gmt-docs:`rose.html`
+    Full GMT docs at :gmt-docs:`rose.html`.
 
     {aliases}
 
diff --git a/pygmt/src/select.py b/pygmt/src/select.py
@@ -70,7 +70,7 @@ def select(
     The sense of the tests can be reversed for each of these 7 criteria by
     using the ``reverse`` parameter.
 
-    Full option list at :gmt-docs:`gmtselect.html`
+    Full GMT docs at :gmt-docs:`gmtselect.html`.
 
     {aliases}
 
diff --git a/pygmt/src/solar.py b/pygmt/src/solar.py
@@ -37,7 +37,7 @@ def solar(
     This function plots the day-night terminator. Alternatively, it can plot the
     terminators for civil twilight, nautical twilight, or astronomical twilight.
 
-    Full option list at :gmt-docs:`solar.html`
+    Full GMT docs at :gmt-docs:`solar.html`.
 
     {aliases}
 
diff --git a/pygmt/src/sph2grd.py b/pygmt/src/sph2grd.py
diff --git a/pygmt/src/sphdistance.py b/pygmt/src/sphdistance.py
diff --git a/pygmt/src/sphinterpolate.py b/pygmt/src/sphinterpolate.py
diff --git a/pygmt/src/subplot.py b/pygmt/src/subplot.py
diff --git a/pygmt/src/surface.py b/pygmt/src/surface.py
diff --git a/pygmt/src/ternary.py b/pygmt/src/ternary.py
diff --git a/pygmt/src/text.py b/pygmt/src/text.py
diff --git a/pygmt/src/triangulate.py b/pygmt/src/triangulate.py
diff --git a/pygmt/src/velo.py b/pygmt/src/velo.py
diff --git a/pygmt/src/which.py b/pygmt/src/which.py
diff --git a/pygmt/src/wiggle.py b/pygmt/src/wiggle.py
diff --git a/pygmt/src/x2sys_cross.py b/pygmt/src/x2sys_cross.py
diff --git a/pygmt/src/x2sys_init.py b/pygmt/src/x2sys_init.py
diff --git a/pygmt/src/xyz2grd.py b/pygmt/src/xyz2grd.py
