Skip to content

Commit c1a2dc5

Browse files
committed
Merge pull request matplotlib#5818 from jenshnielsen/151docupdates
DOC: Update docs for 1.5.1
2 parents 5ea0a5b + 0393f00 commit c1a2dc5

File tree

3 files changed

+46
-15
lines changed

3 files changed

+46
-15
lines changed

INSTALL

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -190,28 +190,31 @@ Required Dependencies
190190
:term:`numpy` |minimum_numpy_version| (or later)
191191
array support for python (`download numpy <http://numpy.org>`_)
192192

193+
`setuptools <http://pythonhosted.org/setuptools/>`__
194+
Setuptools provides extensions for python package installation.
195+
193196
:term:`dateutil` 1.1 or later
194197
Provides extensions to python datetime handling. If using pip,
195198
easy_install or installing from source, the installer will attempt
196199
to download and install `python_dateutil` from PyPI.
197200

198-
`pyparsing`
201+
`pyparsing <https://pyparsing.wikispaces.com/>`__
199202
Required for matplotlib's mathtext math rendering support. If
200203
using pip, easy_install or installing from source, the installer
201204
will attempt to download and install `pyparsing` from PyPI.
202205

203-
libpng 1.2 (or later)
206+
`libpng 1.2 (or later) <http://www.libpng.org>`__
204207
library for loading and saving :term:`PNG` files (`download
205208
<http://www.libpng.org/pub/png/libpng.html>`__). libpng requires
206209
zlib.
207210

208-
`pytz`
209-
Used to manipulate time-zone aware datetimes.
211+
`pytz <http://pytz.sourceforge.net/>`__
212+
Used to manipulate time-zone aware datetimes. http://pypi.python.org/pypi/pytz
210213

211214
:term:`freetype` 2.3 or later
212215
library for reading true type font files.
213216

214-
``cycler`` 0.9 or later
217+
`cycler <http://matplotlib.org/cycler/>`__ 0.9 or later
215218
Composable cycle class used for constructing style-cycles
216219

217220

@@ -239,11 +242,11 @@ backends and the capabilities they provide.
239242

240243
Optional external programs
241244
^^^^^^^^^^^^^^^^^^^^^^^^^^
242-
ffmpeg/avconv or mencoder
245+
`ffmpeg <https://www.ffmpeg.org/>`__/`avconv <https://libav.org/avconv.html>`__ or `mencoder <http://www.mplayerhq.hu/design7/news.html>`__
243246
Required for the animation module to be save out put to movie
244247
formats.
245248

246-
ImageMagick
249+
`ImageMagick <http://www.imagemagick.org/>`__
247250
Required for the animation module to be able to save to animated gif.
248251

249252
Optional dependencies
@@ -253,7 +256,7 @@ Optional dependencies
253256
If Pillow is installed, matplotlib can read and write a larger
254257
selection of image file formats.
255258

256-
pkg-config
259+
`pkg-config <http://www.freedesktop.org/wiki/Software/pkg-config/>`__
257260
A tool used to find required non-python libraries. This is not strictly
258261
required, but can make installation go more smoothly if the libraries and
259262
headers are not in the expected locations.

doc/_templates/index.html

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,8 +181,7 @@ <h1>Open source</h1>
181181
Please
182182
consider <a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=X9T4KLZT2794S">donating
183183
to the matplotlib project</a> through the Numfocus organization or to
184-
the <a href="http://numfocus.org/johnhunter/">John Hunter Memorial
185-
Fund</a>.
184+
the <a href="http://numfocus.org/johnhunter/">John Hunter Technology Fellowship</a>.
186185
</p>
187186

188187
<p>
@@ -195,6 +194,13 @@ <h1>Open source</h1>
195194
who have made significant <a href="{{ pathto('users/credits') }}">contributions</a>.
196195
</p>
197196

197+
<p>
198+
Matplotlib is hosted on <a href="https://github.com/matplotlib/matplotlib">Github</a>.
199+
<a href="https://github.com/matplotlib/matplotlib/issues">Issues</a> and
200+
<a href="https://github.com/matplotlib/matplotlib/pulls">Pull requests</a>
201+
are tracked at Github too.
202+
</p>
203+
198204

199205
<div class="footnote"><p>
200206
<sup><a name="ftn.matlab" href="#matlab">*</a></sup>

doc/faq/usage_faq.rst

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -417,14 +417,16 @@ a file:
417417
============ ================================================================
418418
Backend Description
419419
============ ================================================================
420-
GTKAgg Agg rendering to a :term:`GTK` 2.x canvas (requires PyGTK_)
421-
GTK3Agg Agg rendering to a :term:`GTK` 3.x canvas (requires PyGObject_)
420+
GTKAgg Agg rendering to a :term:`GTK` 2.x canvas (requires PyGTK_ and
421+
pycairo_ or cairocffi_; Python2 only)
422+
GTK3Agg Agg rendering to a :term:`GTK` 3.x canvas (requires PyGObject_
423+
and pycairo_ or cairocffi_)
422424
GTK GDK rendering to a :term:`GTK` 2.x canvas (not recommended)
423-
(requires PyGTK_)
425+
(requires PyGTK_ and pycairo_ or cairocffi_; Python2 only)
424426
GTKCairo Cairo rendering to a :term:`GTK` 2.x canvas (requires PyGTK_
425-
and pycairo_)
427+
and pycairo_ or cairocffi_; Python2 only)
426428
GTK3Cairo Cairo rendering to a :term:`GTK` 3.x canvas (requires PyGObject_
427-
and pycairo_)
429+
and pycairo_ or cairocffi_)
428430
WXAgg Agg rendering to to a :term:`wxWidgets` canvas
429431
(requires wxPython_)
430432
WX Native :term:`wxWidgets` drawing to a :term:`wxWidgets` Canvas
@@ -446,11 +448,31 @@ macosx Cocoa rendering in OSX windows
446448
.. _PyGTK: http://www.pygtk.org
447449
.. _PyGObject: https://live.gnome.org/PyGObject
448450
.. _pycairo: http://www.cairographics.org/pycairo/
451+
.. _cairocffi: https://pythonhosted.org/cairocffi/
449452
.. _wxPython: http://www.wxpython.org/
450453
.. _TkInter: http://wiki.python.org/moin/TkInter
451454
.. _PyQt4: http://www.riverbankcomputing.co.uk/software/pyqt/intro
452455
.. _PyQt5: http://www.riverbankcomputing.co.uk/software/pyqt/intro
453456

457+
WX backends
458+
===========
459+
460+
At present the release version of `wxPython` (also known as wxPython classic)
461+
does not support python3. A work in progress redesigned version known as
462+
wxPython-Phoenix_ does support python3.
463+
Matplotlib should work with both versions.
464+
465+
.. _wxPython-Phoenix: http://wxpython.org/Phoenix/docs/html/main.html
466+
467+
GTK and Cairo
468+
=============
469+
470+
Both `GTK2` and `GTK3` have implicit dependencies on PyCairo regardless of the
471+
specific Matplotlib backend used. Unfortunatly the latest release of PyCairo
472+
for Python3 does not implement the Python wrappers needed for the `GTK3Agg`
473+
backend. `Cairocffi` can be used as a replacement which implements the correct
474+
wrapper.
475+
454476
How do I select PyQt4 or PySide?
455477
========================================
456478

0 commit comments

Comments
 (0)