8000 Update INSTALL.rst. · matplotlib/matplotlib@41080b1 · GitHub
[go: up one dir, main page]
Skip to content

Commit 41080b1

Browse files
anntzeranntzer
committed
Update INSTALL.rst.
- Dedent the overindented bullet lists. - Add a link for FreeType. - Suggest `python -mpytest` instead of `pytest` to run the tests for the same reason as `python -mpip` is suggested (avoids invoking an out-of-venv pytest). - Clarify the situation regarding pycairo/cairocffi (the former works for everything and is a requirement for gtk3 (unless you're using pgi, but in that case you're mostly on your own)).
1 parent 126113f commit 41080b1

File tree

1 file changed

+45
-43
lines changed

1 file changed

+45
-43
lines changed

‎INSTALL.rst

Lines changed: 45 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -38,23 +38,25 @@ macOS
3838
To use the native OSX backend you will need :ref:`a framework build
3939
<osxframework-faq>` build of Python.
4040

41-
Test Data
41+
Test data
4242
---------
4343

4444
The wheels (:file:`*.whl`) on the `PyPI download page
4545
<https://pypi.python.org/pypi/matplotlib/>`_ do not contain test data
4646
or example code.
47+
4748
If you want to try the many demos that come in the Matplotlib source
4849
distribution, download the :file:`*.tar.gz` file and look in the
4950
:file:`examples` subdirectory.
51+
5052
To run the test suite:
5153

52-
* extract the :file:`lib/matplotlib/tests` or
53-
:file:`lib/mpl_toolkits/tests` directories from the source distribution;
54-
* install test dependencies: `pytest <https://pypi.python.org/pypi/pytest>`_,
55-
Pillow, MiKTeX, GhostScript, ffmpeg, avconv, ImageMagick, and `Inkscape
56-
<https://inkscape.org/>`_;
57-
* run ``pytest path\to\tests\directory``.
54+
* extract the :file:`lib/matplotlib/tests` or :file:`lib/mpl_toolkits/tests`
55+
directories from the source distribution;
56+
* install test dependencies: `pytest <https://pypi.python.org/pypi/pytest>`_,
57+
Pillow, MiKTeX, GhostScript, ffmpeg, avconv, ImageMagick, and `Inkscape
58+
<https://inkscape.org/>`_;
59+
* run ``python -mpytest``.
5860

5961
Third-party distributions of Matplotlib
6062
=======================================
@@ -68,12 +70,12 @@ Scientific Python Distributions
6870
<https://www.enthought.com/products/canopy/>`_ and `ActiveState
6971
<https://www.activestate.com/activepython/downloads>`_ are excellent
7072
choices that "just work" out of the box for Windows, macOS and common
71-
Linux platforms. `WinPython <https://winpython.github.io/>`__ is an
72-
option for windows users. All of these distributions include
73+
Linux platforms. `WinPython <https://winpython.github.io/>`_ is an
74+
option for Windows users. All of these distributions include
7375
Matplotlib and *lots* of other useful (data) science tools.
7476

75-
Linux : using your package manager
76-
----------------------------------
77+
Linux: using your package manager
78+
---------------------------------
7779

7880
If you are on Linux, you might prefer to use your package manager. Matplotlib
7981
is packaged for almost every major Linux distribution.
@@ -133,58 +135,58 @@ Dependencies
133135

134136
Matplotlib requires the following dependencies:
135137

136-
* `Python <https://www.python.org/downloads/>`_ (>= 3.5)
137-
* `NumPy <http://www.numpy.org>`_ (>= |minimum_numpy_version|)
138-
* `setuptools <https://setuptools.readthedocs.io/en/latest/>`__
139-
* `dateutil <https://pypi.python.org/pypi/python-dateutil>`_ (>= 2.1)
140-
* `pyparsing <https://pyparsing.wikispaces.com/>`__
141-
* `libpng <http://www.libpng.org>`__ (>= 1.2)
142-
* `pytz <http://pytz.sourceforge.net/>`__
143-
* FreeType (>= 2.3)
144-
* `cycler <http://matplotlib.org/cycler/>`__ (>= 0.10.0)
145-
* `six <https://pypi.python.org/pypi/six>`_ (>= 1.10)
146-
* `kiwisolver <https://github.com/nucleic/kiwi>`__ (>= 1.0.0)
138+
* `Python <https://www.python.org/downloads/>`_ (>= 3.5)
139+
* `NumPy <http://www.numpy.org>`_ (>= |minimum_numpy_version|)
140+
* `setuptools <https://setuptools.readthedocs.io/en/latest/>`_
141+
* `dateutil <https://pypi.python.org/pypi/python-dateutil>`_ (>= 2.1)
142+
* `pyparsing <https://pyparsing.wikispaces.com/>`_
143+
* `libpng <http://www.libpng.org>`_ (>= 1.2)
144+
* `pytz <http://pytz.sourceforge.net/>`_
145+
* `FreeType <https://www.freetype.org/>`_ (>= 2.3)
146+
* `cycler <http://matplotlib.org/cycler/>`_ (>= 0.10.0)
147+
* `six <https://pypi.python.org/pypi/six>`_ (>= 1.10)
148+
* `kiwisolver <https://github.com/nucleic/kiwi>`_ (>= 1.0.0)
147149

