Skip to content

DOC: Define "Aliases" as a custom section heading to simplify the docstrings #4942

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

Merged
seisman merged 6 commits into from
Oct 9, 2026
Merged

DOC: Define "Aliases" as a custom section heading to simplify the docstrings #4942

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9a4d9ba
DOC: Consistently show 'Aliases' without trailing colon
seisman Oct 4, 2026
2ca9eaf
Consistently use rubric for Aliases
seisman Oct 4, 2026
60edae5
Use napoleon_custom_sections to define Aliases as a custom section
seisman Oct 4, 2026
0cdc39e
Remove one blank line
seisman Oct 4, 2026
52476f8
Merge branch 'main' into doc/alias
seisman Oct 5, 2026
998808e
Merge branch 'main' into doc/alias
seisman Oct 8, 2026
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
2 changes: 2 additions & 0 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,8 @@
# Render the return argument and attribute lists in the same way as the parameter lists.
napoleon_use_rtype = False
napoleon_use_ivar = True
# Custom docstring sections, rendered in the same way as the "Examples" section.
napoleon_custom_sections = ["Aliases"]

# Options for sphinx-copybutton.
# Reference: https://sphinx-copybutton.readthedocs.io
Expand Down
6 changes: 3 additions & 3 deletions pygmt/helpers/decorators.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -454,8 +454,8 @@ def fmt_docstring(module_func):
*projcode*\[*projparams*/]\ *width*\|\ *scale*.
Select map :doc:`projection </projections/index>`.
<BLANKLINE>
**Aliases:**
<BLANKLINE>
Aliases
-------
.. hlist::
:columns: 3
<BLANKLINE>
Expand All @@ -466,7 +466,7 @@ def fmt_docstring(module_func):
filler_text = {}

if hasattr(module_func, "aliases"):
aliases = ["**Aliases:**\n"]
aliases = ["Aliases\n-------"]
aliases.append(".. hlist::")
aliases.append(" :columns: 3\n")
for arg in sorted(module_func.aliases):
Expand Down
4 changes: 2 additions & 2 deletions pygmt/src/basemap.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ def basemap(

Full GMT docs at :gmt-docs:`basemap.html`.

**Aliases**

Aliases
-------
.. hlist::
:columns: 3

Expand Down
4 changes: 2 additions & 2 deletions pygmt/src/choropleth.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ def choropleth(
as an attribute field (e.g. a :class:`geopandas.GeoDataFrame`), or an OGR_GMT file
containing the geometry and data to plot.

**Aliases:**

Aliases
-------
.. hlist::
:columns: 3

Expand Down
4 changes: 2 additions & 2 deletions pygmt/src/grdclip.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ def grdclip(

Full GMT docs at :gmt-docs:`grdclip.html`.

**Aliases:**

Aliases
-------
.. hlist::
:columns: 3

Expand Down
4 changes: 2 additions & 2 deletions pygmt/src/grdfill.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ def grdfill(

Full GMT docs at :gmt-docs:`grdfill.html`.

**Aliases**

Aliases
-------
.. hlist::
:columns: 3

Expand Down
4 changes: 2 additions & 2 deletions pygmt/src/grdfilter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,8 @@ def grdfilter(

Full GMT docs at :gmt-docs:`grdfilter.html`.

**Aliases**

Aliases
-------
.. hlist::
:columns: 3

Expand Down
4 changes: 2 additions & 2 deletions pygmt/src/grdlandmask.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ def grdlandmask(
Full GMT docs at :gmt-docs:`grdlandmask.html`.


**Aliases**

Aliases
-------
.. hlist::
:columns: 3

Expand Down
4 changes: 2 additions & 2 deletions pygmt/src/grdmask.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,8 +139,8 @@ def grdmask(

Full GMT docs at :gmt-docs:`grdmask.html`.

**Aliases**

Aliases
-------
.. hlist::
:columns: 3

Expand Down
4 changes: 2 additions & 2 deletions pygmt/src/grdpaste.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ def grdpaste(

Full GMT docs at :gmt-docs:`grdpaste.html`.

**Aliases**

Aliases
-------
.. hlist::
:columns: 3

Expand Down
4 changes: 2 additions & 2 deletions pygmt/src/image.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ def image(

Full GMT docs at :gmt-docs:`image.html`.

**Aliases:**

Aliases
-------
.. hlist::
:columns: 3

Expand Down
4 changes: 2 additions & 2 deletions pygmt/src/legend.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ def legend(

Full GMT docs at :gmt-docs:`legend.html`.

**Aliases:**

Aliases
-------
.. hlist::
:columns: 3

Expand Down
4 changes: 2 additions & 2 deletions pygmt/src/logo.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ def logo(

Full GMT docs at :gmt-docs:`gmtlogo.html`.

**Aliases:**

Aliases
-------
.. hlist::
:columns: 3

Expand Down
4 changes: 2 additions & 2 deletions pygmt/src/solar.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ def solar(

Full GMT docs at :gmt-docs:`solar.html`.

**Aliases:**

Aliases
-------
.. hlist::
:columns: 3

Expand Down
6 changes: 3 additions & 3 deletions pygmt/src/sphinterpolate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ def sphinterpolate(

Full GMT docs at :gmt-docs:`sphinterpolate.html`.

**Aliases:**

.. hlist:
Aliases
-------
.. hlist::
:columns: 2

- G = outgrid
Expand Down
4 changes: 2 additions & 2 deletions pygmt/src/which.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ def which(

Full GMT docs at :gmt-docs:`gmtwhich.html`.

**Aliases:**

Aliases
-------
.. hlist::
:columns: 3

Expand Down
Loading