10000 fix doc build errors and warnings · cirosantilli/matplotlib@781d8fe · GitHub
[go: up one dir, main page]
Skip to content

Commit 781d8fe

Browse files
ddaleddale
committed
fix doc build errors and warnings
1 parent 2ca5c38 commit 781d8fe

File tree

13 files changed

+26
-70
lines changed

13 files changed

+26
-70
lines changed

‎doc/api/gridspec_api.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ matplotlib gridspec
44

55

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

99
.. automodule:: matplotlib.gridspec
1010
:members:

‎doc/devel/release_guide.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,10 +92,7 @@ replacing 'jdh2358' with your sourceforge login.
9292

9393

9494
Any changes to fix bugs in the release candidate should be fixed in
95-
the release branch and merged into the trunk with `git merge`; see
96-
:ref:`git merge`. When the release candidate is signed off on, build
97-
the final sdist, binaries and eggs, and upload them to the sourceforge
98-
release area.
95+
the release branch and merged into the trunk.
9996

10097

10198
.. _release-uploading:

‎doc/faq/howto_faq.rst

Lines changed: 1 addition & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -525,45 +525,7 @@ Contributing: howto
525525
Submit a patch
526526
-----------------
527527

528-
If you have a github account, or are willing to make one, make a private fork
529-
of the repository at `<https://github.com/matplotlib/matplotlib.git>`_. Then
530-
clone the repository::
531-
532-
git clone git@github.com:your_github_id/matplotlib.git
533-
534-
if you don't have a github account::
535-
536-
git clone git://github.com/matplotlib/matplotlib.git
537-
538-
If your changes are relative to a release branch, change branches, for example::
539-
540-
git checkout v1.0.x
541-
542-
Then make a new branch::
543-
544-
cd matplotlib
545-
git checkout -b topic
546-
547-
Make your changes, making commits as you see fit. To submit the changes, if you
548-
don't have a github account::
549-
550-
git diff topic v1.0.x > topic.diff
551-
552-
Post your patch the :file:`topic.diff` to the `matplotlib-devel
553-
<http://sourceforge.net/mail/?group_id=80706>`_ mailing list.
554-
555-
If you do have a github account, push the topic branch to your fork::
556-
557-
git push origin topic
558-
559-
Then visit your profile at github, select the new branch, and file a pull
560-
request.
561-
562-
If you don't want to create a github account::
563-
564-
git clone git://github.com/matplotlib/matplotlib.git
565-
cd matplotlib
566-
git checkout
528+
See :ref:`making-patches` for information on how to make a patch with git.
567529

568530
If you are posting a patch to fix a code bug, please explain your
569531
patch in words -- what was broken before and how you fixed it. Also,

‎doc/faq/installing_faq.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ install directory. To cleanly rebuild:
9292
<locating-matplotlib-install>`
9393

9494

95-
.. _install-git:
95+
.. _install-from-git:
9696

9797
Install from git
9898
================
@@ -394,9 +394,11 @@ changing the occurrences of ``MacOSX10.4u.sdk`` into ``MacOSX10.5.sdk``
394394
``/Library/Frameworks/Python.framework/Versions/Current/lib/pythonX.Y/site-packages/easy-install.pth``,
395395
(where X.Y is the version of Python you are building against)
396396
Comment out the line containing the name of the directory in which the
397-
previous version of MPL was installed (Looks something like ``./matplotlib-0.98.5.2n2-py2.5-macosx-10.3-fat.egg``).
397+
previous version of MPL was installed (Looks something like
398+
``./matplotlib-0.98.5.2n2-py2.5-macosx-10.3-fat.egg``).
398399

399-
3. Save the following as a shell script , for example ``./install-matplotlib-epd-osx.sh`` ::
400+
3. Save the following as a shell script , for example
401+
``./install-matplotlib-epd-osx.sh``::
400402

401403
NAME=matplotlib
402404
VERSION=v1.0.x

‎doc/mpl_toolkits/axes_grid/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,5 +38,4 @@ Documentation
3838

3939
users/overview.rst
4040
users/index.rst
41-
howtos/index.rst
4241
api/index.rst

‎doc/pyplots/plotmap.py

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,13 @@
99

1010
from pylab import title, colorbar, show, axes, cm, arange, figure, \
1111
text
12+
from matplotlib.cbook import get_sample_data
1213

1314
# read in topo data (on a regular lat/lon grid)
1415
# longitudes go from 20 to 380.
15-
# you can get this data from matplolib svn matplotlib/htdocs/screenshots/data/
16-
datadir = '/home/jdhunter/python/svn/matplotlib/trunk/htdocs/screenshots/data/'
17-
if not os.path.exists(datadir):
18-
raise SystemExit('You need to download the data with svn co https://matplotlib.svn.sourceforge.net/svnroot/matplotlib/trunk/htdocs/screenshots/data/" and set the datadir variable in %s'%__file__)
19-
20-
topoin = np.loadtxt(os.path.join(datadir, 'etopo20data.gz'))
21-
lons = np.loadtxt(os.path.join(datadir, 'etopo20lons.gz'))
22-
lats = np.loadtxt(os.path.join(datadir, 'etopo20lats.gz'))
16+
topoin = np.loadtxt(get_sample_data('screenshots/etopo20data.gz').name)
17+
lons = np.loadtxt(get_sample_data('screenshots/etopo20lons.gz').name)
18+
lats = np.loadtxt(get_sample_data('screenshots/etopo20lats.gz').name)
2319
# shift data so lons go from -180 to 180 instead of 20 to 380.
2420
topoin,lons = shiftgrid(180.,topoin,lons,start=False)
2521

‎doc/pyplots/tex_demo.png

-1 Bytes
Loading

‎doc/users/gridspec.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
\.. _gridspec-guide:
1+
.. _gridspec-guide:
22

33

4-
************************************************
5-
Customizing Location of Subplot Using GridSpec
6-
************************************************
4+
**********************************************
5+
Customizing Location of Subplot Using GridSpec
6+
**********************************************
77

88
``GridSpec``
99
specifies the geometry of the grid that a subplot will be
@@ -19,8 +19,8 @@
1919
0-based indexing and let subplot to occupy multiple cells.
2020

2121

22-
Basic Example of using subplot2grid
23-
====================================
22+
Basic Example of using subplot2grid
23+
===================================
2424

2525
To use subplot2grid, you provide geometry of the grid and the location
2626
of the subplot in the grid. For a simple single-cell subplot::

‎doc/users/image_tutorial.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ object:
228228

229229
There are many other colormap schemes available. See the `list and images of the colormaps <http://matplotlib.sourceforge.net/examples/pylab_examples/show_colormaps.html>`_.
230230

