From 86d731a3ad2c7eb5b3d0eb038872e70761b0843e Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Sat, 10 May 2025 17:40:03 +0800 Subject: [PATCH 1/5] DOC: Improve link to the GMT documentation. --- pygmt/src/grdfill.py | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/pygmt/src/grdfill.py b/pygmt/src/grdfill.py index a45b21cebbd..bdec632e5a6 100644 --- a/pygmt/src/grdfill.py +++ b/pygmt/src/grdfill.py @@ -125,14 +125,17 @@ def grdfill( r""" Interpolate across holes in a grid. + .. note:: + + Wraps the GMT module ``grdfill``. + The GMT documentation is at :gmt-docs:`grdfill.html`. + Read a grid that presumably has unfilled holes that the user wants to fill in some fashion. Holes are identified by NaN values but this criteria can be changed via the ``hole`` parameter. There are several different algorithms that can be used to replace the hole values. If no holes are found the original unchanged grid is returned. - Full option list at :gmt-docs:`grdfill.html`. - {aliases} Parameters From f6fd3e914c5634372fee8ec9fe4ef7ebd92d519c Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Mon, 12 May 2025 15:55:56 +0800 Subject: [PATCH 2/5] Use shorter version. --- pygmt/src/grdfill.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/pygmt/src/grdfill.py b/pygmt/src/grdfill.py index bdec632e5a6..5bd8d92c4bf 100644 --- a/pygmt/src/grdfill.py +++ b/pygmt/src/grdfill.py @@ -127,8 +127,7 @@ def grdfill( .. note:: - Wraps the GMT module ``grdfill``. - The GMT documentation is at :gmt-docs:`grdfill.html`. + Wraps the GMT module :gmt-docs:`grdfill `. Read a grid that presumably has unfilled holes that the user wants to fill in some fashion. Holes are identified by NaN values but this criteria can be changed via the From fbe8b0bc373b0501a97334eb094ce7028dc67c57 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Wed, 14 May 2025 15:52:56 +0800 Subject: [PATCH 3/5] New style --- pygmt/src/grdfill.py | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/pygmt/src/grdfill.py b/pygmt/src/grdfill.py index 5bd8d92c4bf..e184bbf7353 100644 --- a/pygmt/src/grdfill.py +++ b/pygmt/src/grdfill.py @@ -125,16 +125,14 @@ def grdfill( r""" Interpolate across holes in a grid. - .. note:: - - Wraps the GMT module :gmt-docs:`grdfill `. - Read a grid that presumably has unfilled holes that the user wants to fill in some fashion. Holes are identified by NaN values but this criteria can be changed via the ``hole`` parameter. There are several different algorithms that can be used to replace the hole values. If no holes are found the original unchanged grid is returned. + Wraps GMT module ``grdfill``, with full docs at :gmt-docs:`grdfill.html`. + {aliases} Parameters From 8cd4d3c72e4c57eb59b00733b3679d5b08548531 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Thu, 22 May 2025 10:57:17 +0800 Subject: [PATCH 4/5] Shorter version --- pygmt/src/grdfill.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pygmt/src/grdfill.py b/pygmt/src/grdfill.py index e184bbf7353..eae3af0e59a 100644 --- 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. - Wraps GMT module ``grdfill``, with full docs at :gmt-docs:`grdfill.html`. + Full GMT docs at :gmt-docs:`grdfill.html`. {aliases} From c53f2c99df789bb0eb7e79ff7f2c1ee548dc83ef Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Sat, 24 May 2025 12:10:56 +0800 Subject: [PATCH 5/5] Rephrase 'Full option list at' to 'Full GMT docs at' --- pygmt/src/basemap.py | 2 +- pygmt/src/binstats.py | 2 +- pygmt/src/blockm.py | 6 +++--- pygmt/src/coast.py | 2 +- pygmt/src/colorbar.py | 2 +- pygmt/src/contour.py | 2 +- pygmt/src/dimfilter.py | 2 +- pygmt/src/filter1d.py | 2 +- pygmt/src/grd2cpt.py | 2 +- pygmt/src/grd2xyz.py | 2 +- pygmt/src/grdclip.py | 2 +- pygmt/src/grdcontour.py | 2 +- pygmt/src/grdcut.py | 2 +- pygmt/src/grdfilter.py | 2 +- pygmt/src/grdgradient.py | 2 +- pygmt/src/grdhisteq.py | 4 ++-- pygmt/src/grdimage.py | 2 +- pygmt/src/grdinfo.py | 2 +- pygmt/src/grdlandmask.py | 2 +- pygmt/src/grdproject.py | 2 +- pygmt/src/grdsample.py | 2 +- pygmt/src/grdtrack.py | 2 +- pygmt/src/grdview.py | 2 +- pygmt/src/grdvolume.py | 2 +- pygmt/src/histogram.py | 2 +- pygmt/src/image.py | 2 +- pygmt/src/info.py | 2 +- pygmt/src/inset.py | 2 +- pygmt/src/legend.py | 2 +- pygmt/src/logo.py | 2 +- pygmt/src/makecpt.py | 2 +- pygmt/src/meca.py | 2 +- pygmt/src/nearneighbor.py | 2 +- pygmt/src/plot.py | 2 +- pygmt/src/plot3d.py | 2 +- pygmt/src/project.py | 2 +- pygmt/src/psconvert.py | 2 +- pygmt/src/rose.py | 2 +- pygmt/src/select.py | 2 +- pygmt/src/solar.py | 2 +- pygmt/src/sph2grd.py | 2 +- pygmt/src/sphdistance.py | 2 +- pygmt/src/sphinterpolate.py | 2 +- pygmt/src/subplot.py | 2 +- pygmt/src/surface.py | 2 +- pygmt/src/ternary.py | 2 +- pygmt/src/text.py | 2 +- pygmt/src/triangulate.py | 4 ++-- pygmt/src/velo.py | 2 +- pygmt/src/which.py | 2 +- pygmt/src/wiggle.py | 2 +- pygmt/src/x2sys_cross.py | 2 +- pygmt/src/x2sys_init.py | 2 +- pygmt/src/xyz2grd.py | 2 +- 54 files changed, 58 insertions(+), 58 deletions(-) diff --git a/pygmt/src/basemap.py b/pygmt/src/basemap.py index b083d8143b6..2515da61c38 100644 --- 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 index 130aeffcd58..18711451cb0 100644 --- 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 index 6c32331d298..0ef5510f4fa 100644 --- 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 index 53d8db97bf4..ec55a7acdb3 100644 --- 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 index 7ae261ac29a..a34789a32f7 100644 --- 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 index b5b95a20c16..0527f364ac4 100644 --- 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 index 3eebd84e09c..28a83584c8d 100644 --- 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 index 7035b31d823..e0ed391f096 100644 --- 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 index e3deeea81c6..53ee1aec6c2 100644 --- 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 ` 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 index ebee2a4f03f..f77d6a6955d 100644 --- 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 index 2ca8b8da06b..58ce6bd1e70 100644 --- 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 index 04862ad2ad1..6b5f6d65901 100644 --- 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 index 0ddf91193b6..2d5b1f0e5c9 100644 --- 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/grdfilter.py b/pygmt/src/grdfilter.py index 0e0a04d7e96..93653da737c 100644 --- 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 index b1a74eadce1..e014edf9da6 100644 --- 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 index 3c638340780..bcca0aa232f 100644 --- 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 index edfe7ad0866..2b61d87b945 100644 --- 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 index c91af944f32..97eb070bb2d 100644 --- 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 index 69178882922..b5b3dbaf945 100644 --- a/pygmt/src/grdlandmask.py +++ b/pygmt/src/grdlandmask.py @@ -35,7 +35,7 @@ def grdlandmask(outgrid: PathLike | None = None, **kwargs) -> xr.DataArray | Non (2) the more detailed (hierarchical) ocean vs land vs lake vs island vs pond. - 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 index dc0a6f7d464..41a11b3c875 100644 --- 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 index 619b35eaf64..be5a8d2bcf2 100644 --- 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 index a7bb1c96c8b..23106a10217 100644 --- 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 index 8459b4beeb3..b98a19f4cb0 100644 --- 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 index e390ac25ee2..b8833016996 100644 --- 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 index a74c5f04693..0a546703108 100644 --- 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 index 84c1923e54f..2e044b318ff 100644 --- 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 index bc3ca2f6eb0..2a05f6df0ce 100644 --- 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 index be0e4b40cce..76f577b285a 100644 --- 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 index 10cc69e3843..2cb2eddcf95 100644 --- 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 index 0a3f394b79e..d65bf3bc775 100644 --- 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 index 97a09269ecd..41fae86010c 100644 --- 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 ` 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 index 797a2f1facb..4a576ce0e51 100644 --- 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 index 118eba785b0..1a83a82c3b5 100644 --- 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 index 33017624245..35dab4aa009 100644 --- 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 index 3533a952a28..491ebbcf9df 100644 --- 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 index d4986806b4a..925f4e66449 100644 --- 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 index 2524060a0a6..9514d963ed6 100644 --- 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 index 09c723de773..c99e0ecd09a 100644 --- 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 index 35acb429e0a..e79b08c41e7 100644 --- 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 index 96fada2b918..4b284b08ce8 100644 --- 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 index 020a0655fae..a764bd231fc 100644 --- a/pygmt/src/sph2grd.py +++ b/pygmt/src/sph2grd.py @@ -32,7 +32,7 @@ def sph2grd( C[L,M], S[L,M] and evaluates the spherical harmonic model on the specified grid. - Full option list at :gmt-docs:`sph2grd.html` + Full GMT docs at :gmt-docs:`sph2grd.html`. {aliases} diff --git a/pygmt/src/sphdistance.py b/pygmt/src/sphdistance.py index 07bd177a2a1..bec132b3ed8 100644 --- a/pygmt/src/sphdistance.py +++ b/pygmt/src/sphdistance.py @@ -40,7 +40,7 @@ def sphdistance( then processed to calculate the nearest distance to each node of the lattice and written to the specified grid. - Full option list at :gmt-docs:`sphdistance.html` + Full GMT docs at :gmt-docs:`sphdistance.html`. {aliases} diff --git a/pygmt/src/sphinterpolate.py b/pygmt/src/sphinterpolate.py index bf8a5c74825..0b6a3430dc9 100644 --- a/pygmt/src/sphinterpolate.py +++ b/pygmt/src/sphinterpolate.py @@ -29,7 +29,7 @@ def sphinterpolate( global gradient estimation or optimize the tension selection to satisfy one of four criteria. - Full option list at :gmt-docs:`sphinterpolate.html` + Full GMT docs at :gmt-docs:`sphinterpolate.html`. {aliases} diff --git a/pygmt/src/subplot.py b/pygmt/src/subplot.py index f96bde809b5..4b91bc20432 100644 --- a/pygmt/src/subplot.py +++ b/pygmt/src/subplot.py @@ -41,7 +41,7 @@ def subplot(self, nrows=1, ncols=1, **kwargs): parameters are available to specify the systematic layout, labeling, dimensions, and more for the subplots. - Full option list at :gmt-docs:`subplot.html#synopsis-begin-mode` + Full GMT docs at :gmt-docs:`subplot.html#synopsis-begin-mode`. {aliases} diff --git a/pygmt/src/surface.py b/pygmt/src/surface.py index d33027b5b7c..2c9684a6676 100644 --- a/pygmt/src/surface.py +++ b/pygmt/src/surface.py @@ -69,7 +69,7 @@ def surface( Must provide either ``data`` or ``x``, ``y``, and ``z``. - Full option list at :gmt-docs:`surface.html` + Full GMT docs at :gmt-docs:`surface.html`. {aliases} diff --git a/pygmt/src/ternary.py b/pygmt/src/ternary.py index 2880894d2bc..5b75bf4b78d 100644 --- a/pygmt/src/ternary.py +++ b/pygmt/src/ternary.py @@ -43,7 +43,7 @@ def ternary( last column in the input. If ``style`` is not specified then we instead plot lines or polygons. - Full option list at :gmt-docs:`ternary.html` + Full GMT docs at :gmt-docs:`ternary.html`. {aliases} diff --git a/pygmt/src/text.py b/pygmt/src/text.py index 6869bee2beb..34c70734d52 100644 --- a/pygmt/src/text.py +++ b/pygmt/src/text.py @@ -68,7 +68,7 @@ def text_( # noqa: PLR0912 ZapfDingbats and ISO-8859-x (x can be 1-11, 13-16) encodings. Refer to :doc:`/techref/encodings` for the full list of supported non-ASCII characters. - Full option list at :gmt-docs:`text.html`. + Full GMT docs at :gmt-docs:`text.html`. {aliases} diff --git a/pygmt/src/triangulate.py b/pygmt/src/triangulate.py index aa50e9d927c..06f9fe4ba3f 100644 --- a/pygmt/src/triangulate.py +++ b/pygmt/src/triangulate.py @@ -94,7 +94,7 @@ def regular_grid( Must provide ``region`` and ``spacing``. - Full option list at :gmt-docs:`triangulate.html` + Full GMT docs at :gmt-docs:`triangulate.html`. {aliases} @@ -196,7 +196,7 @@ def delaunay_triples( Must provide either ``data`` or ``x``, ``y``, and ``z``. - Full option list at :gmt-docs:`triangulate.html` + Full GMT docs at :gmt-docs:`triangulate.html` {aliases} diff --git a/pygmt/src/velo.py b/pygmt/src/velo.py index d5826c956ab..7e84ef60909 100644 --- a/pygmt/src/velo.py +++ b/pygmt/src/velo.py @@ -55,7 +55,7 @@ def velo(self, data: PathLike | TableLike | None = None, **kwargs): Must provide ``data`` and ``spec``. - Full option list at :gmt-docs:`supplements/geodesy/velo.html` + Full GMT docs at :gmt-docs:`supplements/geodesy/velo.html`. {aliases} diff --git a/pygmt/src/which.py b/pygmt/src/which.py index 695b951ebc0..f2567bf2c39 100644 --- a/pygmt/src/which.py +++ b/pygmt/src/which.py @@ -27,7 +27,7 @@ def which(fname: PathLike | Sequence[PathLike], **kwargs) -> str | list[str]: behavior. If ``download`` is not used (or ``False``), the file will not be found. - Full option list at :gmt-docs:`gmtwhich.html` + Full GMT docs at :gmt-docs:`gmtwhich.html`. {aliases} diff --git a/pygmt/src/wiggle.py b/pygmt/src/wiggle.py index 904ffa08c52..ddb8ea95f4e 100644 --- a/pygmt/src/wiggle.py +++ b/pygmt/src/wiggle.py @@ -48,7 +48,7 @@ def wiggle( Must provide either ``data`` or ``x``, ``y``, and ``z``. - Full option list at :gmt-docs:`wiggle.html` + Full GMT docs at :gmt-docs:`wiggle.html`. {aliases} diff --git a/pygmt/src/x2sys_cross.py b/pygmt/src/x2sys_cross.py index c6235f0f6b3..d502d72c190 100644 --- a/pygmt/src/x2sys_cross.py +++ b/pygmt/src/x2sys_cross.py @@ -87,7 +87,7 @@ def x2sys_cross( internal COEs. As an option, you may choose to project all data using one of the map projections prior to calculating the COE. - Full option list at :gmt-docs:`supplements/x2sys/x2sys_cross.html` + Full GMT docs at :gmt-docs:`supplements/x2sys/x2sys_cross.html`. {aliases} diff --git a/pygmt/src/x2sys_init.py b/pygmt/src/x2sys_init.py index 6e36263fe0e..23d0478d31e 100644 --- a/pygmt/src/x2sys_init.py +++ b/pygmt/src/x2sys_init.py @@ -34,7 +34,7 @@ def x2sys_init(tag, **kwargs): :term:`X2SYS_HOME` to a directory where you have write permission, which is where x2sys can keep track of your settings. - Full option list at :gmt-docs:`supplements/x2sys/x2sys_init.html` + Full GMT docs at :gmt-docs:`supplements/x2sys/x2sys_init.html`. {aliases} diff --git a/pygmt/src/xyz2grd.py b/pygmt/src/xyz2grd.py index 4ff93bda894..cab13131dec 100644 --- a/pygmt/src/xyz2grd.py +++ b/pygmt/src/xyz2grd.py @@ -46,7 +46,7 @@ def xyz2grd( user [Default is NaN]. Nodes with more than one value will be set to the mean value. - Full option list at :gmt-docs:`xyz2grd.html` + Full GMT docs at :gmt-docs:`xyz2grd.html`. {aliases}