Skip to content

Commit c96a7d0

Browse files
ddaleddale
committed
Merge pull request matplotlib#134 from WeatherGod/docfix/smalltypos
A reposting of the docfix/smalltypos pull request
2 parents 22222e4 + 6186817 commit c96a7d0

35 files changed

+354
-250
lines changed

‎doc/_templates/indexsidebar.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ <h3>News</h3>
55
to support matplotlib development.</p>
66

77

8-
<p>matplotlib 1.0.0 is available for <a href="https://sourceforge.net/projects/matplotlib/files/matplotlib/matplotlib-1.0/">download</a>. See <a href="{{ pathto('users/whats_new') }}">what's new</a> and tips on <a href="{{
8+
<p>matplotlib 1.0.1 is available for <a href="https://sourceforge.net/projects/matplotlib/files/matplotlib/matplotlib-1.0.1/">download</a>. See <a href="{{ pathto('users/whats_new') }}">what's new</a> and tips on <a href="{{
99
pathto('users/installing') }}">installing</a>
1010
</p>
1111

@@ -64,7 +64,7 @@ <h3>Need help?</h3>
6464
but it is a good idea to ping us on the mailing list too.</p>
6565

6666
<p>For details on what's new, see the detailed <a href="{{
67-
pathto('_static/CHANGELOG', 1) }}">changelog</a> or browse the <a href="https://github.com/matplotlib/matplotlib.git">source code</a>. Anything that could
67+
pathto('_static/CHANGELOG', 1) }}">changelog</a> or browse the <a href="https://github.com/matplotlib/matplotlib">source code</a>. Anything that could
6868
require changes to your existing codes is logged in the <a href="{{
6969
pathto('api/api_changes.html', 1) }}">api changes</a> file.</p>
7070

‎doc/api/afm_api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
**************
2-
matplotlib afm
3-
**************
1+
**********************************
2+
afm (Adobe Font Metrics interface)
3+
**********************************
44

55

66
:mod:`matplotlib.afm`

‎doc/api/artist_api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _artist-api:
22

3-
*******************
4-
matplotlib artists
5-
*******************
3+
*******
4+
artists
5+
*******
66

77
.. inheritance-diagram:: matplotlib.patches matplotlib.lines matplotlib.text
88
:parts: 2

‎doc/api/axes_api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
***************
2-
matplotlib axes
3-
***************
1+
****
2+
axes
3+
****
44

55

66
:mod:`matplotlib.axes`

‎doc/api/axis_api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
***************
2-
matplotlib axis
3-
***************
1+
****
2+
axis
3+
****
44

55

66
:mod:`matplotlib.axis`

‎doc/api/cbook_api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
****************
2-
matplotlib cbook
3-
****************
1+
*****
2+
cbook
3+
*****
44

55

66
:mod:`matplotlib.cbook`

‎doc/api/cm_api.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
*************
2-
matplotlib cm
2+
cm (colormap)
33
*************
44

55

‎doc/api/collections_api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
**********************
2-
matplotlib collections
3-
**********************
1+
***********
2+
collections
3+
***********
44

55
.. inheritance-diagram:: matplotlib.collections
66
:parts: 2

‎doc/api/colorbar_api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
*******************
2-
matplotlib colorbar
3-
*******************
1+
********
2+
colorbar
3+
********
44

55

66
:mod:`matplotlib.colorbar`

‎doc/api/colors_api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
*****************
2-
matplotlib colors
3-
*****************
1+
******
2+
colors
3+
******
44

55

66
:mod:`matplotlib.colors`

‎doc/api/dates_api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
****************
2-
matplotlib dates
3-
****************
1+
*****
2+
dates
3+
*****
44

55
.. inheritance-diagram:: matplotlib.dates
66
:parts: 1

‎doc/api/figure_api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
*****************
2-
matplotlib figure
3-
*****************
1+
******
2+
figure
3+
******
44

55

66
:mod:`matplotlib.figure`

‎doc/api/font_manager_api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
***********************
2-
matplotlib font_manager
3-
***********************
1+
************
2+
font_manager
3+
************
44

55
:mod:`matplotlib.font_manager`
66
==============================

‎doc/api/gridspec_api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
*******************
2-
matplotlib gridspec
3-
*******************
1+
********
2+
gridspec
3+
********
44

55

66
:mod:`matplotlib.gridspec`

‎doc/api/index.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
:Date: |today|
1111

1212
.. toctree::
13+
:maxdepth: 1
1314

1415
api_changes.rst
1516
matplotlib_configuration_api.rst
@@ -31,7 +32,8 @@
3132
path_api.rst
3233
pyplot_api.rst
3334
nxutils_api.rst
34-
spine_api.rst
35+
spines_api.rst
3536
ticker_api.rst
3637
units_api.rst
3738
index_backend_api.rst
39+
widgets_api.rst

