10000 Merge pull request #2041 from mdboom/doc-fixes-1-3 · matplotlib/matplotlib@8ea183b · GitHub
[go: up one dir, main page]
Skip to content

Commit 8ea183b

Browse files
mdboommdboom
committed
Merge pull request #2041 from mdboom/doc-fixes-1-3
Fix a number of issues in the doc build
2 parents 600e981 + f9b1a9a commit 8ea183b

File tree

24 files changed

+379
-482
lines changed

24 files changed

+379
-482
lines changed

‎INSTALL

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ the libraries themselves.
183183
`Download python <http://www.python.org/download/>`_.
184184

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

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

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

219-
:term:`pyqt` 3.1 or later
220-
The Qt3 widgets library python wrappers for the QtAgg backend
221-
222219
:term:`pyqt` 4.0 or later
223220
The Qt4 widgets library python wrappers for the Qt4Agg backend
224221

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

233-
:term:`pyfltk` 1.0 or later
234-
The python wrappers of the FLTK widgets library for use with FLTKAgg
235-
236230
**Required libraries that ship with matplotlib**
237231

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

243-
:term:`PyCXX` 6.2.4
237+
`PyCXX` 6.2.4
244238
A library for writing Python extensions in C++.
245239

246240
.. _build_osx:

‎doc/api/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@
3131
font_manager_api.rst
3232
gridspec_api.rst
3333
legend_api.rst
34+
markers_api.rst
3435
mathtext_api.rst
3536
mlab_api.rst
36-
nxutils_api.rst
3737
path_api.rst
3838
pyplot_api.rst
3939
sankey_api.rst

‎doc/api/markers_api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
*******
2-
Markers*
3-
******
2+
Markers
3+
*******
44

55

66
:mod:`matplotlib.markers`
7-
========================
7+
=========================
88

99
.. automodule:: matplotlib.markers
1010
:members:

‎doc/devel/release_guide.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _release-guide:
22

3-
*************************
3+
**************************
44
Doing a matplotlib release
5-
*************************
5+
**************************
66

77
A guide for developers who are doing a matplotlib release.
88

‎doc/pyplots/tex_demo.py

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
#!/usr/bin/env python
21
"""
2+
Demo of TeX rendering.
3+
34
You can use TeX to render all of your matplotlib text if the rc
45
parameter text.usetex is set. This works currently on the agg and ps
56
backends, and requires that you have tex and the other dependencies
@@ -10,26 +11,25 @@
1011
~/.tex.cache
1112
1213
"""
13-
from matplotlib import rc
14-
from numpy import arange, cos, pi
15-
from matplotlib.pyplot import figure, axes, plot, xlabel, ylabel, title, \
16-
grid, savefig, show
14+
import numpy as np
15+
import matplotlib.pyplot as plt
1716

1817

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

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

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

35-
show()
34+
plt.savefig('tex_demo')
35+
plt.show()

‎doc/users/github_stats.rst

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11

22
.. _github-stats:
3+
34
Github stats
45
============
56

@@ -102,7 +103,7 @@ The following 90 authors contributed 1618 commits.
102103

103104

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

