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

Skip to content

Commit 37af9a6

Browse files
QuLogicNelleV
authored andcommitted
Use consistent capitalization in install instructions.
1 parent f55ed17 commit 37af9a6

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

INSTALL.rst

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Installing an official release
2121
==============================
2222

2323
Matplotlib and most of its dependencies arr all available as wheel packages for
24-
OSX, windows and Linux distributions::
24+
OSX, Windows and Linux distributions::
2525

2626
pip install -U matplotlib
2727

@@ -53,7 +53,7 @@ is packaged for almost every major Linux distribution.
5353
Windows
5454
-------
5555

56-
We strongly recommend using `scipy-stack compatible Python distributions
56+
We strongly recommend using `SciPy-stack compatible Python distributions
5757
<https://www.scipy.org/install.html>`_ such as WinPython, Python(x,y),
5858
Enthought Canopy, or Continuum Anaconda, which have Matplotlib and its
5959
dependencies, plus other useful packages, preinstalled.
@@ -98,7 +98,7 @@ To run the test suite:
9898
TkAgg is probably the best backend for interactive use from the standard
9999
Python shell or from IPython and is enabled as default.
100100

101-
GTK3 is not supported on windows.
101+
GTK3 is not supported on Windows.
102102

103103
For support for other backend, LaTeX rendering, animation input/output and
104104
larger selection of file format, you may need to install `additional
@@ -128,7 +128,7 @@ cross compiling.
128128
export PKG_CONFIG=x86_64-pc-linux-gnu-pkg-config
129129

130130
Once you have satisfied the requirements detailed below (mainly
131-
python, numpy, libpng and freetype), you can build Matplotlib.
131+
Python, NumPy, libpng and FreeType), you can build Matplotlib.
132132
::
133133

134134
cd matplotlib
@@ -158,11 +158,11 @@ Dependencies
158158
Matplotlib requires a large number of dependencies:
159159

160160
* `Python <https://www.python.org/downloads/>`_ (>= 2.7 or >= 3.4)
161-
* `numpy <http://www.numpy.org>`_ (>= |minimum_numpy_version|)
161+
* `NumPy <http://www.numpy.org>`_ (>= |minimum_numpy_version|)
162162
* `setuptools <https://setuptools.readthedocs.io/en/latest/>`__
163163
* `dateutil` (>= 1.1)
164164
* `pyparsing <https://pyparsing.wikispaces.com/>`__
165-
* `libpng <http://www.libpng.org>`__ ( >= 1.2)
165+
* `libpng <http://www.libpng.org>`__ (>= 1.2)
166166
* `pytz <http://pytz.sourceforge.net/>`__
167167
* FreeType (>= 2.3)
168168
* `cycler <http://matplotlib.org/cycler/>`__ (>= 0.10.0)
@@ -181,8 +181,8 @@ optional Matplotlib backends and the capabilities they provide.
181181
* `PyQt5 <https://pypi.python.org/pypi/PyQt5>`_: for the Qt5Agg backend;
182182
* :term:`pygtk` (>= 2.4): for the GTK and the GTKAgg backend;
183183
* :term:`wxpython` (>= 2.8 or later): for the WX or WXAgg backend;
184-
* `pycairo <https://pypi.python.org/pypi/pycairo>`_: for gtk3cairo;
185-
* `PySide <https://pypi.python.org/pypi/PySide>`_: for the qt4Agg;
184+
* `pycairo <https://pypi.python.org/pypi/pycairo>`_: for GTK3Cairo;
185+
* `PySide <https://pypi.python.org/pypi/PySide>`_: for the Qt4Agg backend;
186186
* `Tornado <https://pypi.python.org/pypi/tornado>`_: for the WebAgg backend.
187187

188188
For better support of animation output format and image file formats, LaTeX,
@@ -196,22 +196,22 @@ install the following:
196196
animated gifs);
197197
* `Pillow <https://python-pillow.org/>`__ (for a larger selection of image
198198
file format: JPEG, BMP, and TIFF image files);
199-
* `Latex <https://miktex.org/>`_ and `GhostScript <https://ghostscript.com/download/>`_
199+
* `LaTeX <https://miktex.org/>`_ and `GhostScript <https://ghostscript.com/download/>`_
200200
(for rendering text with LaTeX);
201201

