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

Skip to content

Commit 36a917c

Browse files
committed
DOC fix typos and minor detail in installation.rst
1 parent 60a1b64 commit 36a917c

File tree

1 file changed

+22
-33
lines changed

1 file changed

+22
-33
lines changed

INSTALL.rst

Lines changed: 22 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
.. The source of this document is INSTALL. During the doc build process,
1+
.. The source of this document is INSTALL.rst. During the doc build process,
22
.. this file is copied over to doc/users/installing.rst.
3-
.. Therefore, you must edit INSTALL, *not* doc/users/installing.rst!
3+
.. Therefore, you must edit INSTALL.rst, *not* doc/users/installing.rst!
4+
45
.. _pip: https://pypi.python.org/pypi/pip/
56

67
==========
@@ -19,16 +20,16 @@ Installing
1920
Installing an official release
2021
==============================
2122

22-
Matplotlib and most of its dependencies all available as wheel packages for
23-
OSX, windows and many linux distributions::
23+
Matplotlib and most of its dependencies arr all available as wheel packages for
24+
OSX, windows and Linux distributions::
2425

2526
pip install -U matplotlib
2627

2728
Third-party distributions of Matplotlib
2829
=======================================
2930

3031
Scientific Python distributions: Conda, Canopy...
31-
--------------------------------------------------
32+
-------------------------------------------------
3233

3334
The first option is to use one of the pre-packaged Python distributions that
3435
already provide Matplotlib built-in. Both `Anaconda
@@ -43,8 +44,9 @@ Linux : using your package manager
4344
If you are on Linux, you might prefer to use your package manager. Matplotlib
4445
is packaged for almost every major Linux distribution.
4546

46-
* Debian / Ubuntu : ``sudo apt-get install python-matplotlib``
47-
* Fedora / Redhat : ``sudo yum install python-matplotlib``
47+
* Debian / Ubuntu: ``sudo apt-get install python-matplotlib``
48+
* Fedora / Red Hat: ``sudo yum install python-matplotlib``
49+
* Arch: ``sudo pacman -S python-matplotlib``
4850

4951
.. _installing_windows:
5052

@@ -53,7 +55,7 @@ Windows
5355

5456
We strongly recommend using `scipy-stack compatible Python distributions
5557
<http://www.scipy.org/install.html>`_ such as WinPython, Python(x,y),
56-
Enthought Canopy, or Continuum Anaconda, which have Matplotlib and many of its
58+
Enthought Canopy, or Continuum Anaconda, which have Matplotlib and its
5759
dependencies, plus other useful packages, preinstalled.
5860

5961
For `standard Python <https://www.python.org/downloads/>`_ installations,
@@ -74,12 +76,6 @@ or
7476
for Python 3.4) redistributable packages need to be installed.
7577

7678

77-
The following backends should work out of the box: agg, tkagg, ps,
78-
pdf and svg.
79-
TkAgg is probably the best backend for interactive use from the
80-
standard Python shell or IPython. It is enabled as the default backend
81-
for the official binaries. GTK3 is not supported on Windows.
82-
8379
The Windows wheels (:file:`*.whl`) on the `PyPI download page
8480
<https://pypi.python.org/pypi/matplotlib/>`_ do not contain test data
8581
or example code.
@@ -94,7 +90,7 @@ To run the test suite:
9490
`mock <https://pypi.python.org/pypi/mock>`_, Pillow, MiKTeX, GhostScript,
9591
ffmpeg, avconv, mencoder, ImageMagick, and `Inkscape
9692
<https://inkscape.org/>`_;
97-
* run ``py.test path\\to\\tests\\directory``.
93+
* run ``py.test path\to\tests\directory``.
9894

9995
.. note::
10096

@@ -149,7 +145,7 @@ packaging Matplotlib.
149145

