Add mini-galleries for methods and functions #648
Merged
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
This PR updates the autosummary templates, to show mini-galleries of all methods and functions at the end of the documentation page.
Here is the screenshot for the documentation of the
pygmt.Figure.plot()
method:It's better to see the differences by comparing the API documentation of the current dev version and the preview of this branch.
References:
Reminders
make format
andmake check
to make sure the code follows the style guide.doc/api/index.rst
.