231-
.. _Color Bars
231+
.. _`Color Bars`
232232
233233
Color scale reference
234234
------------------------
@@ -256,7 +256,7 @@ automatically change if you change you switch to a different
256256
colormap - you have to re-create your plot, and add in the colorbar
257257
again.
258258

259-
.. _Data ranges
259+
.. _`Data ranges`
260260 55F
261261
Examining a specific data range
262262
---------------------------------

‎doc/users/installing.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ build everything yourself, it is not difficult to build matplotlib
9898
from source. Grab the latest *tar.gz* release file from `sourceforge
9999
<http://sourceforge.net/project/showfiles.php?group_id=80706>`_, or if
100100
you want to develop matplotlib or just need the latest bugfixed
101-
version, grab the latest git version :ref:`install-git`.
101+
version, grab the latest git version :ref:`install-from-git`.
102102

103103
Once you have satisfied the requirements detailed below (mainly
104104
python, numpy, libpng and freetype), you build matplotlib in the usual
@@ -190,7 +190,7 @@ backends and the capabilities they provide
190190
:term:`pytz` 2007g or later
191191
timezone handling for python datetime objects. By default,
192192
matplotlib will install pytz if it isn't already installed on your
193-
system. To override the default, use :file:`setup.cfg to force or
193+
system. To override the default, use :file:`setup.cfg` to force or
194194
prevent installation of pytz.
195195

196196
:term:`dateutil` 1.1 or later

‎lib/matplotlib/axes.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4074,7 +4074,7 @@ def acorr(self, x, **kwargs):
40744074
40754075
:meth:`~matplotlib.axes.Axes.plot` or
40764076
:meth:`~matplotlib.axes.Axes.vlines`
4077-
For documentation on valid kwargs.
4077+
For documentation on valid kwargs.
40784078
40794079
**Example:**
40804080
@@ -5972,7 +5972,7 @@ def hexbin(self, x, y, C = None, gridsize = 100, bins = None,
59725972
:class:`~matplotlib.collections.PolyCollection` instance; use
59735973
:meth:`~matplotlib.collection.PolyCollection.get_array` on
59745974
this :class:`~matplotlib.collections.PolyCollection` to get
5975-
the counts in each hexagon.. If marginals is True, horizontal
5975+
the counts in each hexagon. If marginals is True, horizontal
59765976
bar and vertical bar (both PolyCollections) will be attached
59775977
to the return collection as attributes *hbar* and *vbar*
59785978

‎lib/matplotlib/mlab.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2053,7 +2053,7 @@ def recs_join(key, name, recs, jointype='outer', missing=0., postfixes=None):
20532053
20542054
returns a record array with columns [rowkey, name0, name1, ... namen-1].
20552055
or if postfixes [PF0, PF1, ..., PFN-1] are supplied,
2056-
[rowkey, namePF0, namePF1, ... namePFN-1].
2056+
[rowkey, namePF0, namePF1, ... namePFN-1].
20572057
20582058
Example::
20592059

‎lib/matplotlib/units.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
rather a units implementation must provide a ConversionInterface, and
99
the register with the Registry converter dictionary. For example,
1010
here is a complete implementation which support plotting with native
11-
datetime objects
11+
datetime objects::
1212
1313
1414
import matplotlib.units as units

0 commit comments

Comments
 (0)
0