108109
Pull Requests (435):
@@ -151,7 +152,7 @@ Pull Requests (435):
151152
* :ghpull:`1762`: Make cbook safe to import while removing duplicate is_string_like;
152153
* :ghpull:`1252`: Properly passing on horiz-/vertOn to Cursor()
153154
* :ghpull:`1686`: Fix lost ticks
154-
* :ghpull:`1640`: Fix bugs in legend positioning with loc='best'
155+
* :ghpull:`1640`: Fix bugs in legend positioning with loc='best'
155156
* :ghpull:`1687`: Update lib/matplotlib/backends/backend_cairo.py
156157
* :ghpull:`1760`: Improved the subplot function documentation and fixed the autogeneration from boilerplate.
157158
* :ghpull:`1716`: PEP8 fixes on the figure module
@@ -202,7 +203,7 @@ Pull Requests (435):
202203
* :ghpull:`1657`: Add EventCollection and eventplot
203204
* :ghpull:`1641`: PEP8 fixes on the rcsetup module
204205
* :ghpull:`1650`: _png.read_png crashes on Python 3 with urllib.request object
205-
* :ghpull:`1568`: removed deprecated methods from the axes module.
206+
* :ghpull:`1568`: removed deprecated methods from the axes module.
206207
* :ghpull:`1589`: Fix shifted ylabels (Issue #1571)
207208
* :ghpull:`1634`: add scatterpoints to rcParam
208209
* :ghpull:`1654`: added explicit 'zorder' kwarg to `Colection` and `LineCollection`.
@@ -353,7 +354,7 @@ Pull Requests (435):
353354
* :ghpull:`1333`: PEP8 fixes on collections.py
354355
* :ghpull:`1336`: PEP8 fixes to colorbar.py
355356
* :ghpull:`1347`: Remove nonfunctioning cbook.isvector
356-
* :ghpull:`1327`: plt.subplots: Set the visibility of the offset text to false on the shared axes.
357+
* :ghpull:`1327`: plt.subplots: Set the visibility of the offset text to false on the shared axes.
357358
* :ghpull:`1335`: PEP8 fixes on cbook.py
358359
* :ghpull:`1334`: PEP8 fixes on blocking_input.py
359360
* :ghpull:`1332`: PEP8 fixes on cm.py
@@ -371,7 +372,7 @@ Pull Requests (435):
371372
* :ghpull:`1285`: Hide Tk root window until later
372373
* :ghpull:`1305`: Fix pointer syntax error
373374
* :ghpull:`1294`: Update lib/mpl_toolkits/mplot3d/axes3d.py
374-
* :ghpull:`1300`: Pcolormesh and colorbar documentation.
375+
* :ghpull:`1300`: Pcolormesh and colorbar documentation.
375376
* :ghpull:`1296`: Make Container._remove_method call correctly
376377
* :ghpull:`1293`: Fixed to contour to support the _as_mpl_transform api.
377378
* :ghpull:`1284`: Fix Image Tutorial: plt.imshow instead of mpimg.imshow.
@@ -383,7 +384,7 @@ Pull Requests (435):
383384
* :ghpull:`1277`: Fixed bug in MaxNLocator.bin_boundaries
384385
* :ghpull:`1273`: Handled baseline image folder identification for non matplotlib projects...
385386
* :ghpull:`1230`: Fix dpi issue for bitmaps on the OS X backend
386-
* :ghpull:`1251`: backend_pgf. Enable custom dashstyles in the pgf backend
387+
* :ghpull:`1251`: backend_pgf. Enable custom dashstyles in the pgf backend
387388
* :ghpull:`1264`: Re-added the matplotlib.dates import on axes
388389
* :ghpull:`1271`: Set axis limits in test_stackplot
389390
* :ghpull:`1269`: Fix typo in docstring
@@ -406,7 +407,7 @@ Pull Requests (435):
406407
* :ghpull:`1231`: fix Typesetting in plot() docstring
407408
* :ghpull:`1215`: PEP8 on lib/matplotlib.afm.py
408409
* :ghpull:`1216`: PEP8 fixes on the animation module
409-
* :ghpull:`1208`: FAIL: matplotlib.tests.test_text.test_contains.test
410+
* :ghpull:`1208`: FAIL: matplotlib.tests.test_text.test_contains.test
410411
* :ghpull:`1209`: Pass linewidth to Mac context properly
411412
* :ghpull:`847`: Add stacked kwarg to hist and implement stacked hists for step histtype
412413
* :ghpull:`1228`: backend_pgf: pep8 edits
@@ -469,7 +470,7 @@ Pull Requests (435):
469470
* :ghpull:`983`: Issues with dateutil and pytz
470471
* :ghpull:`1133`: figure.py: import warnings, and make imports absolute
471472
* :ghpull:`1132`: clean out obsolete matplotlibrc-related bits to close #1123
472-
* :ghpull:`1131`: Cleanup after the gca test.
473+
* :ghpull:`1131`: Cleanup after the gca test.
473474
* :ghpull:`563`: sankey.add() has mutable defaults
474475
* :ghpull:`731`: Plot limit with transform
475476
* :ghpull:`1107`: Added %s support for labels.
@@ -526,7 +527,7 @@ Pull Requests (435):
526527
* :ghpull:`898`: Added warnings for easily confusable subplot/subplots invocations
527528
* :ghpull:`963`: Add detection of file extension for file-like objects
528529
* :ghpull:`973`: Fix sankey.py pep8 and py3 compatibility
529-
* :ghpull:`972`: Force closing PIL image files
530+
* :ghpull:`972`: Force closing PIL image files
530531
* :ghpull:`981`: Fix pathpatch3d_demo.py on Python 3
531532
* :ghpull:`980`: Fix basic_units.py on Python 3. PEP8 and PyLint cleanup.
532533
* :ghpull:`1014`: qt4: remove duplicate file save button; and remove trailing whitespace
@@ -540,7 +541,7 @@ Pull Requests (435):
540541
* :ghpull:`851`: Simple GUI interface enhancements
541542
* :ghpull:`979`: Fix test_mouseclicks.py on Python 3
542543
* :ghpull:`977`: Fix lasso_selector_demo.py on Python 3
543-
* :ghpull:`970`: Fix tiff and jpeg export via PIL
544+
* :ghpull:`970`: Fix tiff and jpeg export via PIL
544545
* :ghpull:`961`: Issue 807 auto minor locator
545546
546547
Issues (787):
@@ -632,7 +633,7 @@ Issues (787):
632633
* :ghissue:`1252`: Properly passing on horiz-/vertOn to Cursor()
633634
* :ghissue:`1632`: Fix build on Ubuntu 12.10
634635
* :ghissue:`1686`: Fix lost ticks
635-
* :ghissue:`1640`: Fix bugs in legend positioning with loc='best'
636+
* :ghissue:`1640`: Fix bugs in legend positioning with loc='best'
636637
* :ghissue:`1687`: Update lib/matplotlib/backends/backend_cairo.py
637638
* :ghissue:`1760`: Improved the subplot function documentation and fixed the autogeneration from boilerplate.
638639
* :ghissue:`1647`: WIP: Deprecation of the cbook module
@@ -725,7 +726,7 @@ Issues (787):
725726
* :ghissue:`1657`: Add EventCollection and eventplot
726727
* :ghissue:`1641`: PEP8 fixes on the rcsetup module
727728
* :ghissue:`1650`: _png.read_png crashes on Python 3 with urllib.request object
728-
* :ghissue:`1568`: removed deprecated methods from the axes module.
729+
* :ghissue:`1568`: removed deprecated methods from the axes module.
729730
* :ghissue:`1571`: Y-labels shifted
730731
* :ghissue:`1589`: Fix shifted ylabels (Issue #1571)
731732
* :ghissue:`1276`: Fix overwriting suptitle
@@ -748,21 +749,21 @@ Issues (787):
748749
* :ghissue:`1582`: Linear tri interpolator
749750
* :ghissue:`1637`: change cbook to relative import
750751
* :ghissue:`1645`: add get_segments method to collections.LineCollection - updated
751-
* :ghissue:`1639`: Rename web_static to web_backend in setup.py
752+
* :ghissue:`1639`: Rename web_static t 10000 o web_backend in setup.py
752753
* :ghissue:`1618`: Mplot3d/crashfixes
753754
* :ghissue:`1636`: hexbin log scale is broken in matplotlib 1.2.0
754755
* :ghissue:`1624`: implemented inverse transform for Mollweide axes
755756
* :ghissue:`1630`: A disconnected callback cannot be reconnected
756757
* :ghissue:`1139`: Make Axes.stem take at least one argument.
757758
* :ghissue:`1426`: WebAgg backend
758759
* :ghissue:`1606`: Document the C/C++ code guidelines
759-
* :ghissue:`1622`: zorder is not respected by all parts of `errorbar`
760+
* :ghissue:`1622`: zorder is not respected by all parts of `errorbar`
760761
* :ghissue:`1628`: Fix errorbar zorder v1.2
761762
* :ghissue:`1625`: saving pgf to a stream is not supported
762763
* :ghissue:`1588`: Annotations appear in incorrect locations
763764
* :ghissue:`1620`: Fix bug in _AnnotationBase
764765
* :ghissue:`1621`: Package for python 3.3 on OS X
765-
* :ghissue:`1616`: Legend: Also calc the bbox of the legend when the frame is not drawn.
766+
* :ghissue:`1616`: Legend: Also calc the bbox of the legend when the frame is not drawn.
766767
* :ghissue:`1587`: Mac OS X 10.5 needs an autoreleasepool here to avoid memory leaks. Newer...
767768
* :ghissue:`1597`: new MatplotlibDeprecationWarning class (against master)
768769
* :ghissue:`1596`: new MatplotlibDeprecationWarning class (against 1.2.x)
@@ -918,7 +919,7 @@ Issues (787):
918919
* :ghissue:`1424`: pcolor fails if edgecolors is not a string
919920
* :ghissue:`1427`: Fix AttrituteError for .lower on tuple of strings
920921
* :ghissue:`1425`: Rebase of #1418 on v1.2.x
921-
* :ghissue:`1418`: Tables: Fix get_window_extent for table
922+
* :ghissue:`1418`: Tables: Fix get_window_extent for table
922923
* :ghissue:`1411`: Fix transparent markers in PDF backend. Closes #1410
923924
* :ghissue:`1410`: Open markers incorrect in PDF output
924925
* :ghissue:`1416`: backend_pdf: optional rgbFace arg in fillp replaces code in draw_markers. Closes #1410
@@ -981,7 +982,7 @@ Issues (787):
981982
* :ghissue:`1333`: PEP8 fixes on collections.py
982983
* :ghissue:`1336`: PEP8 fixes to colorbar.py
983984
* :ghissue:`1347`: Remove nonfunctioning cbook.isvector
984-
* :ghissue:`1327`: plt.subplots: Set the visibility of the offset text to false on the shared axes.
985+
* :ghissue:`1327`: plt.subplots: Set the visibility of the offset text to false on the shared axes.
985986
* :ghissue:`1335`: PEP8 fixes on cbook.py
986987
* :ghissue:`1334`: PEP8 fixes on blocking_input.py
987988
* :ghissue:`1332`: PEP8 fixes on cm.py
@@ -1005,7 +1006,7 @@ Issues (787):
10051006
* :ghissue:`156`: Multicursor not displayed with zoom on
10061007
* :ghissue:`1320`: Cursor widget now uses widgetlock; closes Issue #156
10071008
* :ghissue:`1321`: pgf backend. Y-labels in subplot are not alligned after baseline but bottom of letter
1008-
* :ghissue:`1301`: Colorbar Add kw arguement to colorbar to reenable edges around faces
1009+
* :ghissue:`1301`: Colorbar Add kw arguement to colorbar to reenable edges around faces
10091010
* :ghissue:`1315`: Add documentation of colorbar issue #1188 to colorbar documentation.
10101011
* :ghissue:`1303`: twinx/twiny misses settings axes
10111012
* :ghissue:`1307`: Marker not round with markersize=3
@@ -1017,8 +1018,8 @@ Issues (787):
10171018
* :ghissue:`1294`: Update lib/mpl_toolkits/mplot3d/axes3d.py
10181019
* :ghissue:`159`: Autoscale in hist() with step and log
10191020
* :ghissue:`167`: windows x64 support in _tkagg.so
1020-
* :ghissue:`1300`: Pcolormesh and colorbar documentation.
1021-
* :ghissue:`1178`: Make colorbar draw edge with facecolor around the faces.
1021+
* :ghissue:`1300`: Pcolormesh and colorbar documentation.
1022+
* :ghissue:`1178`: Make colorbar draw edge with facecolor around the faces.
10221023
* :ghissue:`1205`: New 'gridon' keyword in plotfile
10231024
* :ghissue:`1295`: Exception when using Container.remove
10241025
* :ghissue:`1296`: Make Container._remove_method call correctly
@@ -1052,7 +1053,7 @@ Issues (787):
10521053
* :ghissue:`1273`: Handled baseline image folder identification for non matplotlib projects...
10531054
* :ghissue:`1230`: Fix dpi issue for bitmaps on the OS X backend
10541055
* :ghissue:`1274`: backend_pgf: Custom dashstyles and consistency with other backends
1055-
* :ghissue:`1251`: backend_pgf. Enable custom dashstyles in the pgf backend
1056+
* :ghissue:`1251`: backend_pgf. Enable custom dashstyles in the pgf backend
10561057
* :ghissue:`1264`: Re-added the matplotlib.dates import on axes
10571058
* :ghissue:`1271`: Set axis limits in test_stackplot
10581059
* :ghissue:`1269`: Fix typo in docstring
@@ -1086,7 +1087,7 @@ Issues (787):
10861087
* :ghissue:`1231`: fix Typesetting in plot() docstring
10871088
* :ghissue:`1215`: PEP8 on lib/matplotlib.afm.py
10881089
* :ghissue:`1216`: PEP8 fixes on the animation module
1089-
* :ghissue:`1208`: FAIL: matplotlib.tests.test_text.test_contains.test
1090+
* :ghissue:`1208`: FAIL: matplotlib.tests.test_text.test_contains.test
10901091
* :ghissue:`786`: savefig() renders paths and text differently than show()
10911092
* :ghissue:`1209`: Pass linewidth to Mac context properly
10921093
* :ghissue:`847`: Add stacked kwarg to hist and implement stacked hists for step histtype
@@ -1179,7 +1180,7 @@ Issues (787):
11791180
* :ghissue:`1141`: backend_pgf: fix parentheses typo
11801181
* :ghissue:`1114`: Make grid accept alpha rcParam
11811182
* :ghissue:`1118`: ERROR: matplotlib.tests.test_backend_pgf.test_pdflatex on Python 3.x
1182-
* :ghissue:`1116`: ERROR: matplotlib.tests.test_backend_pgf.test_xelatex
1183+
* :ghissue:`1116`: ERROR: matplotlib.tests.test_backend_pgf.test_xelatex
11831184
* :ghissue:`1124`: PGF backend, fix #1116, #1118 and #1128
11841185
* :ghissue:`745`: Cannot run tests with Python 3.x on MacOS 10.7
11851186
* :ghissue:`983`: Issues with dateutil and pytz
@@ -1188,7 +1189,7 @@ Issues (787):
11881189
* :ghissue:`1133`: figure.py: import warnings, and make imports absolute
11891190
* :ghissue:`1123`: Rationalize the number of ancillary (default matplotlibrc) files
11901191
* :ghissue:`1132`: clean out obsolete matplotlibrc-related bits to close #1123
1191-
* :ghissue:`1131`: Cleanup after the gca test.
1192+
* :ghissue:`1131`: Cleanup after the gca test.
11921193
* :ghissue:`563`: sankey.add() has mutable defaults
11931194
* :ghissue:`238`: patch for qt4 backend
11941195
* :ghissue:`731`: Plot limit with transform
@@ -1298,7 +1299,7 @@ Issues (787):
12981299
* :ghissue:`898`: Added warnings for easily confusable subplot/subplots invocations
12991300
* :ghissue:`963`: Add detection of file extension for file-like objects
13001301
* :ghissue:`973`: Fix sankey.py pep8 and py3 compatibility
1301-
* :ghissue:`972`: Force closing PIL image files
1302+
* :ghissue:`972`: Force closing PIL image files
13021303
* :ghissue:`981`: Fix pathpatch3d_demo.py on Python 3
13031304
* :ghissue:`980`: Fix basic_units.py on Python 3. PEP8 and PyLint cleanup.
13041305
* :ghissue:`996`: macosx backend broken by #901: QuadMesh fails so colorbar fails
@@ -1322,7 +1323,7 @@ Issues (787):
13221323
* :ghissue:`851`: Simple GUI interface enhancements
13231324
* :ghissue:`979`: Fix test_mouseclicks.py on Python 3
13241325
* :ghissue:`977`: Fix lasso_selector_demo.py on Python 3
1325-
* :ghissue:`970`: Fix tiff and jpeg export via PIL
1326+
* :ghissue:`970`: Fix tiff and jpeg export via PIL
13261327
* :ghissue:`707`: key_press_event in pyqt4 embedded matplotlib
13271328
* :ghissue:`243`: Debug version/symbols for win32
13281329
* :ghissue:`255`: Classes in _transforms.h in global namespace

0 commit comments

Comments
 (0)
0