Use the minigallery directive to insert mini gallery in API documentation #2459
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of proposed changes
Currently, the mini-gallery at the end of each API documentation is added using the following
includedirective:This
includedirective was originally added to theclasstemplate in PR #383 (Nov, 2019) since there are no other way to insert mini galleries at that time. The sameincludedirective was then added to themethodandfunctiontemplate in PR #648 (Oct, 2020).Since v0.7.0 (PR sphinx-gallery/sphinx-gallery#685, released in May, 2020), Sphinx-Gallery provided the
minigallerydirective (https://sphinx-gallery.github.io/stable/configuration.html#add-mini-galleries-for-api-documentation) to add mini gallery.This PR replaces the outdated
includedirective with the betterminigallerydirective as suggested by the official sphinx-gallery documentation (https://sphinx-gallery.github.io/stable/configuration.html#add-mini-galleries-for-api-documentation).Preview: https://pygmt-dev--2459.org.readthedocs.build/en/2459/api/index.html
Reminders
make formatandmake checkto make sure the code follows the style guide.doc/api/index.rst.Slash Commands
You can write slash commands (
/command) in the first line of a comment to performspecific operations. Supported slash commands are:
/format: automatically format and lint the code/test-gmt-dev: run full tests on the latest GMT development version