MEP12 - added sphinx-gallery docstrings #7277
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
QuLogic
reviewed
Oct 16, 2016
| @@ -87,6 +87,22 @@ the gallery would remain in those directories until they are cleaned | |||
| up. After clean-up, they would be moved to one of the new gallery | |||
| sections described above. "Clean-up" should involve: | |||
|
|
|||
| * `sphinx-gallery docstrings <http://sphinx-gallery.readthedocs.io/>`_: a | |||
| @@ -87,6 +87,22 @@ the gallery would remain in those directories until they are cleaned | |||
| up. After clean-up, they would be moved to one of the new gallery | |||
| sections described above. "Clean-up" should involve: | |||
|
|
|||
| * `sphinx-gallery docstrings <http://sphinx-gallery.readthedocs.io/>`_: a | |||
| title and a description formatted as follows:: | |||
There was a problem hiding this comment.
I think this should probably mention that it's the docstring for the entire file (right?), not some function within an example.
There was a problem hiding this comment.
Once something is added to this one to clarify that it's talking about the file docstring, the third bullet below this one (Add introductory sentence or paragraph in the main docstring.) can also be deleted since it gives less specific criteria for the same docstring.
|
|
||
| .. math:: f(x, y) = \sin(x) + \cos(y) | ||
|
|
||
| with different colormaps. Look at how colormaps alter your perception! |
efiring
approved these changes
Oct 16, 2016
QuLogic
approved these changes
Oct 17, 2016
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
As discussed in a pull request (#6690), here is an update of the sphinx-gallery type of docstring for MEP12.