Skip to content

Commit 1b2eced

Browse files
raphacosta27raphacosta27
authored
Merge branch 'master' into issue-#16905 
2 parents dedc7f6 + 348e9fe commit 1b2eced

30 files changed

+543
-754
lines changed

‎INSTALL.rst

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
==========
2-
Installing
3-
==========
1+
==================
2+
Installation Guide
3+
==================
44

55
.. note::
66

@@ -44,10 +44,10 @@ distribution, download the :file:`*.tar.gz` file and look in the
4444
To run the test suite:
4545

4646
* extract the :file:`lib/matplotlib/tests` or :file:`lib/mpl_toolkits/tests`
47-
directories from the source distribution;
47+
directories from the source distribution.
4848
* install test dependencies: `pytest <https://pypi.org/project/pytest>`_,
4949
MiKTeX, GhostScript, ffmpeg, avconv, ImageMagick, and `Inkscape
50-
<https://inkscape.org/>`_;
50+
<https://inkscape.org/>`_.
5151
* run ``python -mpytest``.
5252

5353
Third-party distributions of Matplotlib
@@ -120,14 +120,14 @@ Optionally, you can also install a number of packages to enable better user
120120
interface toolkits. See :ref:`what-is-a-backend` for more details on the
121121
optional Matplotlib backends and the capabilities they provide.
122122

123-
* Tk_ (>= 8.3, != 8.6.0 or 8.6.1): for the Tk-based backends;
124-
* PyQt4_ (>= 4.6) or PySide_ (>= 1.0.3) [#]_: for the Qt4-based backends;
125-
* PyQt5_ or PySide2_: for the Qt5-based backends;
126-
* PyGObject_: for the GTK3-based backends [#]_;
127-
* wxPython_ (>= 4) [#]_: for the wx-based backends;
123+
* Tk_ (>= 8.3, != 8.6.0 or 8.6.1): for the Tk-based backends.
124+
* PyQt4_ (>= 4.6) or PySide_ (>= 1.0.3) [#]_: for the Qt4-based backends.
125+
* PyQt5_ or PySide2_: for the Qt5-based backends.
126+
* PyGObject_: for the GTK3-based backends [#]_.
127+
* wxPython_ (>= 4) [#]_: for the wx-based backends.
128128
* pycairo_ (>= 1.11.0) or cairocffi_ (>= 0.8): for the GTK3 and/or cairo-based
129-
backends;
130-
* Tornado_: for the WebAgg backend;
129+
backends.
130+
* Tornado_: for the WebAgg backend.
131131

132132
.. _Tk: https://docs.python.org/3/library/tk.html
133133
.. _PyQt4: https://pypi.org/project/PyQt4
@@ -149,11 +149,11 @@ optional Matplotlib backends and the capabilities they provide.
149149
For better support of animation output format and image file formats, LaTeX,
150150
etc., you can install the following:
151151

152-
* `ffmpeg <https://www.ffmpeg.org/>`_: for saving movies;
152+
* `ffmpeg <https://www.ffmpeg.org/>`_: for saving movies.
153153
* `ImageMagick <https://www.imagemagick.org/script/index.php>`_: for saving
154-
animated gifs;
154+
animated gifs.
155155
* `LaTeX <https://miktex.org/>`_ and `GhostScript (>=9.0)
156-
<https://ghostscript.com/download/>`_ : for rendering text with LaTeX;
156+
<https://ghostscript.com/download/>`_ : for rendering text with LaTeX.
157157
* `fontconfig <https://www.fontconfig.org>`_ (>= 2.7): for detection of system
158158
fonts on Linux.
159159

‎azure-pipelines.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,3 +120,7 @@ steps:
120120
testResultsFiles: '**/test-results.xml'
121121
testRunTitle: 'Python $(python.version)'
122122
condition: succeededOrFailed()
123+
124+
- publish: $(System.DefaultWorkingDirectory)/result_images
125+
artifact: $(Agent.JobName)-result_images
126+
condition: and(failed(), ne(variables['python.version'], 'Pre'))

‎doc/api/next_api_changes/deprecations.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -415,3 +415,14 @@ parent figure, though they can be later removed with ``ax.remove()``.
415415

416416
``.BboxBase.inverse_transformed`` is deprecated (call `.BboxBase.transformed`
417417
on the `~.Transform.inverted()` transform instead).
418+
419+
*orientation* of ``eventplot()`` and `.EventCollection`
420+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
421+
Setting the *orientation* of an ``eventplot()`` or `.EventCollection` to "none"
422+
or None is deprecated; set it to "horizontal" instead. Moreover, the two
423+
orientations ("horizontal" and "vertical") will become case-sensitive in the
424+
future.
425+
426+
*minor* kwarg to `.Axis.get_ticklocs` will become keyword-only
427+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
428+
Passing this argument positionally is deprecated.

‎doc/conf.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,9 @@ def _check_dependencies():
102102
else:
103103
autodoc_default_options = {'members': None, 'undoc-members': None}
104104

105-
nitpicky = True
105+
# missing-references names matches sphinx>=3 behavior, so we can't be nitpicky
106+
# for older sphinxes.
107+
nitpicky = sphinx.version_info >= (3,)
106108
# change this to True to update the allowed failures
107109
missing_references_write_json = False
108110
missing_references_warn_unused_ignores = False

‎doc/devel/documenting_mpl.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -289,12 +289,14 @@ Other packages can also be linked via
289289
`numpy.mean`
290290
291291
will return this link: `numpy.mean`. This works for Python, Numpy, Scipy,
292-
and Pandas (full list is in :file:`doc/conf.py`). Sometimes it is tricky
293-
to get external Sphinx linking to work; to
294-
check that a something exists to link to the following shell command outputs
295-
a list of all objects that can be referenced (in this case for Numpy)::
292+
and Pandas (full list is in :file:`doc/conf.py`). If external linking fails,
293+
you can check the full list of referenceable objects with the following
294+
commands::
296295

296+
python -m sphinx.ext.intersphinx 'https://docs.python.org/3/objects.inv'
297297
python -m sphinx.ext.intersphinx 'https://docs.scipy.org/doc/numpy/objects.inv'
298+
python -m sphinx.ext.intersphinx 'https://docs.scipy.org/doc/scipy/reference/objects.inv'
299+
python -m sphinx.ext.intersphinx 'https://pandas.pydata.org/pandas-docs/stable/objects.inv'
298300

299301
.. _rst-figures-and-includes:
300302

0 commit comments

Comments
 (0)