René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"All examples should be MEP12/sphinx-gallery compliant","articleBody":"We are slowly moving to MEP12 compliant examples. \r\n\r\n`sphinx-gallery` was originally created from matplotlib's code to create a sphinx gallery but has since been packaged properly, and evolved to have more features and be more robust to sphinx build systems.\r\n\r\nIt has a couple of nice features that come out of the box including better formatting of gallery examples docstrings (see [1]), easy linking to documentation examples (specifically, deals with converting examples to rst _and_ updating those, while our builds symlinks or copies stuff around, which makes moving to the Makefile system a bit more painful on our end).\r\n\r\nHere are some steps to get our examples to build with sphinx-gallery:\r\n- All gallery examples should be documented with a docstring that includes a title at the top of the file.\r\n- All example folders containing plots should also contain a readme file\r\n\r\n[1]_ http://scikit-learn.org/stable/auto_examples/plot_isotonic_regression.html#sphx-glr-auto-examples-plot-isotonic-regression-py\r\n\r\n**Examples of MEP12-compliant plots**\r\n- [Fill demo](https://github.com/matplotlib/matplotlib/blob/master/examples/lines_bars_and_markers/fill_demo.py)\r\n\r\n**Documentation:**\r\n- http://matplotlib.org/devdocs/devel/MEP/MEP12.html\r\n\r\nList of elements that need to be updated:\r\n\r\n**Axes grid1**\r\n- [ ] axes_grid1/demo_axes_divider.py\r\n- [ ] axes_grid1/demo_axes_grid2.py\r\n- [ ] axes_grid1/demo_axes_grid.py\r\n- [ ] axes_grid1/demo_axes_hbox_divider.py\r\n- [ ] axes_grid1/demo_axes_rgb.py\r\n- [ ] axes_grid1/demo_colorbar_with_inset_locator.py\r\n- [ ] axes_grid1/demo_edge_colorbar.py\r\n- [ ] axes_grid1/demo_imagegrid_aspect.py\r\n- [ ] axes_grid1/inset_locator_demo2.py\r\n- [ ] axes_grid1/inset_locator_demo.py\r\n- [ ] axes_grid1/make_room_for_ylabel_using_axesgrid.py\r\n- [ ] axes_grid1/parasite_simple2.py\r\n- [ ] axes_grid1/scatter_hist.py\r\n- [ ] axes_grid1/simple_anchored_artists.py\r\n- [ ] axes_grid1/simple_axesgrid2.py\r\n- [ ] axes_grid1/simple_axesgrid.py\r\n- [ ] axes_grid1/simple_axisline4.py\r\n\r\n\r\n**Event handling**\r\n- [ ] event_handling/close_event.py\r\n- [ ] event_handling/data_browser.py\r\n- [ ] event_handling/figure_axes_enter_leave.py\r\n- [ ] event_handling/idle_and_timeout.py\r\n- [x] event_handling/keypress_demo.py\r\n- [ ] event_handling/lasso_demo.py\r\n- [ ] event_handling/legend_picking.py\r\n- [ ] event_handling/looking_glass.py\r\n- [ ] event_handling/path_editor.py\r\n- [ ] event_handling/pick_event_demo2.py\r\n- [ ] event_handling/pick_event_demo.py\r\n- [x] event_handling/pipong.py\r\n- [x] event_handling/poly_editor.py\r\n- [ ] event_handling/pong_gtk.py\r\n- [x] event_handling/resample.py\r\n- [ ] event_handling/test_mouseclicks.py\r\n- [ ] event_handling/timers.py\r\n- [ ] event_handling/trifinder_event_demo.py\r\n- [ ] event_handling/viewlims.py\r\n- [ ] event_handling/zoom_window.py\r\n\r\n**misc**\r\n- [ ] misc/contour_manual.py\r\n- [ ] misc/font_indexing.py\r\n- [ ] misc/ftface_props.py\r\n- [ ] misc/image_thumbnail.py\r\n- [ ] misc/multiprocess.py\r\n- [ ] misc/rasterization_demo.py\r\n- [ ] misc/rc_traits.py\r\n- [ ] misc/rec_groupby_demo.py\r\n- [ ] misc/rec_join_demo.py\r\n- [ ] misc/sample_data_demo.py\r\n- [ ] misc/svg_filter_line.py\r\n- [ ] misc/svg_filter_pie.py\r\n- [ ] misc/tight_bbox_test.py\r\n\r\n**mplot3d**\r\n- [ ] mplot3d/2dcollections3d_demo.py\r\n- [ ] mplot3d/bars3d_demo.py\r\n- [ ] mplot3d/contour3d_demo2.py\r\n- [ ] mplot3d/contour3d_demo3.py\r\n- [ ] mplot3d/contour3d_demo.py\r\n- [ ] mplot3d/contourf3d_demo2.py\r\n- [ ] mplot3d/contourf3d_demo.py\r\n- [ ] mplot3d/custom_shaded_3d_surface.py\r\n- [ ] mplot3d/hist3d_demo.py\r\n- [x] mplot3d/lines3d_demo.py\r\n- [x] mplot3d/lorenz_attractor.py\r\n- [x] mplot3d/mixed_subplots_demo.py\r\n- [x] mplot3d/offset_demo.py\r\n- [ ] mplot3d/pathpatch3d_demo.py\r\n- [ ] mplot3d/polys3d_demo.py\r\n- [x] mplot3d/quiver3d_demo.py\r\n- [x] mplot3d/rotate_axes3d_demo.py\r\n- [x] mplot3d/scatter3d_demo.py\r\n- [x] mplot3d/subplot3d_demo.py\r\n- [x] mplot3d/surface3d_demo2.py\r\n- [x] mplot3d/surface3d_demo3.py\r\n- [x] mplot3d/surface3d_demo.py\r\n- [x] mplot3d/surface3d_radial_demo.py\r\n- [x] mplot3d/text3d_demo.py\r\n- [x] mplot3d/tricontour3d_demo.py\r\n- [x] mplot3d/tricontourf3d_demo.py\r\n- [x] mplot3d/trisurf3d_demo2.py\r\n- [x] mplot3d/trisurf3d_demo.py\r\n- [x] mplot3d/wire3d_animation_demo.py\r\n- [x] mplot3d/wire3d_demo.py\r\n- [x] mplot3d/wire3d_zero_stride.py\r\n\r\n**Pylab examples**\r\n- [x] pylab_examples/accented_text.py\r\n- [ ] pylab_examples/agg_buffer.py\r\n- [ ] pylab_examples/agg_buffer_to_array.py\r\n- [ ] pylab_examples/alignment_test.py\r\n- [ ] pylab_examples/anchored_artists.py\r\n- [ ] pylab_examples/animation_demo.py\r\n- [ ] pylab_examples/annotation_demo2.py\r\n- [ ] pylab_examples/annotation_demo3.py\r\n- [ ] pylab_examples/annotation_demo.py\r\n- [ ] pylab_examples/anscombe.py\r\n- [ ] pylab_examples/arctest.py\r\n- [ ] pylab_examples/arrow_demo.py\r\n- [ ] pylab_examples/arrow_simple_demo.py\r\n- [ ] pylab_examples/aspect_loglog.py\r\n- [ ] pylab_examples/axes_demo.py\r\n- [ ] pylab_examples/axes_props.py\r\n- [ ] pylab_examples/axes_zoom_effect.py\r\n- [ ] pylab_examples/axhspan_demo.py\r\n- [ ] pylab_examples/axis_equal_demo.py\r\n- [ ] pylab_examples/barb_demo.py\r\n- [ ] pylab_examples/barchart_demo2.py\r\n- [ ] pylab_examples/barchart_demo.py\r\n- [ ] pylab_examples/barcode_demo.py\r\n- [x] pylab_examples/bar_stacked.py\u001B\r\n- [ ] pylab_examples/boxplot_demo2.py\r\n- [ ] pylab_examples/boxplot_demo3.py\r\n- [ ] pylab_examples/boxplot_demo.py\r\n- [ ] pylab_examples/broken_axis.py\r\n- [ ] pylab_examples/broken_barh.py\r\n- [ ] pylab_examples/centered_ticklabels.py\r\n- [ ] pylab_examples/cohere_demo.py\r\n- [ ] pylab_examples/colorbar_tick_labelling_demo.py\r\n- [ ] pylab_examples/color_by_yvalue.py\r\n- [ ] pylab_examples/color_demo.py\r\n- [ ] pylab_examples/colours.py\r\n- [ ] pylab_examples/contour_corner_mask.py\r\n- [ ] pylab_examples/contour_demo.py\r\n- [ ] pylab_examples/contourf_demo.py\r\n- [ ] pylab_examples/contourf_hatching.py\r\n- [ ] pylab_examples/contour_image.py\r\n- [ ] pylab_examples/contour_label_demo.py\r\n- [ ] pylab_examples/coords_demo.py\r\n- [ ] pylab_examples/coords_report.py\r\n- [ ] pylab_examples/csd_demo.py\r\n- [ ] pylab_examples/cursor_demo.py\r\n- [ ] pylab_examples/custom_cmap.py\r\n- [ ] pylab_examples/custom_figure_class.py\r\n- [ ] pylab_examples/customize_rc.py\r\n- [ ] pylab_examples/custom_ticker1.py\r\n- [ ] pylab_examples/dashpointlabel.py\r\n- [ ] pylab_examples/data_helper.py\r\n- [ ] pylab_examples/date_demo_convert.py\r\n- [ ] pylab_examples/date_demo_rrule.py\r\n- [ ] pylab_examples/date_index_formatter.py\r\n- [ ] pylab_examples/demo_agg_filter.py\r\n- [ ] pylab_examples/demo_annotation_box.py\r\n- [ ] pylab_examples/demo_bboximage.py\r\n- [ ] pylab_examples/demo_ribbon_box.py\r\n- [ ] pylab_examples/demo_text_path.py\r\n- [ ] pylab_examples/demo_text_rotation_mode.py\r\n- [ ] pylab_examples/demo_tight_layout.py\r\n- [x] pylab_examples/dolphin.py\r\n- [ ] pylab_examples/ellipse_collection.py\r\n- [ ] pylab_examples/ellipse_demo.py\r\n- [ ] pylab_examples/ellipse_rotated.py\r\n- [ ] pylab_examples/equal_aspect_ratio.py\r\n- [ ] pylab_examples/errorbar_limits.py\r\n- [ ] pylab_examples/errorbar_subsample.py\r\n- [ ] pylab_examples/eventcollection_demo.py\r\n- [ ] pylab_examples/eventplot_demo.py\r\n- [ ] pylab_examples/fancyarrow_demo.py\r\n- [ ] pylab_examples/fancybox_demo2.py\r\n- [ ] pylab_examples/fancybox_demo.py\r\n- [ ] pylab_examples/fancytextbox_demo.py\r\n- [ ] pylab_examples/figimage_demo.py\r\n- [ ] pylab_examples/figlegend_demo.py\r\n- [ ] pylab_examples/figure_title.py\r\n- [x] pylab_examples/fill_between_demo.py\r\n- [ ] pylab_examples/fill_betweenx_demo.py\r\n- [ ] pylab_examples/fill_spiral.py\r\n- [ ] pylab_examples/findobj_demo.py\r\n- [ ] pylab_examples/fonts_demo_kw.py\r\n- [ ] pylab_examples/fonts_demo.py\r\n- [ ] pylab_examples/font_table_ttf.py\r\n- [ ] pylab_examples/ganged_plots.py\r\n- [x] pylab_examples/geo_demo.py\r\n- [ ] pylab_examples/ginput_demo.py\r\n- [ ] pylab_examples/ginput_manual_clabel.py\r\n- [ ] pylab_examples/gradient_bar.py\r\n- [ ] pylab_examples/griddata_demo.py\r\n- [ ] pylab_examples/hatch_demo.py\r\n- [ ] pylab_examples/hexbin_demo2.py\r\n- [ ] pylab_examples/hexbin_demo.py\r\n- [ ] pylab_examples/hist2d_demo.py\r\n- [ ] pylab_examples/hist2d_log_demo.py\r\n- [ ] pylab_examples/hist_colormapped.py\r\n- [ ] pylab_examples/histogram_percent_demo.py\r\n- [ ] pylab_examples/hyperlinks.py\r\n- [ ] pylab_examples/image_clip_path.py\r\n- [ ] pylab_examples/image_demo2.py\r\n- [ ] pylab_examples/image_demo.py\r\n- [ ] pylab_examples/image_interp.py\r\n- [ ] pylab_examples/image_masked.py\r\n- [ ] pylab_examples/image_nonuniform.py\r\n- [ ] pylab_examples/image_origin.py\r\n- [ ] pylab_examples/image_slices_viewer.py\r\n- [ ] pylab_examples/interp_demo.py\r\n- [ ] pylab_examples/invert_axes.py\r\n- [ ] pylab_examples/layer_images.py\r\n- [ ] pylab_examples/leftventricle_bulleye.py\r\n- [ ] pylab_examples/legend_demo2.py\r\n- [ ] pylab_examples/legend_demo3.py\r\n- [ ] pylab_examples/legend_demo4.py\r\n- [ ] pylab_examples/legend_demo5.py\r\n- [ ] pylab_examples/legend_demo6.py\r\n- [ ] pylab_examples/line_collection2.py\r\n- [ ] pylab_examples/line_collection.py\r\n- [ ] pylab_examples/load_converter.py\r\n- [ ] pylab_examples/loadrec.py\r\n- [ ] pylab_examples/log_bar.py\r\n- [ ] pylab_examples/log_demo.py\r\n- [ ] pylab_examples/logo.py\r\n- [x] pylab_examples/log_test.py\r\n- [ ] pylab_examples/major_minor_demo1.py\r\n- [ ] pylab_examples/major_minor_demo2.py\r\n- [ ] pylab_examples/manual_axis.py\r\n- [ ] pylab_examples/marker_path.py\r\n- [ ] pylab_examples/markevery_demo.py\r\n- [ ] pylab_examples/masked_demo.py\r\n- [ ] pylab_examples/mathtext_demo.py\r\n- [ ] pylab_examples/mathtext_examples.py\r\n- [ ] pylab_examples/matshow.py\r\n- [ ] pylab_examples/movie_demo.py\r\n- [x] pylab_examples/mri_demo.py\r\n- [ ] pylab_examples/mri_with_eeg.py\r\n- [ ] pylab_examples/multicolored_line.py\r\n- [ ] pylab_examples/multi_image.py\r\n- [ ] pylab_examples/multiline.py\r\n- [ ] pylab_examples/multipage_pdf.py\r\n- [ ] pylab_examples/multiple_figs_demo.py\r\n- [ ] pylab_examples/multiple_yaxis_with_spines.py\r\n- [ ] pylab_examples/nan_test.py\r\n- [ ] pylab_examples/newscalarformatter_demo.py\r\n- [ ] pylab_examples/patheffect_demo.py\r\n- [ ] pylab_examples/pcolor_demo.py\r\n- [ ] pylab_examples/pcolor_log.py\r\n- [ ] pylab_examples/pcolor_small.py\r\n- [ ] pylab_examples/pie_demo2.py\r\n- [ ] pylab_examples/plotfile_demo.py\r\n- [ ] pylab_examples/polar_demo.py\r\n- [ ] pylab_examples/polar_legend.py\r\n- [ ] pylab_examples/print_stdout.py\r\n- [ ] pylab_examples/psd_demo2.py\r\n- [ ] pylab_examples/psd_demo3.py\r\n- [ ] pylab_examples/psd_demo_complex.py\r\n- [ ] pylab_examples/psd_demo.py\r\n- [ ] pylab_examples/pythonic_matplotlib.py\r\n- [ ] pylab_examples/quadmesh_demo.py\r\n- [ ] pylab_examples/quiver_demo.py\r\n- [ ] pylab_examples/scatter_custom_symbol.py\r\n- [ ] pylab_examples/scatter_demo2.py\r\n- [ ] pylab_examples/scatter_hist.py\r\n- [ ] pylab_examples/scatter_masked.py\r\n- [ ] pylab_examples/scatter_profile.py\r\n- [ ] pylab_examples/scatter_star_poly.py\r\n- [ ] pylab_examples/scatter_symbol.py\r\n- [ ] pylab_examples/set_and_get.py\r\n- [ ] pylab_examples/shading_example.py\r\n- [ ] pylab_examples/shared_axis_across_figures.py\r\n- [ ] pylab_examples/shared_axis_demo.py\r\n- [ ] pylab_examples/simple_plot.py\r\n- [ ] pylab_examples/specgram_demo.py\r\n- [ ] pylab_examples/spectrum_demo.py\r\n- [ ] pylab_examples/spine_placement_demo.py\r\n- [ ] pylab_examples/spy_demos.py\r\n- [ ] pylab_examples/stackplot_demo2.py\r\n- [ ] pylab_examples/stackplot_demo.py\r\n- [ ] pylab_examples/stem_plot.py\r\n- [ ] pylab_examples/step_demo.py\r\n- [ ] pylab_examples/stix_fonts_demo.py\r\n- [ ] pylab_examples/stock_demo.py\r\n- [ ] pylab_examples/subplot_demo.py\r\n- [ ] pylab_examples/subplots_adjust.py\r\n- [ ] pylab_examples/subplots_demo.py\r\n- [ ] pylab_examples/subplot_toolbar.py\r\n- [ ] pylab_examples/symlog_demo.py\r\n- [ ] pylab_examples/system_monitor.py\r\n- [ ] pylab_examples/table_demo.py\r\n- [ ] pylab_examples/tex_demo.py\r\n- [ ] pylab_examples/text_handles.py\r\n- [x] pylab_examples/text_rotation.py\r\n- [ ] pylab_examples/text_rotation_relative_to_line.py\r\n- [ ] pylab_examples/tex_unicode_demo.py\r\n- [ ] pylab_examples/titles_demo.py\r\n- [ ] pylab_examples/toggle_images.py\r\n- [ ] pylab_examples/transoffset.py\r\n- [ ] pylab_examples/tricontour_demo.py\r\n- [ ] pylab_examples/tricontour_smooth_delaunay.py\r\n- [ ] pylab_examples/tricontour_smooth_user.py\r\n- [ ] pylab_examples/tricontour_vs_griddata.py\r\n- [ ] pylab_examples/trigradient_demo.py\r\n- [ ] pylab_examples/triinterp_demo.py\r\n- [ ] pylab_examples/tripcolor_demo.py\r\n- [ ] pylab_examples/triplot_demo.py\r\n- [ ] pylab_examples/usetex_baseline_test.py\r\n- [ ] pylab_examples/usetex_demo.py\r\n- [ ] pylab_examples/usetex_fonteffects.py\r\n- [ ] pylab_examples/vline_hline_demo.py\r\n- [ ] pylab_examples/webapp_demo.py\r\n- [ ] pylab_examples/xcorr_demo.py\r\n- [ ] pylab_examples/zorder_demo.py\r\n\r\n\r\n**Units**\r\n- [x] units/annotate_with_units.py\r\n- [x] units/artist_tests.py\r\n- [x] units/bar_demo2.py\r\n- [x] units/bar_unit_demo.py\r\n- [ ] units/basic_units.py\r\n- [ ] units/ellipse_with_units.py\r\n- [x] units/evans_test.py\r\n- [x] units/radian_demo.py\r\n- [x] units/units_sample.py\r\n- [x] units/units_scatter.py\r\n\r\n**User interfaces**\r\n- [ ] user_interfaces/embedding_in_gtk2.py\r\n- [ ] user_interfaces/embedding_in_gtk3_panzoom.py\r\n- [ ] user_interfaces/embedding_in_gtk3.py\r\n- [ ] user_interfaces/embedding_in_gtk.py\r\n- [ ] user_interfaces/embedding_in_qt4.py\r\n- [ ] user_interfaces/embedding_in_qt4_wtoolbar.py\r\n- [ ] user_interfaces/embedding_in_qt5.py\r\n- [ ] user_interfaces/embedding_in_tk2.py\r\n- [ ] user_interfaces/embedding_in_tk_canvas.py\r\n- [ ] user_interfaces/embedding_in_tk.py\r\n- [ ] user_interfaces/embedding_in_wx2.py\r\n- [ ] user_interfaces/embedding_in_wx3.py\r\n- [ ] user_interfaces/embedding_in_wx4.py\r\n- [ ] user_interfaces/embedding_in_wx5.py\r\n- [ ] user_interfaces/embedding_webagg.py\r\n- [ ] user_interfaces/fourier_demo_wx.py\r\n- [ ] user_interfaces/gtk_spreadsheet.py\r\n- [ ] user_interfaces/histogram_demo_canvasagg.py\r\n- [ ] user_interfaces/interactive2.py\r\n- [ ] user_interfaces/interactive.py\r\n- [ ] user_interfaces/lineprops_dialog_gtk.py\r\n- [ ] user_interfaces/mathtext_wx.py\r\n- [ ] user_interfaces/mpl_with_glade_316.py\r\n- [ ] user_interfaces/mpl_with_glade.py\r\n- [ ] user_interfaces/pylab_with_gtk.py\r\n- [ ] user_interfaces/rec_edit_gtk_custom.py\r\n- [ ] user_interfaces/rec_edit_gtk_simple.py\r\n- [ ] user_interfaces/svg_histogram.py\r\n- [ ] user_interfaces/svg_tooltip.py\r\n- [ ] user_interfaces/toolmanager.py\r\n- [ ] user_interfaces/wxcursor_demo.py\r\n\r\n**Widgets**\r\n- [ ] widgets/buttons.py\r\n- [ ] widgets/check_buttons.py\r\n- [ ] widgets/cursor.py\r\n- [ ] widgets/lasso_selector_demo.py\r\n- [ ] widgets/menu.py\r\n- [ ] widgets/multicursor.py\r\n- [ ] widgets/radio_buttons.py\r\n- [ ] widgets/rectangle_selector.py\r\n- [ ] widgets/slider_demo.py\r\n- [ ] widgets/span_selector.py\r\n- [ ] widgets/textbox.py\r\n\r\n**Folders entirely finished**\r\n- [x] **Statistics**\r\n- [x] **Pie and polar charts**\r\n- [x] **Animation**\r\n- [x] **Color**\r\n- [x] **Lines, bars and markers**\r\n- [x] **Showcase**\r\n- [x] **Speciality plots**\r\n- [x] **Images, contours and fields**\r\n- [x] **Subplots, axes and figures**\r\n- [x] **Shapes and collections**\r\n- [x] **Images, contours and fields**\r\n- [x] **Axis Artist**\r\n- [x] **Text, labels and annotations**\r\n- [x] **Ticks \u0026 spines**\r\n- [x] **Scales**\r\n- [x] **Style sheets**\r\n- [x] **API**\r\n\r\n#","author":{"url":"https://github.com/NelleV","@type":"Person","name":"NelleV"},"datePublished":"2016-09-30T18:53:23.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":11},"url":"https://github.com/7206/matplotlib/issues/7206"}