Merge pull request #11547 from timhoffm/example-links

NelleV · web-flow · commit 50b1abfff05a · 2018-07-03T09:32:56.000-07:00
Fix example links
diff --git a/doc/devel/add_new_projection.rst b/doc/devel/add_new_projection.rst
@@ -62,7 +62,7 @@ Once the class is defined, it must be registered with matplotlib so
 that the user can select it.
 
 A full-fledged and heavily annotated example is in
-:file:`examples/api/custom_scale_example.py`.  There are also some classes
+:doc:`/gallery/scales/custom_scale`.  There are also some classes
 in :mod:`matplotlib.scale` that may be used as starting points.
 
 
@@ -123,7 +123,7 @@ Once the projection axes is defined, it can be used in one of two ways:
 
 
 A full-fledged and heavily annotated example is in
-:file:`examples/api/custom_projection_example.py`.  The polar plot
+:doc:`/gallery/misc/custom_projection`.  The polar plot
 functionality in :mod:`matplotlib.projections.polar` may also be of
 interest.
 
diff --git a/doc/devel/documenting_mpl.rst b/doc/devel/documenting_mpl.rst
@@ -34,11 +34,11 @@ the docstrings of the classes in the Matplotlib library.  Except for
 :file:`doc/api/api_changes/`, these ``.rst`` files are created when the
 documentation is built.
 
-Similarly, the contents of :file:`docs/gallery` and :file:`docs/tutorials` are
+Similarly, the contents of :file:`doc/gallery` and :file:`doc/tutorials` are
 generated by the `Sphinx Gallery`_ from the sources in :file:`examples` and
 :file:`tutorials`.  These sources consist of python scripts that have ReST_
 documentation built into their comments.  Don't directly edit the
-``.rst`` files in :file:`docs/gallery` and :file:`docs/tutorials` as they are
+``.rst`` files in :file:`doc/gallery` and :file:`doc/tutorials` as they are
 regenerated when the documentation are built.
 
 Installing dependencies
@@ -305,7 +305,7 @@ so plots from the examples directory can be included using
 
 .. code-block:: rst
 
-    .. plot:: gallery/pylab_examples/simple_plot.py
+    .. plot:: gallery/lines_bars_and_markers/simple_plot.py
 
 Note that the python script that generates the plot is referred to, rather than
 any plot that is created.  Sphinx-gallery will provide the correct reference
@@ -631,30 +631,30 @@ Adding figures
 As above (see :ref:`rst-figures-and-includes`), figures in the examples gallery
 can be referenced with a `:plot:` directive pointing to the python script that
 created the figure.  For instance the `~.Axes.legend` docstring references
-the file :file:`examples/api/legend.py`:
+the file :file:`examples/text_labels_and_annotations/legend.py`:
 
 .. code-block:: python
 
     """
-     ...
+    ...
 
     Examples
     --------
 
-    .. plot:: gallery/api/legend.py
+    .. plot:: gallery/text_labels_and_annotations/legend.py
     """
 
-Note that ``examples/api/legend.py`` has been mapped to
-``gallery/api/legend.py``, a redirection that may be fixed in future
-re-organization of the docs.
+Note that ``examples/text_labels_and_annotations/legend.py`` has been mapped to
+``gallery/text_labels_and_annotations/legend.py``, a redirection that may be
+fixed in future re-organization of the docs.
 
 Plots can also be directly placed inside docstrings.  Details are in
 :doc:`/devel/plot_directive`.  A short example is:
 
 .. code-block:: python
 
     """
-     ...
+    ...
 
     Examples
     --------
diff --git a/lib/matplotlib/collections.py b/lib/matplotlib/collections.py
@@ -1048,7 +1048,7 @@ def __init__(self,
 
         %(Collection)s
 
-        Example: see :file:`examples/dynamic_collection.py` for
+        Example: see :doc:`/gallery/event_handling/lasso_demo` for a
         complete example::
 
             offsets = np.random.rand(20,2)
@@ -1058,11 +1058,11 @@ def __init__(self,
             collection = RegularPolyCollection(
                 numsides=5, # a pentagon
                 rotation=0, sizes=(50,),
-                facecolors = facecolors,
-                edgecolors = (black,),
-                linewidths = (1,),
-                offsets = offsets,
-                transOffset = ax.transData,
+                facecolors=facecolors,
+                edgecolors=(black,),
+                linewidths=(1,),
+                offsets=offsets,
+                transOffset=ax.transData,
                 )
         """
         Collection.__init__(self, **kwargs)
diff --git a/lib/matplotlib/dates.py b/lib/matplotlib/dates.py
@@ -358,7 +358,7 @@ class bytespdate2num(strpdate2num):
     """
     Use this class to parse date strings to matplotlib datenums when
     you know the date format string of the date you are parsing.  See
-    :file:`examples/misc/load_converter.py`.
+    :doc:`/gallery/misc/load_converter.py`.
     """
     def __init__(self, fmt, encoding='utf-8'):
         """
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -1284,8 +1284,8 @@ def twinx(ax=None):
 
     .. seealso::
 
-       :file:`examples/api_examples/two_scales.py`
-          For an example
+       :doc:`/gallery/subplots_axes_and_figures/two_scales`
+
     """
     if ax is None:
         ax = gca()
