Skip to content

Fix a number of issues in the doc build #2041

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
May 22, 2013
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 3 additions & 9 deletions INSTALL
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ the libraries themselves.
`Download python <http://www.python.org/download/>`_.

:term:`numpy` |minimum_numpy_version| (or later)
array support for python (`download <http://numpy.org>`_)
array support for python (`download numpy <http://numpy.org>`_)

libpng 1.2 (or later)
library for loading and saving :term:`PNG` files (`download
Expand All @@ -201,7 +201,7 @@ libpng 1.2 (or later)
easy_install or installing from source, the installer will attempt
to download and install `python_dateutil` from PyPI.

:term:`pyparsing`
`pyparsing`
Required for matplotlib's mathtext math rendering support. If
using pip, easy_install or installing from source, the installer
will attempt to download and install `pyparsing` from PyPI.
Expand All @@ -216,9 +216,6 @@ backends and the capabilities they provide.
:term:`tk` 8.3 or later
The TCL/Tk widgets library used by the TkAgg backend

:term:`pyqt` 3.1 or later
The Qt3 widgets library python wrappers for the QtAgg backend

:term:`pyqt` 4.0 or later
The Qt4 widgets library python wrappers for the Qt4Agg backend

Expand All @@ -230,17 +227,14 @@ backends and the capabilities they provide.
The python wrappers for the wx widgets library for use with the
WX or WXAgg backend

:term:`pyfltk` 1.0 or later
The python wrappers of the FLTK widgets library for use with FLTKAgg

**Required libraries that ship with matplotlib**

:term:`agg` 2.4
The antigrain C++ rendering engine. matplotlib links against the
agg template source statically, so it will not affect anything on
your system outside of matplotlib.

:term:`PyCXX` 6.2.4
`PyCXX` 6.2.4
A library for writing Python extensions in C++.

.. _build_osx:
Expand Down
2 changes: 1 addition & 1 deletion doc/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@
font_manager_api.rst
gridspec_api.rst
legend_api.rst
markers_api.rst
mathtext_api.rst
mlab_api.rst
nxutils_api.rst
path_api.rst
pyplot_api.rst
sankey_api.rst
Expand Down
6 changes: 3 additions & 3 deletions doc/api/markers_api.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
*******
Markers*
******
Markers
*******


:mod:`matplotlib.markers`
========================
=========================

.. automodule:: matplotlib.markers
:members:
Expand Down
4 changes: 2 additions & 2 deletions doc/devel/release_guide.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _release-guide:

*************************
**************************
Doing a matplotlib release
*************************
**************************

A guide for developers who are doing a matplotlib release.

Expand Down
38 changes: 19 additions & 19 deletions doc/pyplots/tex_demo.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
#!/usr/bin/env python
"""
Demo of TeX rendering.

You can use TeX to render all of your matplotlib text if the rc
parameter text.usetex is set. This works currently on the agg and ps
backends, and requires that you have tex and the other dependencies
Expand All @@ -10,26 +11,25 @@
~/.tex.cache

"""
from matplotlib import rc
from numpy import arange, cos, pi
from matplotlib.pyplot import figure, axes, plot, xlabel, ylabel, title, \
grid, savefig, show
import numpy as np
import matplotlib.pyplot as plt


rc('text', usetex=True)
rc('font', family='serif')
figure(1, figsize=(6,4))
ax = axes([0.1, 0.1, 0.8, 0.7])
t = arange(0.0, 1.0+0.01, 0.01)
s = cos(2*2*pi*t)+2
plot(t, s)
# Example data
t = np.arange(0.0, 1.0 + 0.01, 0.01)
s = np.cos(4 * np.pi * t) + 2

xlabel(r'\textbf{time (s)}')
ylabel(r'\textit{voltage (mV)}',fontsize=16)
title(r"\TeX\ is Number $\displaystyle\sum_{n=1}^\infty\frac{-e^{i\pi}}{2^n}$!",
fontsize=16, color='r')
grid(True)
savefig('tex_demo')
plt.rc('text', usetex=True)
plt.rc('font', family='serif')
plt.plot(t, s)

plt.xlabel(r'\textbf{time} (s)')
plt.ylabel(r'\textit{voltage} (mV)',fontsize=16)
plt.title(r"\TeX\ is Number "
r"$\displaystyle\sum_{n=1}^\infty\frac{-e^{i\pi}}{2^n}$!",
fontsize=16, color='gray')
# Make room for the ridiculously large title.
plt.subplots_adjust(top=0.8)

show()
plt.savefig('tex_demo')
plt.show()
53 changes: 27 additions & 26 deletions doc/users/github_stats.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@

.. _github-stats:

Github stats
============

Expand Down Expand Up @@ -102,7 +103,7 @@ The following 90 authors contributed 1618 commits.


We closed a total of 1222 issues, 435 pull requests and 787 regular issues;
this is the full list (generated with the script
this is the full list (generated with the script
:file:`tools/github_stats.py`):

Pull Requests (435):
Expand Down Expand Up @@ -151,7 +152,7 @@ Pull Requests (435):
* :ghpull:`1762`: Make cbook safe to import while removing duplicate is_string_like;
* :ghpull:`1252`: Properly passing on horiz-/vertOn to Cursor()
* :ghpull:`1686`: Fix lost ticks
* :ghpull:`1640`: Fix bugs in legend positioning with loc='best'
* :ghpull:`1640`: Fix bugs in legend positioning with loc='best'
* :ghpull:`1687`: Update lib/matplotlib/backends/backend_cairo.py
* :ghpull:`1760`: Improved the subplot function documentation and fixed the autogeneration from boilerplate.
* :ghpull:`1716`: PEP8 fixes on the figure module
Expand Down Expand Up @@ -202,7 +203,7 @@ Pull Requests (435):
* :ghpull:`1657`: Add EventCollection and eventplot
* :ghpull:`1641`: PEP8 fixes on the rcsetup module
* :ghpull:`1650`: _png.read_png crashes on Python 3 with urllib.request object
* :ghpull:`1568`: removed deprecated methods from the axes module.
* :ghpull:`1568`: removed deprecated methods from the axes module.
* :ghpull:`1589`: Fix shifted ylabels (Issue #1571)
* :ghpull:`1634`: add scatterpoints to rcParam
* :ghpull:`1654`: added explicit 'zorder' kwarg to `Colection` and `LineCollection`.
Expand Down Expand Up @@ -353,7 +354,7 @@ Pull Requests (435):
* :ghpull:`1333`: PEP8 fixes on collections.py
* :ghpull:`1336`: PEP8 fixes to colorbar.py
* :ghpull:`1347`: Remove nonfunctioning cbook.isvector
* :ghpull:`1327`: plt.subplots: Set the visibility of the offset text to false on the shared axes.
* :ghpull:`1327`: plt.subplots: Set the visibility of the offset text to false on the shared axes.
* :ghpull:`1335`: PEP8 fixes on cbook.py
* :ghpull:`1334`: PEP8 fixes on blocking_input.py
* :ghpull:`1332`: PEP8 fixes on cm.py
Expand All @@ -371,7 +372,7 @@ Pull Requests (435):
* :ghpull:`1285`: Hide Tk root window until later
* :ghpull:`1305`: Fix pointer syntax error
* :ghpull:`1294`: Update lib/mpl_toolkits/mplot3d/axes3d.py
* :ghpull:`1300`: Pcolormesh and colorbar documentation.
* :ghpull:`1300`: Pcolormesh and colorbar documentation.
* :ghpull:`1296`: Make Container._remove_method call correctly
* :ghpull:`1293`: Fixed to contour to support the _as_mpl_transform api.
* :ghpull:`1284`: Fix Image Tutorial: plt.imshow instead of mpimg.imshow.
Expand All @@ -383,7 +384,7 @@ Pull Requests (435):
* :ghpull:`1277`: Fixed bug in MaxNLocator.bin_boundaries
* :ghpull:`1273`: Handled baseline image folder identification for non matplotlib projects...
* :ghpull:`1230`: Fix dpi issue for bitmaps on the OS X backend
* :ghpull:`1251`: backend_pgf. Enable custom dashstyles in the pgf backend
* :ghpull:`1251`: backend_pgf. Enable custom dashstyles in the pgf backend
* :ghpull:`1264`: Re-added the matplotlib.dates import on axes
* :ghpull:`1271`: Set axis limits in test_stackplot
* :ghpull:`1269`: Fix typo in docstring
Expand All @@ -406,7 +407,7 @@ Pull Requests (435):
* :ghpull:`1231`: fix Typesetting in plot() docstring
* :ghpull:`1215`: PEP8 on lib/matplotlib.afm.py
* :ghpull:`1216`: PEP8 fixes on the animation module
* :ghpull:`1208`: FAIL: matplotlib.tests.test_text.test_contains.test
* :ghpull:`1208`: FAIL: matplotlib.tests.test_text.test_contains.test
* :ghpull:`1209`: Pass linewidth to Mac context properly
* :ghpull:`847`: Add stacked kwarg to hist and implement stacked hists for step histtype
* :ghpull:`1228`: backend_pgf: pep8 edits
Expand Down Expand Up @@ -469,7 +470,7 @@ Pull Requests (435):
* :ghpull:`983`: Issues with dateutil and pytz
* :ghpull:`1133`: figure.py: import warnings, and make imports absolute
* :ghpull:`1132`: clean out obsolete matplotlibrc-related bits to close #1123
* :ghpull:`1131`: Cleanup after the gca test.
* :ghpull:`1131`: Cleanup after the gca test.
* :ghpull:`563`: sankey.add() has mutable defaults
* :ghpull:`731`: Plot limit with transform
* :ghpull:`1107`: Added %s support for labels.
Expand Down Expand Up @@ -526,7 +527,7 @@ Pull Requests (435):
* :ghpull:`898`: Added warnings for easily confusable subplot/subplots invocations
* :ghpull:`963`: Add detection of file extension for file-like objects
* :ghpull:`973`: Fix sankey.py pep8 and py3 compatibility
* :ghpull:`972`: Force closing PIL image files
* :ghpull:`972`: Force closing PIL image files
* :ghpull:`981`: Fix pathpatch3d_demo.py on Python 3
* :ghpull:`980`: Fix basic_units.py on Python 3. PEP8 and PyLint cleanup.
* :ghpull:`1014`: qt4: remove duplicate file save button; and remove trailing whitespace
Expand All @@ -540,7 +541,7 @@ Pull Requests (435):
* :ghpull:`851`: Simple GUI interface enhancements
* :ghpull:`979`: Fix test_mouseclicks.py on Python 3
* :ghpull:`977`: Fix lasso_selector_demo.py on Python 3
* :ghpull:`970`: Fix tiff and jpeg export via PIL
* :ghpull:`970`: Fix tiff and jpeg export via PIL
* :ghpull:`961`: Issue 807 auto minor locator

Issues (787):
Expand Down Expand Up @@ -632,7 +633,7 @@ Issues (787):
* :ghissue:`1252`: Properly passing on horiz-/vertOn to Cursor()
* :ghissue:`1632`: Fix build on Ubuntu 12.10
* :ghissue:`1686`: Fix lost ticks
* :ghissue:`1640`: Fix bugs in legend positioning with loc='best'
* :ghissue:`1640`: Fix bugs in legend positioning with loc='best'
* :ghissue:`1687`: Update lib/matplotlib/backends/backend_cairo.py
* :ghissue:`1760`: Improved the subplot function documentation and fixed the autogeneration from boilerplate.
* :ghissue:`1647`: WIP: Deprecation of the cbook module
Expand Down Expand Up @@ -725,7 +726,7 @@ Issues (787):
* :ghissue:`1657`: Add EventCollection and eventplot
* :ghissue:`1641`: PEP8 fixes on the rcsetup module
* :ghissue:`1650`: _png.read_png crashes on Python 3 with urllib.request object
* :ghissue:`1568`: removed deprecated methods from the axes module.
* :ghissue:`1568`: removed deprecated methods from the axes module.
* :ghissue:`1571`: Y-labels shifted
* :ghissue:`1589`: Fix shifted ylabels (Issue #1571)
* :ghissue:`1276`: Fix overwriting suptitle
Expand All @@ -748,21 +749,21 @@ Issues (787):
* :ghissue:`1582`: Linear tri interpolator
* :ghissue:`1637`: change cbook to relative import
* :ghissue:`1645`: add get_segments method to collections.LineCollection - updated
* :ghissue:`1639`: Rename web_static to web_backend in setup.py
* :ghissue:`1639`: Rename web_static to web_backend in setup.py
* :ghissue:`1618`: Mplot3d/crashfixes
* :ghissue:`1636`: hexbin log scale is broken in matplotlib 1.2.0
* :ghissue:`1624`: implemented inverse transform for Mollweide axes
* :ghissue:`1630`: A disconnected callback cannot be reconnected
* :ghissue:`1139`: Make Axes.stem take at least one argument.
* :ghissue:`1426`: WebAgg backend
* :ghissue:`1606`: Document the C/C++ code guidelines
* :ghissue:`1622`: zorder is not respected by all parts of `errorbar`
* :ghissue:`1622`: zorder is not respected by all parts of `errorbar`
* :ghissue:`1628`: Fix errorbar zorder v1.2
* :ghissue:`1625`: saving pgf to a stream is not supported
* :ghissue:`1588`: Annotations appear in incorrect locations
* :ghissue:`1620`: Fix bug in _AnnotationBase
* :ghissue:`1621`: Package for python 3.3 on OS X
* :ghissue:`1616`: Legend: Also calc the bbox of the legend when the frame is not drawn.
* :ghissue:`1616`: Legend: Also calc the bbox of the legend when the frame is not drawn.
* :ghissue:`1587`: Mac OS X 10.5 needs an autoreleasepool here to avoid memory leaks. Newer...
* :ghissue:`1597`: new MatplotlibDeprecationWarning class (against master)
* :ghissue:`1596`: new MatplotlibDeprecationWarning class (against 1.2.x)
Expand Down Expand Up @@ -918,7 +919,7 @@ Issues (787):
* :ghissue:`1424`: pcolor fails if edgecolors is not a string
* :ghissue:`1427`: Fix AttrituteError for .lower on tuple of strings
* :ghissue:`1425`: Rebase of #1418 on v1.2.x
* :ghissue:`1418`: Tables: Fix get_window_extent for table
* :ghissue:`1418`: Tables: Fix get_window_extent for table
* :ghissue:`1411`: Fix transparent markers in PDF backend. Closes #1410
* :ghissue:`1410`: Open markers incorrect in PDF output
* :ghissue:`1416`: backend_pdf: optional rgbFace arg in fillp replaces code in draw_markers. Closes #1410
Expand Down Expand Up @@ -981,7 +982,7 @@ Issues (787):
* :ghissue:`1333`: PEP8 fixes on collections.py
* :ghissue:`1336`: PEP8 fixes to colorbar.py
* :ghissue:`1347`: Remove nonfunctioning cbook.isvector
* :ghissue:`1327`: plt.subplots: Set the visibility of the offset text to false on the shared axes.
* :ghissue:`1327`: plt.subplots: Set the visibility of the offset text to false on the shared axes.
* :ghissue:`1335`: PEP8 fixes on cbook.py
* :ghissue:`1334`: PEP8 fixes on blocking_input.py
* :ghissue:`1332`: PEP8 fixes on cm.py
Expand All @@ -1005,7 +1006,7 @@ Issues (787):
* :ghissue:`156`: Multicursor not displayed with zoom on
* :ghissue:`1320`: Cursor widget now uses widgetlock; closes Issue #156
* :ghissue:`1321`: pgf backend. Y-labels in subplot are not alligned after baseline but bottom of letter
* :ghissue:`1301`: Colorbar Add kw arguement to colorbar to reenable edges around faces
* :ghissue:`1301`: Colorbar Add kw arguement to colorbar to reenable edges around faces
* :ghissue:`1315`: Add documentation of colorbar issue #1188 to colorbar documentation.
* :ghissue:`1303`: twinx/twiny misses settings axes
* :ghissue:`1307`: Marker not round with markersize=3
Expand All @@ -1017,8 +1018,8 @@ Issues (787):
* :ghissue:`1294`: Update lib/mpl_toolkits/mplot3d/axes3d.py
* :ghissue:`159`: Autoscale in hist() with step and log
* :ghissue:`167`: windows x64 support in _tkagg.so
* :ghissue:`1300`: Pcolormesh and colorbar documentation.
* :ghissue:`1178`: Make colorbar draw edge with facecolor around the faces.
* :ghissue:`1300`: Pcolormesh and colorbar documentation.
* :ghissue:`1178`: Make colorbar draw edge with facecolor around the faces.
* :ghissue:`1205`: New 'gridon' keyword in plotfile
* :ghissue:`1295`: Exception when using Container.remove
* :ghissue:`1296`: Make Container._remove_method call correctly
Expand Down Expand Up @@ -1052,7 +1053,7 @@ Issues (787):
* :ghissue:`1273`: Handled baseline image folder identification for non matplotlib projects...
* :ghissue:`1230`: Fix dpi issue for bitmaps on the OS X backend
* :ghissue:`1274`: backend_pgf: Custom dashstyles and consistency with other backends
* :ghissue:`1251`: backend_pgf. Enable custom dashstyles in the pgf backend
* :ghissue:`1251`: backend_pgf. Enable custom dashstyles in the pgf backend
* :ghissue:`1264`: Re-added the matplotlib.dates import on axes
* :ghissue:`1271`: Set axis limits in test_stackplot
* :ghissue:`1269`: Fix typo in docstring
Expand Down Expand Up @@ -1086,7 +1087,7 @@ Issues (787):
* :ghissue:`1231`: fix Typesetting in plot() docstring
* :ghissue:`1215`: PEP8 on lib/matplotlib.afm.py
* :ghissue:`1216`: PEP8 fixes on the animation module
* :ghissue:`1208`: FAIL: matplotlib.tests.test_text.test_contains.test
* :ghissue:`1208`: FAIL: matplotlib.tests.test_text.test_contains.test
* :ghissue:`786`: savefig() renders paths and text differently than show()
* :ghissue:`1209`: Pass linewidth to Mac context properly
* :ghissue:`847`: Add stacked kwarg to hist and implement stacked hists for step histtype
Expand Down Expand Up @@ -1179,7 +1180,7 @@ Issues (787):
* :ghissue:`1141`: backend_pgf: fix parentheses typo
* :ghissue:`1114`: Make grid accept alpha rcParam
* :ghissue:`1118`: ERROR: matplotlib.tests.test_backend_pgf.test_pdflatex on Python 3.x
* :ghissue:`1116`: ERROR: matplotlib.tests.test_backend_pgf.test_xelatex
* :ghissue:`1116`: ERROR: matplotlib.tests.test_backend_pgf.test_xelatex
* :ghissue:`1124`: PGF backend, fix #1116, #1118 and #1128
* :ghissue:`745`: Cannot run tests with Python 3.x on MacOS 10.7
* :ghissue:`983`: Issues with dateutil and pytz
Expand All @@ -1188,7 +1189,7 @@ Issues (787):
* :ghissue:`1133`: figure.py: import warnings, and make imports absolute
* :ghissue:`1123`: Rationalize the number of ancillary (default matplotlibrc) files
* :ghissue:`1132`: clean out obsolete matplotlibrc-related bits to close #1123
* :ghissue:`1131`: Cleanup after the gca test.
* :ghissue:`1131`: Cleanup after the gca test.
* :ghissue:`563`: sankey.add() has mutable defaults
* :ghissue:`238`: patch for qt4 backend
* :ghissue:`731`: Plot limit with transform
Expand Down Expand Up @@ -1298,7 +1299,7 @@ Issues (787):
* :ghissue:`898`: Added warnings for easily confusable subplot/subplots invocations
* :ghissue:`963`: Add detection of file extension for file-like objects
* :ghissue:`973`: Fix sankey.py pep8 and py3 compatibility
* :ghissue:`972`: Force closing PIL image files
* :ghissue:`972`: Force closing PIL image files
* :ghissue:`981`: Fix pathpatch3d_demo.py on Python 3
* :ghissue:`980`: Fix basic_units.py on Python 3. PEP8 and PyLint cleanup.
* :ghissue:`996`: macosx backend broken by #901: QuadMesh fails so colorbar fails
Expand All @@ -1322,7 +1323,7 @@ Issues (787):
* :ghissue:`851`: Simple GUI interface enhancements
* :ghissue:`979`: Fix test_mouseclicks.py on Python 3
* :ghissue:`977`: Fix lasso_selector_demo.py on Python 3
* :ghissue:`970`: Fix tiff and jpeg export via PIL
* :ghissue:`970`: Fix tiff and jpeg export via PIL
* :ghissue:`707`: key_press_event in pyqt4 embedded matplotlib
* :ghissue:`243`: Debug version/symbols for win32
* :ghissue:`255`: Classes in _transforms.h in global namespace
Expand Down
Loading