150146
If you have installed prerequisites to nonstandard places and need to
151147
inform Matplotlib where they are, edit ``setupext.py`` and add the base
152-
dirs to the ``basedir`` dictionary entry for your ``sys.platform``.
148+
dirs to the ``basedir`` dictionary entry for your ``sys.platform``;
153149
e.g., if the header to some required library is in
154150
``/some/path/include/someheader.h``, put ``/some/path`` in the
155151
``basedir`` list for your platform.
@@ -174,7 +170,7 @@ Matplotlib requires a large number of dependencies:
174170
* `backports.functools_lru_cache <https://pypi.python.org/pypi/backports.functools_lru_cache>`_
175171
(for Python 2.7 only)
176172
* `subprocess32 <https://pypi.python.org/pypi/subprocess32/>`_ (for Python
177-
2.7 only, on Linux and mac os X only)
173+
2.7 only, on Linux and Mac OSX only)
178174

179175
Optionally, you can also install a number of packages to enables better user
180176
interface toolkit. See :ref:`what-is-a-backend` for more details on the
@@ -185,12 +181,11 @@ optional Matplotlib backends and the capabilities they provide.
185181
* `PyQt5 <https://pypi.python.org/pypi/PyQt5>`_: for the Qt5Agg backend;
186182
* :term:`pygtk` (>= 2.4): for the GTK and the GTKAgg backend;
187183
* :term:`wxpython` (>= 2.8 or later): for the WX or WXAgg backend;
188-
* `pycairo <https://pypi.python.org/pypi/pycairo>`_;
189-
* `PySide <https://pypi.python.org/pypi/PySide>`_;
190-
* `PyGTK <https://pypi.python.org/pypi/PyGTK>`_;
184+
* `pycairo <https://pypi.python.org/pypi/pycairo>`_: for gtk3cairo;
185+
* `PySide <https://pypi.python.org/pypi/PySide>`_: for the qt4Agg;
191186
* `Tornado <https://pypi.python.org/pypi/tornado>`_: for the WebAgg backend.
192187

193-
For better support of animation output format and image file format, LaTeX,
188+
For better support of animation output format and image file formats, LaTeX,
194189
etc you can
195190
install the following:
196191

@@ -249,27 +244,21 @@ Building on OSX
249244

250245
The build situation on OSX is complicated by the various places one
251246
can get the libpng and freetype requirements (darwinports, fink,
252-
/usr/X11R6) and the different architectures (e.g., x86, ppc, universal) and
247+
/usr/X11R6) and the different architectures (e.g., x86, ppc, universal),
253248
the different OSX version (e.g., 10.4 and 10.5). We recommend that you build
254249
the way we do for the OSX release: get the source from the tarball or the
255250
git repository and install the required dependencies through a third-party
256-
package manager: two widely used package managers are homebrew, and MacPorts.
251+
package manager. Two widely used package managers are homebrew, and MacPorts.
257252
The following example illustrates how to install libpng and freetype using
258-
brew:
259-
260-
Example usage::
253+
brew::
261254

262255
brew install libpng freetype pkg-config
263256

264-
If you are using MacPorts, execute the following instead:
265-
266-
Example usage::
257+
If you are using MacPorts, execute the following instead::
267258

268259
port install libpng freetype pkgconfig
269260

270-
To install Matplotlib from source, execute:
271-
272-
Example usage::
261+
To install Matplotlib from source, execute::
273262

274263
python setup.py install
275264

@@ -310,7 +299,7 @@ install.
310299

311300
The commands below assume that you can compile a native python lib for the python version of your
312301
choice. See `this howto <http://blog.ionelmc.ro/2014/12/21/compiling-python-extensions-on-windows/>`_
313-
how to install and setup such environments. If in doubt: use python 3.5 as it mostly works
302+
how to install and setup such environments. If in doubt: use Python >= 3.5 as it mostly works
314303
without fiddling with environment variables::
315304

316305
# create a new environment with the required packages

0 commit comments

Comments
 (0)