‎doc/api/index_backend_api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
*******************
2-
matplotlib backends
3-
*******************
1+
********
2+
backends
3+
********
44

55
.. toctree::
66

‎doc/api/mathtext_api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
*******************
2-
matplotlib mathtext
3-
*******************
1+
********
2+
mathtext
3+
********
44

55
.. inheritance-diagram:: matplotlib.mathtext
66
:parts: 1

‎doc/api/matplotlib_configuration_api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
************************
2-
matplotlib configuration
3-
************************
1+
*************
2+
configuration
3+
*************
44

55

66
:mod:`matplotlib`

‎doc/api/mlab_api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
****************
2-
matplotlib mlab
3-
****************
1+
****
2+
mlab
3+
****
44

55

66
:mod:`matplotlib.mlab`

‎doc/api/nxutils_api.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
1-
2-
*******************
3-
matplotlib nxutils
4-
*******************
1+
*******
2+
nxutils
3+
*******
54

65
:mod:`matplotlib.nxutils`
76
===========================
87

98
.. automodule:: matplotlib.nxutils
9+
:members:
10+
:undoc-members:
11+
:show-inheritance:
12+

‎doc/api/path_api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
***************
2-
matplotlib path
3-
***************
1+
****
2+
path
3+
****
44

55

66
:mod:`matplotlib.path`

‎doc/api/pyplot_api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
*****************
2-
matplotlib pyplot
3-
*****************
1+
******
2+
pyplot
3+
******
44

55

66
:mod:`matplotlib.pyplot`

‎doc/api/spine_api.rst renamed to ‎doc/api/spines_api.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
*****************
2-
matplotlib spine
3-
*****************
1+
******
2+
spines
3+
******
44

55

6-
:mod:`matplotlib.spine`
6+
:mod:`matplotlib.spines`
77
========================
88

99
.. automodule:: matplotlib.spines

‎doc/api/ticker_api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
*******************
2-
matplotlib ticker
3-
*******************
1+
******
2+
ticker
3+
******
44

55

66
:mod:`matplotlib.ticker`

‎doc/api/units_api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
*****************
2-
matplotlib units
3-
*****************
1+
*****
2+
units
3+
*****
44

55

66
:mod:`matplotlib.units`

‎doc/api/widgets_api.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
*******
2+
widgets
3+
*******
4+
5+
6+
:mod:`matplotlib.widgets`
7+
=========================
8+
9+
.. automodule:: matplotlib.widgets
10+
:members:
11+
:undoc-members:
12+
:show-inheritance:

‎doc/devel/coding_guide.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -372,6 +372,22 @@ please ignore it while we consolidate our testing to these locations.)
372372

373373
.. _nose: http://somethingaboutorange.com/mrl/projects/nose/
374374

375+
Requirements
376+
------------
377+
378+
The following software is required to run the tests:
379+
380+
- nose_, version 0.11.1 or later
381+
382+
- `Python Imaging Library
383+
<http://www.pythonware.com/products/pil/>`_ (to compare image
384+
results)
385+
386+
- `Ghostscript <http://pages.cs.wisc.edu/~ghost/>`_ (to render PDF
387+
files)
388+
389+
- `Inkscape <http://inkscape.org>`_ (to render SVG files)
390+
375391
Running the tests
376392
-----------------
377393

‎doc/faq/installing_faq.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -117,12 +117,18 @@ and build and install as usual with::
117117

118118
sudo apt-get build-dep python-matplotlib
119119

120-
This does not build matplotlib, but it does get the install the
120+
If you are on Fedora/RedHat, you can get all the dependencies
121+
required to build matplotlib by first installing ``yum-builddep``
122+
and then running::
123+
124+
su -c "yum-builddep python-matplotlib"
125+
126+
This does not build matplotlib, but it does get all of the
121127
build dependencies, which will make building from source easier.
122128

123129

124130
If you want to be able to follow the development branch as it changes just replace
125-
the last step with (Make sure you have **setuptools** installed)::
131+
the last step with (make sure you have **setuptools** installed)::
126132

127133
> python setupegg.py develop
128134

@@ -138,11 +144,6 @@ setupegg.py develop` command again to compile them.
138144
There is more information on :ref:`using git <using-git>` in
139145
the developer docs.
140146

141-
Install from git
142-
================
143-
144-
See :ref:`using-git`.
145-
146147
Backends
147148
========
148149

‎doc/sphinxext/gen_rst.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ def generate_example_rst(app):
111111
rstfile = '%s.rst'%basename
112112
outrstfile = os.path.join(rstdir, rstfile)
113113

114-
fhsubdirIndex.write(' %s\n'%rstfile)
114+
fhsubdirIndex.write(' %s <%s>\n'%(os.path.basename(basename),rstfile))
115115

116116
if not out_of_date(fullpath, outrstfile):
117117
continue

0 commit comments

Comments
 (0)