scipy2017 sprint - docs

[choldgraf]

We can keep track of documentation improvements at the scipy2017 sprints.

Things to work on:

• Cycler example -> tutorial w/ more narrative etc. see [wip] Doc cleanup for examples/color/color_cycle and examples/animation/animated_histogram #8890
• auto-ticks example (adding auto ticks example #8879 (review)) (@choldgraf)
• Ensure that all examples / tutorials have a title and a one-line description underneath.
• Find examples w/ multiple plots generated and add sphinx-gallery ########## blocks + rST so that it's more narrative

[choldgraf]

@story645 can you explain what you meant by adding new context manager functionality to the documentation? I'm not sure exactly what that refers to :-)

[tacaswell]

Might be worth pulling some prose from or linking to http://matplotlib.org/cycler/

[choldgraf]

yep - that's what I suggested they do too, and we'll also add a link to that page in a note at the top of the example.

[tonyyli]

Ensure that all examples / tutorials have a title and a one-line description underneath.

For later reference -- as of 2017-07-16 -- these are all the examples / tutorials that still need one-line descriptions (excluding those changed in #8887):

examples/axes_grid1/demo_axes_divider.py
examples/axes_grid1/demo_axes_grid.py
examples/axes_grid1/demo_axes_grid2.py
examples/axes_grid1/demo_axes_hbox_divider.py
examples/axes_grid1/demo_axes_rgb.py
examples/axes_grid1/demo_colorbar_of_inset_axes.py
examples/axes_grid1/demo_colorbar_with_axes_divider.py
examples/axes_grid1/demo_colorbar_with_inset_locator.py
examples/axes_grid1/demo_edge_colorbar.py
examples/axes_grid1/demo_fixed_size_axes.py
examples/axes_grid1/demo_imagegrid_aspect.py
examples/axes_grid1/demo_new_colorbar.py
examples/axes_grid1/inset_locator_demo.py
examples/axes_grid1/inset_locator_demo2.py
examples/axes_grid1/make_room_for_ylabel_using_axesgrid.py
examples/axes_grid1/parasite_simple.py
examples/axes_grid1/parasite_simple2.py
examples/axes_grid1/scatter_hist.py
examples/axes_grid1/simple_anchored_artists.py
examples/axes_grid1/simple_axes_divider1.py
examples/axes_grid1/simple_axes_divider2.py
examples/axes_grid1/simple_axes_divider3.py
examples/axes_grid1/simple_axesgrid.py
examples/axes_grid1/simple_axesgrid2.py
examples/axes_grid1/simple_axisline4.py
examples/axes_grid1/simple_colorbar.py
examples/axes_grid1/simple_rgb.py
examples/event_handling/close_event.py
examples/event_handling/data_browser.py
examples/event_handling/looking_glass.py
examples/event_handling/path_editor.py
examples/images_contours_and_fields/griddata_demo.py
examples/images_contours_and_fields/shading_example.py
examples/lines_bars_and_markers/scatter_custom_symbol.py
examples/lines_bars_and_markers/scatter_hist.py
examples/lines_bars_and_markers/scatter_masked.py
examples/lines_bars_and_markers/scatter_profile.py
examples/lines_bars_and_markers/scatter_star_poly.py
examples/lines_bars_and_markers/scatter_symbol.py
examples/misc/rasterization_demo.py
examples/misc/rec_groupby_demo.py
examples/misc/tight_bbox_test.py
examples/pylab_examples/anchored_artists.py
examples/pylab_examples/anscombe.py
examples/pylab_examples/arctest.py
examples/pylab_examples/arrow_simple_demo.py
examples/pylab_examples/aspect_loglog.py
examples/pylab_examples/axes_zoom_effect.py
examples/pylab_examples/barcode_demo.py
examples/pylab_examples/dashpointlabel.py
examples/pylab_examples/date_demo_convert.py
examples/pylab_examples/demo_agg_filter.py
examples/pylab_examples/demo_annotation_box.py
examples/pylab_examples/demo_bboximage.py
examples/pylab_examples/demo_ribbon_box.py
examples/pylab_examples/demo_text_path.py
examples/pylab_examples/demo_text_rotation_mode.py
examples/pylab_examples/demo_tight_layout.py
examples/pylab_examples/ellipse_collection.py
examples/pylab_examples/ellipse_demo.py
examples/pylab_examples/ellipse_rotated.py
examples/pylab_examples/fancyarrow_demo.py
examples/pylab_examples/fancytextbox_demo.py
examples/pylab_examples/fill_spiral.py
examples/pylab_examples/gradient_bar.py
examples/pylab_examples/interp_demo.py
examples/pylab_examples/load_converter.py
examples/pylab_examples/log_bar.py
examples/pylab_examples/marker_path.py
examples/pylab_examples/movie_demo_sgskip.py
examples/pylab_examples/multiline.py
examples/pylab_examples/multiple_yaxis_with_spines.py
examples/pylab_examples/patheffect_demo.py
examples/pylab_examples/system_monitor.py
examples/pyplots/align_ylabels.py
examples/pyplots/annotate_transform.py
examples/pyplots/annotation_basic.py
examples/pyplots/annotation_polar.py
examples/pyplots/auto_subplots_adjust.py
examples/pyplots/compound_path_demo.py
examples/pyplots/dollar_ticks.py
examples/pyplots/fig_axes_customize_simple.py
examples/pyplots/fig_axes_labels_simple.py
examples/pyplots/fig_x.py
examples/pyplots/pyplot_annotate.py
examples/pyplots/pyplot_formatstr.py
examples/pyplots/pyplot_mathtext.py
examples/pyplots/pyplot_scales.py
examples/pyplots/pyplot_simple.py
examples/pyplots/pyplot_text.py
examples/pyplots/pyplot_three.py
examples/pyplots/pyplot_two_subplots.py
examples/pyplots/text_layout.py
examples/pyplots/whats_new_1_subplot3d.py
examples/pyplots/whats_new_98_4_fancy.py
examples/pyplots/whats_new_98_4_fill_between.py
examples/pyplots/whats_new_98_4_legend.py
examples/pyplots/whats_new_99_axes_grid.py
examples/pyplots/whats_new_99_mplot3d.py
examples/pyplots/whats_new_99_spines.py
examples/subplots_axes_and_figures/subplot_toolbar.py
examples/subplots_axes_and_figures/subplots_adjust.py
examples/text_labels_and_annotations/stix_fonts_demo.py
examples/text_labels_and_annotations/usetex_baseline_test.py
examples/text_labels_and_annotations/usetex_demo.py
examples/units/basic_units.py
examples/user_interfaces/embedding_in_qt4_wtoolbar_sgskip.py
examples/user_interfaces/embedding_in_tk2_sgskip.py
examples/user_interfaces/embedding_in_tk_sgskip.py
examples/user_interfaces/fourier_demo_wx_sgskip.py
examples/user_interfaces/lineprops_dialog_gtk_sgskip.py
examples/user_interfaces/mpl_with_glade_316_sgskip.py
examples/user_interfaces/mpl_with_glade_sgskip.py
examples/userdemo/anchored_box01.py
examples/userdemo/anchored_box02.py
examples/userdemo/anchored_box03.py
examples/userdemo/anchored_box04.py
examples/userdemo/annotate_explain.py
examples/userdemo/annotate_simple01.py
examples/userdemo/annotate_simple02.py
examples/userdemo/annotate_simple03.py
examples/userdemo/annotate_simple04.py
examples/userdemo/annotate_simple_coord01.py
examples/userdemo/annotate_simple_coord02.py
examples/userdemo/annotate_simple_coord03.py
examples/userdemo/annotate_text_arrow.py
examples/userdemo/axis_direction_demo_step01.py
examples/userdemo/axis_direction_demo_step02.py
examples/userdemo/axis_direction_demo_step03.py
examples/userdemo/axis_direction_demo_step04.py
examples/userdemo/connect_simple01.py
examples/userdemo/connectionstyle_demo.py
examples/userdemo/custom_boxstyle01.py
examples/userdemo/custom_boxstyle02.py
examples/userdemo/demo_axis_direction.py
examples/userdemo/demo_gridspec01.py
examples/userdemo/demo_gridspec02.py
examples/userdemo/demo_gridspec03.py
examples/userdemo/demo_gridspec04.py
examples/userdemo/demo_gridspec05.py
examples/userdemo/demo_gridspec06.py
examples/userdemo/demo_parasite_axes_sgskip.py
examples/userdemo/demo_ticklabel_alignment.py
examples/userdemo/demo_ticklabel_direction.py
examples/userdemo/pgf_fonts_sgskip.py
examples/userdemo/pgf_preamble_sgskip.py
examples/userdemo/pgf_texsystem_sgskip.py
examples/userdemo/simple_annotate01.py
examples/userdemo/simple_axis_direction01.py
examples/userdemo/simple_axis_direction03.py
examples/userdemo/simple_axis_pad.py
examples/userdemo/simple_axisartist1.py
examples/userdemo/simple_axisline.py
examples/userdemo/simple_axisline2.py
examples/userdemo/simple_axisline3.py
examples/userdemo/simple_legend01.py
examples/userdemo/simple_legend02.py
examples/widgets/buttons.py
examples/widgets/check_buttons.py
examples/widgets/cursor.py
examples/widgets/lasso_selector_demo_sgskip.py
examples/widgets/menu.py
examples/widgets/multicursor.py
examples/widgets/radio_buttons.py
examples/widgets/slider_demo.py
examples/widgets/textbox.py

[tonyyli]

Find examples w/ multiple plots generated and add sphinx-gallery ########## blocks + rST so that it's more narrative

For later reference -- as of 2017-07-16 -- these are examples with multiple calls to plt.figure or plt.show (that aren't already separated by #####...):

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
examples/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
examples/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

[choldgraf]

+1 @tonyyli thanks for putting this list together!

[tonyyli]

No problem! Think most or all of the 2nd list should be included in #8899 .

[story645]

@choldgraf it was already in the tutorial and I'd missed it. 😊

[choldgraf]

closing this since we got most of these PRs merged and the ones that aren't have their own PR open for discussion!