Skip to content
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.

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

Add mini-galleries for methods and functions #648

Merged
merged 1 commit into from
Oct 11, 2020
Merged

Conversation

seisman
Copy link
Member

@seisman seisman commented Oct 10, 2020

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:

image

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

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If adding new functionality, add an example to docstrings or tutorials.

@seisman seisman requested a review from a team October 10, 2020 06:04
@seisman seisman added the documentation Improvements or additions to documentation label Oct 10, 2020
@seisman seisman added this to the 0.2.1 milestone Oct 10, 2020
@seisman seisman marked this pull request as ready for review October 10, 2020 14:14
Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is brilliant! Thanks @seisman!

@seisman seisman merged commit 3613b19 into master Oct 11, 2020
@seisman seisman deleted the method-gallary branch October 11, 2020 03:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants