DOC api's transition to sphinx-gallery is now complete #8311
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
dstansby
reviewed
Mar 17, 2017
| create the figure and show calls, and use the API for everything else. | ||
| This is a good solution for production quality scripts. For full | ||
| fledged GUI applications, see the user_interfaces examples. | ||
|
|
||
| Example style guide |
There was a problem hiding this comment.
Is there any reason to get rid of this section? It seems quite useful.
There was a problem hiding this comment.
This is not the correct place to document example style guide. We have a MEP for this in addition of contributors guidelines on how to write documentation (this section is thus quite out of date).
In addition, the READMEs are now being rendered in the gallery: they thus should contain documentation relevant to the end user on this specific section of the gallery instead of a mixture of user documentation and contribution guidelines.
Does this make sense?
dopplershift
approved these changes
Mar 19, 2017
| (:ref:`api-sankey_demo_basics`, :ref:`api-sankey_demo_links`, | ||
| :ref:`api-sankey_demo_rankine`). | ||
| (:ref:`api-plot_sankey_demo_basics`, :ref:`api-plot_sankey_demo_links`, | ||
| :ref:`api-plot_sankey_demo_rankine`). |
There was a problem hiding this comment.
Should we take demo out here as well?
lib/matplotlib/sankey.py
Outdated
| @@ -118,7 +118,7 @@ def __init__(self, ax=None, scale=1.0, unit='', format='%G', gap=0.25, | |||
|
|
|||
| **Examples:** | |||
|
|
|||
| .. plot:: mpl_examples/api/sankey_demo_basics.py | |||
| .. plot:: mpl_examples/api/plot_sankey_demo_basics.py | |||
|
Thanks for the review @dopplershift ! |
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.
It turns out we were much closer to finish the transition of all API examples than I thought, so this PR finishes up the job.
This doesn't build on my computer, and I am struggling to understand what is going on…