adding sphinx gallery labels

matplotlib · NelleV · Apr 30, 2017 · Apr 27, 2017 · Apr 27, 2017 · Apr 28, 2017
commit 4e93fe4947b350db4ffeec6cc26aff0a2d82016a
diff --git a/doc/_static/depsy_badge.svg b/doc/_static/depsy_badge.svg
diff --git a/doc/_static/mpl.css b/doc/_static/mpl.css
@@ -785,9 +785,9 @@ div.responsive_subfig img {
     div.responsive_subfig {
         width: 50%;  /* we want 2 subfigs in a row */
     }
+}
 
 /* Sphinx gallery display */
-}
 
 div.align-center {
     margin: auto;
@@ -801,3 +801,28 @@ p.caption {
 div#gallery.section, div#tutorials.section {
     overflow: hidden;
 }
+
+.sphx-glr-thumbcontainer {
+    border: solid #d6d6d6 1px !important;
+    text-align: center !important;
+    font-size: 1.2em !important;
+}
+
+div.sphx-glr-download {
+    width: auto !important;
+}
+
+div.sphx-glr-download a {
+   background-color: #d9edf7 !important;
+   border: 1px solid #bce8f1 !important;
+   background-image: none !important;
+}
+
+p.sphx-glr-signature a.reference.external {
+   display: none !important;
+}
+
+.sphx-glr-thumbcontainer a.internal {
+    font-weight: 400;
+}
+
diff --git a/doc/api/animation_api.rst b/doc/api/animation_api.rst
@@ -243,7 +243,7 @@ to use the `~MovieWriter.saving` context manager ::
 to ensures that setup and cleanup are performed as necessary.
 
 
-:ref:`animation-moviewriter`
+:ref:`sphx_glr_gallery_animation_moviewriter_sgskip.py`
 
 
 .. _ani_writer_classes:
@@ -267,7 +267,7 @@ Animation Base Classes
 Custom Animation classes
 ------------------------
 
-:ref:`animation-subplots`
+:ref:`sphx_glr_gallery_animation_subplots.py`
 
 Writer Registry
 ---------------

diff --git a/doc/api/api_changes.rst b/doc/api/api_changes.rst
@@ -782,7 +782,7 @@ original location:
 * The legend handler interface has changed from a callable, to any object
   which implements the ``legend_artists`` method (a deprecation phase will
   see this interface be maintained for v1.4). See
-  :ref:`plotting-guide-legend` for further details. Further legend changes
+  :ref:`sphx_glr_tutorials_02_intermediate_legend_guide.py` for further details. Further legend changes
   include:
 
    * :func:`matplotlib.axes.Axes._get_legend_handles` now returns a generator

diff --git a/doc/devel/contributing.rst b/doc/devel/contributing.rst
@@ -414,7 +414,7 @@ Developing a new backend
 ------------------------
 
 If you are working on a custom backend, the *backend* setting in
-:file:`matplotlibrc` (:ref:`customizing-matplotlib`) supports an
+:file:`matplotlibrc` (:ref:`sphx_glr_tutorials_01_introductory_customizing.py`) supports an
 external backend via the ``module`` directive.  If
 :file:`my_backend.py` is a Matplotlib backend in your
 :envvar:`PYTHONPATH`, you can set it on one of several ways

diff --git a/doc/faq/howto_faq.rst b/doc/faq/howto_faq.rst
@@ -48,7 +48,7 @@ If you only want to use the `pandas` converter for `datetime64` values ::
 Find all objects in a figure of a certain type
 ----------------------------------------------
 
-Every Matplotlib artist (see :ref:`artist-tutorial`) has a method
+Every Matplotlib artist (see :ref:`sphx_glr_tutorials_02_intermediate_artists.py`) has a method
 called :meth:`~matplotlib.artist.Artist.findobj` that can be used to
 recursively search the artist for any artists it may contain that meet
 some criteria (e.g., match all :class:`~matplotlib.lines.Line2D`
@@ -160,7 +160,7 @@ labels::
     ax = fig.add_subplot(111)
 
 You can control the defaults for these parameters in your
-:file:`matplotlibrc` file; see :ref:`customizing-matplotlib`.  For
+:file:`matplotlibrc` file; see :ref:`sphx_glr_tutorials_01_introductory_customizing.py`.  For
 example, to make the above setting permanent, you would set::
 
     figure.subplot.bottom : 0.2   # the bottom of the subplots of the figure
@@ -191,7 +191,7 @@ specify the location explicitly::
     ax = fig.add_axes([left, bottom, width, height])
 
 where all values are in fractional (0 to 1) coordinates.  See
-:ref:`pylab_examples-axes_demo` for an example of placing axes manually.
+:ref:`sphx_glr_gallery_pylab_examples_axes_demo.py` for an example of placing axes manually.
 
 .. _howto-auto-adjust:
 
@@ -201,7 +201,7 @@ Automatically make room for tick labels
 .. note::
    This is now easier to handle than ever before.
    Calling :func:`~matplotlib.pyplot.tight_layout` can fix many common
-   layout issues. See the :ref:`plotting-guide-tight-layout`.
+   layout issues. See the :ref:`sphx_glr_tutorials_02_intermediate_tight_layout_guide.py`.
 
    The information below is kept here in case it is useful for other
    purposes.
@@ -340,7 +340,7 @@ and patches, respectively::
 
 .. htmlonly::
 
-    See :ref:`pylab_examples-zorder_demo` for a complete example.
+    See :ref:`sphx_glr_gallery_pylab_examples_zorder_demo.py` for a complete example.
 
 You can also use the Axes property
 :meth:`~matplotlib.axes.Axes.set_axisbelow` to control whether the grid
@@ -361,7 +361,7 @@ some ratio which controls the ratio::
 
 .. htmlonly::
 
-    See :ref:`subplots_axes_and_figures-equal_aspect_ratio` for a complete
+    See :ref:`sphx_glr_gallery_subplots_axes_and_figures_equal_aspect_ratio.py` for a complete
     example.
 
 
@@ -406,7 +406,7 @@ locators as desired because the two axes are independent.
 
 .. htmlonly::
 
-    See :ref:`api-two_scales` for a complete example
+    See :ref:`sphx_glr_gallery_api_two_scales.py` for a complete example
 
 .. _howto-batch:
 
@@ -652,7 +652,7 @@ For more on configuring your backend, see
 
 Alternatively, you can avoid pylab/pyplot altogether, which will give
 you a little more control, by calling the API directly as shown in
-:ref:`api-agg_oo`.
+:ref:`sphx_glr_gallery_api_agg_oo_sgskip.py`.
 
 You can either generate hardcopy on the filesystem by calling savefig::
 

diff --git a/doc/faq/installing_faq.rst b/doc/faq/installing_faq.rst
@@ -34,7 +34,7 @@ and run it with::
 
 This will give you additional information about which backends matplotlib is
 loading, version information, and more. At this point you might want to make
-sure you understand matplotlib's :ref:`configuration <customizing-matplotlib>`
+sure you understand matplotlib's :ref:`configuration <sphx_glr_tutorials_01_introductory_customizing.py>`
 process, governed by the :file:`matplotlibrc` configuration file which contains
 instructions within and the concept of the matplotlib backend.
 

diff --git a/doc/faq/troubleshooting_faq.rst b/doc/faq/troubleshooting_faq.rst
@@ -108,7 +108,7 @@ please provide the following information in your e-mail to the
 
 
   * any customizations to your ``matplotlibrc`` file (see
-    :ref:`customizing-matplotlib`).
+    :ref:`sphx_glr_tutorials_01_introductory_customizing.py`).
 
   * if the problem is reproducible, please try to provide a *minimal*,
     standalone Python script that demonstrates the problem.  This is

diff --git a/doc/users/dflt_style_changes.rst b/doc/users/dflt_style_changes.rst
@@ -94,7 +94,7 @@ are only specified via hex values.  To access these colors outside of
 the property cycling the notation for colors ``'CN'``, where ``N``
 takes values 0-9, was added to
 denote the first 10 colors in ``mpl.rcParams['axes.prop_cycle']`` See
-:ref:`colors` for more details.
+:ref:`sphx_glr_tutorials_colors_colors.py` for more details.
 
 To restore the old color cycle use
 
@@ -143,7 +143,7 @@ watch Nathaniel Smith and Stéfan van der Walt's talk from SciPy2015.
 See `here for many more details <https://bids.github.io/colormap/>`__
 about the other alternatives and the tools used to create the color
 map.  For details on all of the color maps available in matplotlib see
-:ref:`colormaps`.
+:ref:`sphx_glr_tutorials_colors_colormaps.py`.
 
 .. raw:: html
 

diff --git a/doc/users/intro.rst b/doc/users/intro.rst
@@ -62,10 +62,10 @@ The Matplotlib code is conceptually divided into three parts: the
 *pylab interface* is the set of functions provided by
 :mod:`matplotlib.pylab` which allow the user to create plots with code
 quite similar to MATLAB figure generating code
-(:ref:`pyplot-tutorial`).  The *Matplotlib frontend* or *Matplotlib
+(:ref:`sphx_glr_tutorials_01_introductory_pyplot.py`).  The *Matplotlib frontend* or *Matplotlib
 API* is the set of classes that do the heavy lifting, creating and
 managing figures, text, lines, plots and so on
-(:ref:`artist-tutorial`).  This is an abstract interface that knows
+(:ref:`sphx_glr_tutorials_02_intermediate_artists.py`).  This is an abstract interface that knows
 nothing about output.  The *backends* are device-dependent drawing
 devices, aka renderers, that transform the frontend representation to
 hardcopy or a display device (:ref:`what-is-a-backend`).  Example

diff --git a/doc/users/prev_whats_new/whats_new_0.98.4.rst b/doc/users/prev_whats_new/whats_new_0.98.4.rst
@@ -79,7 +79,7 @@ psd amplitude scaling
 
 Ryan May did a lot of work to rationalize the amplitude scaling of
 :func:`~matplotlib.pyplot.psd` and friends.  See
-:ref:`pylab_examples-psd_demo2`. and :ref:`pylab_examples-psd_demo3`.
+:ref:`sphx_glr_gallery_pylab_examples_psd_demo2.py`. and :ref:`sphx_glr_gallery_pylab_examples_psd_demo3.py`.
 The changes should increase MATLAB
 compatibility and increase scaling options.
 

diff --git a/doc/users/prev_whats_new/whats_new_0.99.rst b/doc/users/prev_whats_new/whats_new_0.99.rst
@@ -11,11 +11,11 @@ New in matplotlib 0.99
 New documentation
 -----------------
 
-Jae-Joon Lee has written two new guides :ref:`plotting-guide-legend`
+Jae-Joon Lee has written two new guides :ref:`sphx_glr_tutorials_02_intermediate_legend_guide.py`
 and :ref:`plotting-guide-annotation`.  Michael Sarahan has written
-:ref:`image_tutorial`.  John Hunter has written two new tutorials on
-working with paths and transformations: :ref:`path_tutorial` and
-:ref:`transforms_tutorial`.
+:ref:`sphx_glr_tutorials_01_introductory_images.py`.  John Hunter has written two new tutorials on
+working with paths and transformations: :ref:`sphx_glr_tutorials_03_advanced_path_tutorial.py` and
+:ref:`sphx_glr_tutorials_03_advanced_transforms_tutorial.py`.
 
 .. _whats-new-mplot3d:
 
@@ -65,7 +65,7 @@ that denote the data limits -- in various arbitrary locations.  No
 longer are your axis lines constrained to be a simple rectangle around
 the figure -- you can turn on or off left, bottom, right and top, as
 well as "detach" the spine to offset it away from the data.  See
-:ref:`pylab_examples-spine_placement_demo` and
+:ref:`sphx_glr_gallery_pylab_examples_spine_placement_demo.py` and
 :class:`matplotlib.spines.Spine`.
 
 .. figure:: ../../gallery/pyplots/images/sphx_glr_whats_new_99_spines_001.png

diff --git a/doc/users/prev_whats_new/whats_new_1.0.rst b/doc/users/prev_whats_new/whats_new_1.0.rst
@@ -23,7 +23,7 @@ Sophisticated subplot grid layout
 
 Jae-Joon Lee has written :mod:`~matplotlib.gridspec`, a new module for
 doing complex subplot layouts, featuring row and column spans and
-more.  See :ref:`gridspec-guide` for a tutorial overview.
+more.  See :ref:`sphx_glr_tutorials_02_intermediate_gridspec.py` for a tutorial overview.
 
 .. figure:: ../../gallery/userdemo/images/sphx_glr_demo_gridspec01_000.png
    :target: ../../gallery/userdemo/demo_gridspec01.html
@@ -44,7 +44,7 @@ indexing (starts with 0).  e.g.::
   fig, axarr = plt.subplots(2, 2)
   axarr[0,0].plot([1,2,3])   # upper, left
 
-See :ref:`pylab_examples-subplots_demo` for several code examples.
+See :ref:`sphx_glr_gallery_pylab_examples_subplot_demo.py` for several code examples.
 
 Contour fixes and and triplot
 ---------------------------------

diff --git a/doc/users/prev_whats_new/whats_new_1.1.rst b/doc/users/prev_whats_new/whats_new_1.1.rst
@@ -17,8 +17,8 @@ Sankey Diagrams
 
 Kevin Davies has extended Yannick Copin's original Sankey example into a module
 (:mod:`~matplotlib.sankey`) and provided new examples
-(:ref:`api-sankey_basics`, :ref:`api-sankey_links`,
-:ref:`api-sankey_rankine`).
+(:ref:`sphx_glr_gallery_api_sankey_basics.py`, :ref:`sphx_glr_gallery_api_sankey_links.py`,
+:ref:`sphx_glr_gallery_api_sankey_rankine.py`).
 
 .. figure:: ../../gallery/api/images/sphx_glr_sankey_rankine_001.png
    :target: ../../gallery/api/sankey_rankine.html
@@ -36,7 +36,7 @@ animated figures. The :mod:`~matplotlib.animation` module is intended
 to replace the backend-specific examples formerly in the
 :ref:`examples-index` listings.  Examples using the new framework are
 in :ref:`animation-examples-index`; see the entrancing :ref:`double
-pendulum <animation-double_pendulum_animated>` which uses
+pendulum <sphx_glr_gallery_animation_double_pendulum_animated_sgskip.py>` which uses
 :meth:`matplotlib.animation.Animation.save` to create the movie below.
 
 .. raw:: html
@@ -87,7 +87,7 @@ The usage of this functionality can be as simple as ::
 
 and it will adjust the spacing between subplots
 so that the axis labels do not overlap with neighboring subplots. A
-:ref:`plotting-guide-tight-layout` has been created to show how to use
+:ref:`sphx_glr_tutorials_02_intermediate_tight_layout_guide.py` has been created to show how to use
 this new tool.
 
 PyQT4, PySide, and IPython
@@ -116,7 +116,7 @@ legends for complex plots such as :meth:`~matplotlib.pyplot.stem` plots
 will now display correctly. Second, the 'best' placement of a legend has
 been improved in the presence of NANs.
 
-See the :ref:`plotting-guide-legend` for more detailed explanation and
+See the :ref:`sphx_glr_tutorials_02_intermediate_legend_guide.py` for more detailed explanation and
 examples.
 
 .. figure:: ../../gallery/pylab_examples/images/sphx_glr_legend_demo4_001.png

diff --git a/doc/users/prev_whats_new/whats_new_1.2.rst b/doc/users/prev_whats_new/whats_new_1.2.rst
@@ -39,7 +39,7 @@ PGF/TikZ backend
 Peter Würtz wrote a backend that allows matplotlib to export figures as
 drawing commands for LaTeX. These can be processed by PdfLaTeX, XeLaTeX or
 LuaLaTeX using the PGF/TikZ package. Usage examples and documentation are
-found in :ref:`pgf-tutorial`.
+found in :ref:`sphx_glr_tutorials_text_pgf.py`.
 
 .. image:: /_static/pgf_preamble.*
 

diff --git a/doc/users/prev_whats_new/whats_new_1.4.rst b/doc/users/prev_whats_new/whats_new_1.4.rst
@@ -82,8 +82,8 @@ with :func:`~matplotlib.Axes.bxp`.
 Lastly, each artist (e.g., the box, outliers, cap, notches) can now be
 toggled on or off and their styles can be passed in through individual
 kwargs. See the examples:
-:ref:`statistics-boxplot` and
-:ref:`statistics-bxp`
+:ref:`sphx_glr_gallery_statistics_boxplot.py` and
+:ref:`sphx_glr_gallery_statistics_bxp.py`
 
 Added a bool kwarg, :code:`manage_xticks`, which if False disables the management
 of the ticks and limits on the x-axis by :func:`~matplotlib.axes.Axes.bxp`.
@@ -410,7 +410,7 @@ instead of ``:context:`` any time you want to reset the context.
 
 Legend and PathEffects documentation
 ------------------------------------
-The :ref:`plotting-guide-legend` and :ref:`patheffects-guide` have both been
+The :ref:`sphx_glr_tutorials_02_intermediate_legend_guide.py` and :ref:`sphx_glr_tutorials_03_advanced_patheffects_guide.py` have both been
 updated to better reflect the full potential of each of these powerful
 features.
 

diff --git a/doc/users/prev_whats_new/whats_new_1.5.rst b/doc/users/prev_whats_new/whats_new_1.5.rst
@@ -679,7 +679,7 @@ mutually exclusive inside that group.  For tools derived from
 that are called automatically whenever it is toggled.
 
 
-A full example is located in :ref:`user_interfaces-toolmanager`
+A full example is located in :ref:`sphx_glr_gallery_user_interfaces_toolmanager_sgskip.py`
 
 
 cbook.is_sequence_of_strings recognizes string objects

diff --git a/doc/users/screenshots.rst b/doc/users/screenshots.rst
@@ -326,7 +326,7 @@ fonts.  See the :mod:`matplotlib.mathtext` module for additional details.
 
 Matplotlib's mathtext infrastructure is an independent implementation and
 does not require TeX or any external packages installed on your computer. See
-the tutorial at :ref:`mathtext-tutorial`.
+the tutorial at :ref:`sphx_glr_tutorials_text_mathtext.py`.
 
 
 .. _screenshots_tex_demo:
@@ -361,11 +361,11 @@ to plot the spectrogram of one of the EEG channels.
 
 For examples of how to embed matplotlib in different toolkits, see:
 
-   * :ref:`user_interfaces-embedding_in_gtk2`
-   * :ref:`user_interfaces-embedding_in_wx2`
-   * :ref:`user_interfaces-mpl_with_glade`
-   * :ref:`user_interfaces-embedding_in_qt4`
-   * :ref:`user_interfaces-embedding_in_tk`
+   * :ref:`sphx_glr_gallery_user_interfaces_embedding_in_gtk2_sgskip.py`
+   * :ref:`sphx_glr_gallery_user_interfaces_embedding_in_wx2_sgskip.py`
+   * :ref:`sphx_glr_gallery_user_interfaces_mpl_with_glade_sgskip.py`
+   * :ref:`sphx_glr_gallery_user_interfaces_embedding_in_qt4_sgskip.py`
+   * :ref:`sphx_glr_gallery_user_interfaces_embedding_in_tk_sgskip.py`
 
 XKCD-style sketch plots
 =======================

diff --git a/doc/users/shell.rst b/doc/users/shell.rst
@@ -92,7 +92,7 @@ are going to need to understand what a matplotlib backend is
 With the TkAgg backend, which uses the Tkinter user interface toolkit,
 you can use matplotlib from an arbitrary non-gui python shell.  Just set your
 ``backend : TkAgg`` and ``interactive : True`` in your
-:file:`matplotlibrc` file (see :ref:`customizing-matplotlib`) and fire
+:file:`matplotlibrc` file (see :ref:`sphx_glr_tutorials_01_introductory_customizing.py`) and fire
 up python.  Then::
 
   >>> from pylab import *

diff --git a/doc/users/whats_new.rst b/doc/users/whats_new.rst
@@ -287,7 +287,7 @@ Filled ``+`` and ``x`` markers
 
 New fillable *plus* and *x* markers have been added. See
 the :mod:`~matplotlib.markers` module and
-:ref:`marker reference <lines_bars_and_markers-marker_reference>`
+:ref:`marker reference <sphx_glr_gallery_lines_bars_and_markers_marker_reference.py>`
 examples.
 
 `rcount` and `ccount` for `plot_surface()`

diff --git a/examples/animation/basic_example_writer_sgskip.py b/examples/animation/basic_example_writer_sgskip.py
@@ -1,4 +1,3 @@
-# -*- noplot -*-
 """
 ===================
 Saving an animation

diff --git a/examples/animation/double_pendulum_animated_sgskip.py b/examples/animation/double_pendulum_animated_sgskip.py
@@ -1,6 +1,4 @@
 """
-.. _animation-double_pendulum_animated:
-
 ===========================
 The double pendulum problem
 ===========================

diff --git a/examples/animation/moviewriter_sgskip.py b/examples/animation/moviewriter_sgskip.py
@@ -1,7 +1,4 @@
-# -*- noplot -*-
 """
-.. _animation-moviewriter:
-
 ===========
 MovieWriter
 ===========

diff --git a/examples/animation/subplots.py b/examples/animation/subplots.py
@@ -1,6 +1,4 @@
 """
-.. _animation-subplots:
-
 =================
 Animated subplots
 =================