Repository navigation
Separate plots in examples w/ multiple plots using ###### #8922
Description
Sphinx-gallery will render plots in sections if they are separated by a ######### line. This makes it easier to read / follow examples that create multiple plots, putting them inline w/ the code instead of all placed at the top. Some examples don't have this line of ##### put in there yet, so an easy first step is to insert it into any examples where it makes sense.
these are examples with multiple calls to plt.figure or plt.show (that aren't already separated by #####...):
Details- examples/animation/basic_example.py
- examples/animation/basic_example_writer_sgskip.py
- examples/api/sankey_basics.py
- examples/axes_grid1/demo_fixed_size_axes.py
- examples/axes_grid1/make_room_for_ylabel_using_axesgrid.py
- examples/images_contours_and_fields/contour_demo.py
- examples/images_contours_and_fields/contour_label_demo.py
- examples/images_contours_and_fields/contourf_hatching.py
- examples/images_contours_and_fields/quiver_demo.py
- examples/images_contours_and_fields/tricontour_demo.py
- examples/images_contours_and_fields/tripcolor_demo.py
- examples/images_contours_and_fields/triplot_demo.py
- examples/misc/contour_manual.py
- examples/pylab_examples/demo_tight_layout.py
- examples/pylab_examples/errorbar_limits.py
- examples/pylab_examples/geo_demo.py
- pylab_examples/hyperlinks_sgskip.py
- examples/pylab_examples/markevery_demo.py
- examples/pylab_examples/multipage_pdf.py
- examples/pylab_examples/multiple_figs_demo.py
- examples/pylab_examples/spine_placement_demo.py
- pylab_examples/zorder_demo.py
- examples/pyplots/fig_axes_customize_simple.py
- examples/showcase/xkcd.py
- examples/statistics/boxplot.py
- examples/statistics/bxp.py
- examples/units/ellipse_with_units.py
Activity
choldgraf commented on Jul 27, 2017
LindyBalboa commented on Aug 12, 2017
I'm glancing through the files after a grep -r -L "################" * | xargs grep -c "show" | sort --field-separator=: -k 2. I've looked through all of the ones with 2 or more instances of "show" and these are the ones which I believe may be converted to this format with some refactoring and -could- benefit from it (but maybe not?). This list is by no means exhaustive, but it is focal point with some specific examples.
Files to check:
Detailscholdgraf commented on Aug 12, 2017
Yep - feel free to cross reference your list with the one in the top-level of this thread and open some PRs! :-)
LindyBalboa commented on Aug 12, 2017
Maybe. I was intending on just taking a crack at your list, but saw that a lot had been done already (the two PRs I refd this to). So I decided to try and track down the files that still need it. I would appreciate if someone more senior the the project could take a glance through them and see if any of them shouldn't be refactored before people go foreward editing them.
Oh god, I just double checked the list. That formatting is aweful, I will fix that. FIXED
choldgraf commented on Aug 12, 2017
it shouldn't be too much work to add in the #### where needed, so if you open a PR I am happy to give it a quick review and mention anywhere that it's unnecessary. But as a general rule I think that any code that generates >1 plots would benefit from having the output separated by #### blocks
ash13 commented on Oct 19, 2017
Hi, I want to work on this. Can someone help me to start of?
ash13 commented on Oct 19, 2017
@choldgraf: Hi I tried adding the lines in the program list mentioned by you. Few of them already had it. The ones which din't have, I have added them.Please do let me know if I have to do any changes.
#9479
Separate plots using #### in xkcd.py
jgtiu commented on Aug 9, 2019
Hi, new contributor here, I'd like to work on this issue. Is this something you still need?
timhoffm commented on Aug 9, 2019
Yes, please go for the unchecked items in the details list of the original post.
ardieorden commented on Oct 25, 2019
Hi, I'd like to work on the make_room_for_ylabel_using_axesgrid.py item in the details list!
timhoffm commented on Jul 14, 2020
All handled.