148150
Optionally, you can also install a number of packages to enable better user
149151
interface toolkits. See :ref:`what-is-a-backend` for more details on the
150152
optional Matplotlib backends and the capabilities they provide.
151153

152-
* :term:`tk` (>= 8.3, != 8.6.0 or 8.6.1): for the TkAgg backend;
153-
* `PyQt4 <https://pypi.python.org/pypi/PyQt4>`_ (>= 4.4) or
154-
`PySide <https://pypi.python.org/pypi/PySide>`_: for the Qt4Agg backend;
155-
* `PyQt5 <https://pypi.python.org/pypi/PyQt5>`_: for the Qt5Agg backend;
156-
* :term:`wxpython` (>= 2.9 or later): for the WX or WXAgg backend;
157-
* `cairocffi <https://cairocffi.readthedocs.io/en/latest/>`__ (>=
158-
v0.8): for cairo based backends;
159-
* `pycairo <https://pypi.python.org/pypi/pycairo>`_: for GTK3Cairo;
160-
* `Tornado <https://pypi.python.org/pypi/tornado>`_: for the WebAgg backend;
154+
* :term:`tk` (>= 8.3, != 8.6.0 or 8.6.1): for the TkAgg backend;
155+
* `PyQt4 <https://pypi.python.org/pypi/PyQt4>`_ (>= 4.4) or
156+
`PySide <https://pypi.python.org/pypi/PySide>`_: for the Qt4Agg backend;
157+
* `PyQt5 <https://pypi.python.org/pypi/PyQt5>`_: for the Qt5Agg backend;
158+
* :term:`wxpython` (>= 4): for the WX or WXAgg backend;
159+
* `cairocffi <https://cairocffi.readthedocs.io/en/latest/>`_ (>=0.8) or
160+
`pycairo <https://pypi.python.org/pypi/pycairo>`_: for the cairo-based
161+
backends (the latter is required for GTK3Cairo);
162+
* `Tornado <https://pypi.python.org/pypi/tornado>`_: for the WebAgg backend;
161163

162164
For better support of animation output format and image file formats, LaTeX,
163165
etc., you can install the following:
164166

165-
* `ffmpeg <https://www.ffmpeg.org/>`_/`avconv
166-
<https://libav.org/avconv.html>`_: for saving movies;
167-
* `ImageMagick <https://www.imagemagick.org/script/index.php>`_: for saving
168-
animated gifs;
169-
* `Pillow <https://pillow.readthedocs.io/en/latest/>`_ (>=3.4): for a larger selection of
170-
image file formats: JPEG, BMP, and TIFF image files;
171-
* `LaTeX <https://miktex.org/>`_ and `GhostScript
172-
<https://ghostscript.com/download/>`_ (for rendering text with LaTeX).
167+
* `ffmpeg <https://www.ffmpeg.org/>`_/`avconv
168+
<https://libav.org/avconv.html>`_: for saving movies;
169+
* `ImageMagick <https://www.imagemagick.org/script/index.php>`_: for saving
170+
animated gifs;
171+
* `Pillow <https://pillow.readthedocs.io/en/latest/>`_ (>=3.4): for a larger
172+
selection of image file formats: JPEG, BMP, and TIFF image files;
173+
* `LaTeX <https://miktex.org/>`_ and `GhostScript
174+
<https://ghostscript.com/download/>`_ (for rendering text with LaTeX).
173175

174176
.. note::
175177

176178
Matplotlib depends on non-Python libraries. `pkg-config
177-
<https://www.freedesktop.org/wiki/Software/pkg-config/>`__ can be used
179+
<https://www.freedesktop.org/wiki/Software/pkg-config/>`_ can be used
178180
to find required non-Python libraries and thus make the install go more
179181
smoothly if the libraries and headers are not in the expected locations.
180182

181183
.. note::
182184

183185
The following libraries are shipped with Matplotlib:
184186

185-
- `Agg`: the Anti-Grain Geometry C++ rendering engine;
186-
- `qhull`: to compute Delaunay triangulation;
187-
- `ttconv`: a true type font utility.
187+
- `Agg`: the Anti-Grain Geometry C++ rendering engine;
188+
- `qhull`: to compute Delaunay triangulation;
189+
- `ttconv`: a TrueType font utility.
188190

189191
.. _build_linux:
190192

0 commit comments

Comments
 (0)
0