Skip to content

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

Merged
seisman merged 6 commits into
mainfrom
doc/alias
Oct 9, 2026
Merged

DOC: Define "Aliases" as a custom section heading to simplify the docstrings#4942
seisman merged 6 commits into
mainfrom
doc/alias

Conversation

@seisman

@seisman seisman commented Oct 4, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Add Aliases as a custom section via the napoleon_custom_sections setting. In this way, Aliases can be used and displayed like regular section headings, such as "Examples"

The new usage is:

Aliases
-------
.. hlist:: 
   :columns: 3
   
   - J = projection

Preview: https://pygmt-dev--4942.org.readthedocs.build/en/4942/api/generated/pygmt.Figure.basemap.html#pygmt.Figure.basemap

@seisman seisman added this to the 0.20.0 milestone Oct 4, 2026
@seisman seisman added maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog needs review This PR has higher priority and needs review. labels Oct 4, 2026
@seisman seisman added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Oct 8, 2026
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Oct 9, 2026
@seisman
seisman merged commit fff7502 into main Oct 9, 2026
21 of 23 checks passed
@seisman
seisman deleted the doc/alias branch October 9, 2026 02:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog

Projects

None yet

Milestone

0.20.0

Development

Successfully merging this pull request may close these issues.

1 participant

@seisman