Get rid of the mpl_examples symlink.

anntzer · anntzer · commit a5a0adc45436 · 2017-12-31T16:03:34.000-08:00
diff --git a/doc/README.txt b/doc/README.txt
@@ -36,6 +36,3 @@ python documentation system built on top of ReST.  This directory contains
 * _templates - used by the sphinx build system
 
 * sphinxext - Sphinx extensions for the mpl docs
-
-* mpl_examples - a link to the Matplotlib examples in case any
-  documentation wants to literal include them
diff --git a/doc/devel/documenting_mpl.rst b/doc/devel/documenting_mpl.rst
@@ -327,15 +327,14 @@ It is not necessary to explicitly save the figure from the script; this will be
 done automatically when the docs are built to ensure that the code that is
 included runs and produces the advertised figure.
 
-There are two options for where to put the code that generates a figure. If
-you want to include a plot in the examples gallery, the code should be added to
-the :file:`examples` directory. Plots from
-the :file:`examples` directory can then be referenced through the symlink
-``mpl_examples`` in the ``doc`` directory, e.g.:
+There are two options for where to put the code that generates a figure. If you
+want to include a plot in the examples gallery, the code should be added to the
+:file:`examples` directory. Plots from the :file:`examples` directory can then
+be referenced through the ``gallery`` directory set up by sphinx-gallery ::
 
 .. code-block:: rst
 
-  .. plot:: mpl_examples/lines_bars_and_markers/fill.py
+  .. plot:: gallery/lines_bars_and_markers/fill.py
 
 Alternatively the plotting code can be placed directly in the docstring.
 To include plots directly in docstrings, see the following guide:
@@ -404,25 +403,12 @@ from :file:`customizing.rst`::
 
     .. literalinclude:: ../../lib/matplotlib/mpl-data/matplotlibrc
 
-One exception to this is when referring to the examples directory. Relative
-paths are extremely confusing in the sphinx plot extensions, so it is easier
-to simply include a symlink to the files at the top doc level directory.
-This way, API documents like :meth:`matplotlib.pyplot.plot` can refer to the
-examples in a known location.
-
-In the top level :file:`doc` directory we have symlinks pointing to the
-Matplotlib :file:`examples`:
-
-.. code-block:: sh
-
-    home:~/mpl/doc> ls -l mpl_*
-    mpl_examples -> ../examples
-
-So we can include plots from the examples dir using the symlink:
+The examples directory is also copied to :file:`doc/gallery` by sphinx-gallery,
+so we can include plots from the examples dir using
 
 .. code-block:: rst
 
-    .. plot:: mpl_examples/pylab_examples/simple_plot.py
+    .. plot:: gallery/pylab_examples/simple_plot.py
 
 .. _internal-section-refs:
 
diff --git a/doc/mpl_examples b/doc/mpl_examples
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -1151,7 +1151,7 @@ def eventplot(self, positions, orientation='horizontal', lineoffsets=1,
         Examples
         --------
 
-        .. plot:: mpl_examples/lines_bars_and_markers/eventplot_demo.py
+        .. plot:: gallery/lines_bars_and_markers/eventplot_demo.py
         """
         self._process_unit_info(xdata=positions,
                                 ydata=[lineoffsets, linelengths],
diff --git a/lib/matplotlib/collections.py b/lib/matplotlib/collections.py
@@ -1392,7 +1392,7 @@ def __init__(self,
         Examples
         --------
 
-        .. plot:: mpl_examples/lines_bars_and_markers/eventcollection_demo.py
+        .. plot:: gallery/lines_bars_and_markers/eventcollection_demo.py
         """
 
         segment = (lineoffset + linelength / 2.,
diff --git a/pytest.ini b/pytest.ini
@@ -1,5 +1,5 @@
 [pytest]
-norecursedirs = .git build ci dist doc extern lib/mpl_examples release unit venv
+testpaths = lib
 python_files = test_*.py
 
 markers =