202202
.. note::
203203

204-
Matplotlib depends on a large number of non-python libraries.
204+
Matplotlib depends on a large number of non-Python libraries.
205205
`pkg-config <https://www.freedesktop.org/wiki/Software/pkg-config/>`__
206-
can be used to find required non-python libraries and thus make install go
206+
can be used to find required non-Python libraries and thus make install go
207207
more smoothly if the libraries and headers are not in the expected
208208
locations.
209209

210210
.. note::
211211

212212
The following libraries are shipped with Matplotlib:
213213

214-
- `Agg`: the antigrain C++ rendering engine;
214+
- `Agg`: the Anti-Grain Geometry C++ rendering engine;
215215
- `qhull`: to compute Delaunay triangulation;
216216
- `ttconv`: a true type font utility.
217217

@@ -243,13 +243,13 @@ Building on OSX
243243
---------------
244244

245245
The build situation on OSX is complicated by the various places one
246-
can get the libpng and freetype requirements (darwinports, fink,
246+
can get the libpng and FreeType requirements (MacPorts, Fink,
247247
/usr/X11R6) and the different architectures (e.g., x86, ppc, universal),
248248
the different OSX version (e.g., 10.4 and 10.5). We recommend that you build
249249
the way we do for the OSX release: get the source from the tarball or the
250250
git repository and install the required dependencies through a third-party
251-
package manager. Two widely used package managers are homebrew, and MacPorts.
252-
The following example illustrates how to install libpng and freetype using
251+
package manager. Two widely used package managers are Homebrew, and MacPorts.
252+
The following example illustrates how to install libpng and FreeType using
253253
brew::
254254

255255
brew install libpng freetype pkg-config
@@ -280,11 +280,11 @@ Visual Studio 2015 for 3.5 and 3.6. Python extensions are recommended to be com
280280
with the same compiler.
281281

282282
Since there is no canonical Windows package manager, the methods for building
283-
freetype, zlib, and libpng from source code are documented as a build script
283+
FreeType, zlib, and libpng from source code are documented as a build script
284284
at `matplotlib-winbuild <https://github.com/jbmohler/matplotlib-winbuild>`_.
285285

286286

287-
There are a few possibilities to build matplotlib on Windows:
287+
There are a few possibilities to build Matplotlib on Windows:
288288

289289
* Wheels via `matplotlib-winbuild <https://github.com/jbmohler/matplotlib-winbuild>`_
290290
* Wheels by using conda packages
@@ -294,10 +294,10 @@ Wheel builds using conda packages
294294
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
295295

296296
This is a wheel build, but we use conda packages to get all the requirements. The binary
297-
requirements (png, freetype,...) are statically linked and therefore not needed during the wheel
297+
requirements (png, FreeType,...) are statically linked and therefore not needed during the wheel
298298
install.
299299

300-
The commands below assume that you can compile a native python lib for the python version of your
300+
The commands below assume that you can compile a native Python lib for the Python version of your
301301
choice. See `this howto <https://blog.ionelmc.ro/2014/12/21/compiling-python-extensions-on-windows/>`_
302302
how to install and setup such environments. If in doubt: use Python >= 3.5 as it mostly works
303303
without fiddling with environment variables::
@@ -310,7 +310,7 @@ without fiddling with environment variables::
310310
conda install pyqt
311311
# this package is only available in the conda-forge channel
312312
conda install -c conda-forge msinttypes
313-
# for python 2.7
313+
# for Python 2.7
314314
conda install -c conda-forge backports.functools_lru_cache
315315

316316
# copy the libs which have "wrong" names
@@ -335,13 +335,13 @@ Conda packages
335335

336336
This needs a `working installed C compiler
337337
<https://blog.ionelmc.ro/2014/12/21/compiling-python-extensions-on-windows/>`_
338-
for the version of python you are compiling the package for but you don't need
338+
for the version of Python you are compiling the package for but you don't need
339339
to setup the environment variables::
340340

341341
# only the first time...
342342
conda install conda-build
343343

344-
# the python version you want a package for...
344+
# the Python version you want a package for...
345345
set CONDA_PY=3.5
346346

347347
# builds the package, using a clean build environment

0 commit comments

Comments
 (0)