DOC api's transition to sphinx-gallery is now complete#8311
DOC api's transition to sphinx-gallery is now complete#8311dopplershift merged 1 commit intomatplotlib:masterfrom NelleV:MEP12_api
Conversation
| 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
left a comment
There was a problem hiding this comment.
Looks good. A couple minor comments that don't need to hold this up.
| (: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
| **Examples:** | ||
|
|
||
| .. plot:: mpl_examples/api/sankey_demo_basics.py | ||
| .. plot:: mpl_examples/api/plot_sankey_demo_basics.py |
|
Thanks for the review @dopplershift ! |
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…