Skip to content

Commit 5300ddb

Browse files
committed
DOC : slight re-organization of INSTALL
1 parent 4ff936e commit 5300ddb

File tree

1 file changed

+45
-23
lines changed

1 file changed

+45
-23
lines changed

INSTALL

Lines changed: 45 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -213,31 +213,19 @@ e.g., if the header to some required library is in
213213
.. _install_requirements:
214214

215215
Build requirements
216-
==================
216+
------------------
217217

218218
These are external packages which you will need to install before
219219
installing matplotlib. If you are building on OSX, see
220220
:ref:`build_osx`. If you are installing dependencies with a package
221221
manager on Linux, you may need to install the development packages
222222
(look for a "-dev" postfix) in addition to the libraries themselves.
223223

224-
.. note::
225224

226-
If you are on Debian/Ubuntu, you can get all the dependencies
227-
required to build matplotlib with::
225+
Required Dependencies
226+
^^^^^^^^^^^^^^^^^^^^^
228227

229-
sudo apt-get build-dep python-matplotlib
230-
231-
If you are on Fedora/RedHat, you can get all the dependencies
232-
required to build matplotlib by first installing ``yum-builddep``
233-
and then running::
234-
235-
su -c "yum-builddep python-matplotlib"
236-
237-
This does not build matplotlib, but it does get the install the
238-
build dependencies, which will make building from source easier.
239-
240-
:term:`python` 2.6, 2.7, 3.1 or 3.2
228+
:term:`python` 2.6, 2.7, 3.3 or 3.4
241229
`Download python <http://www.python.org/download/>`_.
242230

243231
:term:`numpy` |minimum_numpy_version| (or later)
@@ -267,7 +255,8 @@ libpng 1.2 (or later)
267255
build support into the matplotlib single-click installer
268256

269257

270-
**Optional GUI frameworks**
258+
Optional GUI framework
259+
^^^^^^^^^^^^^^^^^^^^^^
271260

272261
These are optional packages which you may want to install to use
273262
matplotlib with a user interface toolkit. See
@@ -288,16 +277,17 @@ backends and the capabilities they provide.
288277
The python wrappers for the wx widgets library for use with the
289278
WX or WXAgg backend
290279

291-
**Optional external programs**
292-
280+
Optional external programs
281+
^^^^^^^^^^^^^^^^^^^^^^^^^^
293282
ffmpeg/avconv or mencoder
294283
Required for the animation module to be save out put to movie
295284
formats.
296285

297286
ImageMagick
298287
Required for the animation module to be able to save to animated gif.
299288

300-
**Optional dependencies**
289+
Optional dependencies
290+
^^^^^^^^^^^^^^^^^^^^^
301291

302292
`Pillow http://python-imaging.github.io/`__
303293
If Pillow is installed, matplotlib can read and write a larger
@@ -309,8 +299,8 @@ ImageMagick
309299
user, you can ignore this since we build support into the
310300
matplotlib single click installer.
311301

312-
**Required libraries that ship with matplotlib**
313-
302+
Required libraries that ship with matplotlib
303+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
314304
:term:`agg` 2.4
315305
The antigrain C++ rendering engine. matplotlib links against the
316306
agg template source statically, so it will not affect anything on
@@ -326,14 +316,46 @@ ImageMagick
326316
`ttconv`
327317
truetype font utility
328318

319+
.. _build_linux:
320+
321+
Building on Linux
322+
-----------------
323+
324+
It is easiest to use your system package manager to install the dependencies.
325+
326+
If you are on Debian/Ubuntu, you can get all the dependencies
327+
required to build matplotlib with::
328+
329+
sudo apt-get build-dep python-matplotlib
330+
331+
If you are on Fedora/RedHat, you can get all the dependencies required
332+
to build matplotlib by first installing ``yum-builddep`` and then
333+
running::
334+
335+
su -c "yum-builddep python-matplotlib"
336+
337+
This does not build matplotlib, but it does get the install the
338+
build dependencies, which will make building from source easier.
339+
340+
329341
.. _build_osx:
330342

331343
Building on OSX
332-
===============
344+
---------------
333345

334346
The build situation on OSX is complicated by the various places one
335347
can get the libpng and freetype requirements (darwinports, fink,
336348
/usr/X11R6) and the different architectures (e.g., x86, ppc, universal) and
337349
the different OSX version (e.g., 10.4 and 10.5). We recommend that you build
338350
the way we do for the OSX release: get the source from the tarball or the
339351
git repository and follow the instruction in :file:`README.osx`.
352+
353+
.. _build_osx:
354+
355+
Building on Windows
356+
-------------------
357+
358+
Building for source on windows can be difficult. Please see
359+
`matplotlib-windbuild
360+
<https://github.com/jbmohler/matplotlib-winbuild>`_ for detailed
361+
instructions, dependency source blobs, and helper scripts.

0 commit comments

Comments
 (0)