Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 9597c9a

Browse files
committed
Get rid of the mpl_examples symlink.
1 parent af0dc67 commit 9597c9a

File tree

6 files changed

+12
-24
lines changed

6 files changed

+12
-24
lines changed

doc/README.txt

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,3 @@ python documentation system built on top of ReST. This directory contains
3636
* _templates - used by the sphinx build system
3737

3838
* sphinxext - Sphinx extensions for the mpl docs
39-
40-
* mpl_examples - a link to the Matplotlib examples in case any
41-
documentation wants to literal include them

doc/devel/documenting_mpl.rst

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -276,27 +276,20 @@ tutorial in :doc:`/tutorials/introductory/customizing`::
276276

277277
.. literalinclude:: ../../_static/matplotlibrc
278278

279-
This is rendered as :doc:`/tutorials/introductory/customizing` (see the
280-
bottom of the page. Note that this is in a tutorial; See
281-
:ref:`writing-examples-and-tutorials` below)
279+
This is rendered as at the bottom of
280+
:doc:`/tutorials/introductory/customizing`. Note that this is in a tutorial;
281+
see :ref:`writing-examples-and-tutorials` below.
282282

283-
In the top level :file:`doc` directory there are symlinks pointing to the
284-
Matplotlib :file:`examples`:
285-
286-
.. code-block:: sh
287-
288-
home:~/mpl/doc> ls -l mpl_*
289-
mpl_examples -> ../examples
290-
291-
Plots are included from the examples dir using the symlink:
283+
The examples directory is also copied to :file:`doc/gallery` by sphinx-gallery,
284+
so plots from the examples directory can be included using
292285

293286
.. code-block:: rst
294287
295-
.. plot:: mpl_examples/pylab_examples/simple_plot.py
288+
.. plot:: gallery/pylab_examples/simple_plot.py
296289
297-
Note that the python script that generates the plot is referred to, rather
298-
than any plot that is created. `Sphinx Gallery`_ will provide the incorrect
299-
reference when the documentation is built.
290+
Note that the python script that generates the plot is referred to, rather than
291+
any plot that is created; sphinx-gallery will provide the correct reference
292+
when the documentation is built.
300293

301294

302295
.. _writing-docstrings:
@@ -392,7 +385,6 @@ to keep in mind:
392385
['aitoff' | 'hammer' | 'lambert' | 'mollweide' | \
393386
'polar' | 'rectilinear'], optional
394387
The projection type of the axes.
395-
"""
396388
397389
...
398390
"""

doc/mpl_examples

Lines changed: 0 additions & 1 deletion
This file was deleted.

lib/matplotlib/axes/_axes.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1153,7 +1153,7 @@ def eventplot(self, positions, orientation='horizontal', lineoffsets=1,
11531153
Examples
11541154
--------
11551155
1156-
.. plot:: mpl_examples/lines_bars_and_markers/eventplot_demo.py
1156+
.. plot:: gallery/lines_bars_and_markers/eventplot_demo.py
11571157
"""
11581158
self._process_unit_info(xdata=positions,
11591159
ydata=[lineoffsets, linelengths],

lib/matplotlib/collections.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1392,7 +1392,7 @@ def __init__(self,
13921392
Examples
13931393
--------
13941394
1395-
.. plot:: mpl_examples/lines_bars_and_markers/eventcollection_demo.py
1395+
.. plot:: gallery/lines_bars_and_markers/eventcollection_demo.py
13961396
"""
13971397

13981398
segment = (lineoffset + linelength / 2.,

pytest.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[pytest]
2-
norecursedirs = .git build ci dist doc extern lib/mpl_examples release unit venv
2+
testpaths = lib
33
python_files = test_*.py
44

55
markers =

0 commit comments

Comments
 (0)