Merge pull request matplotlib#134 from WeatherGod/docfix/smalltypos

ddale · ddale · commit c96a7d0bbb08 · 2011-06-03T12:13:37.000-07:00
A reposting of the docfix/smalltypos pull request
diff --git a/doc/_templates/indexsidebar.html b/doc/_templates/indexsidebar.html
@@ -5,7 +5,7 @@ <h3>News</h3>
 to support matplotlib development.</p>
 
 
-<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="{{
+<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="{{
 pathto('users/installing') }}">installing</a>
 </p>
 
@@ -64,7 +64,7 @@ <h3>Need help?</h3>
 but it is a good idea to ping us on the mailing list too.</p>
 
 <p>For details on what's new, see the detailed <a href="{{
-pathto('_static/CHANGELOG', 1) }}">changelog</a> or browse the <a href="https://github.com/matplotlib/matplotlib.git">source code</a>.  Anything that could
+pathto('_static/CHANGELOG', 1) }}">changelog</a> or browse the <a href="https://github.com/matplotlib/matplotlib">source code</a>.  Anything that could
 require changes to your existing codes is logged in the <a href="{{
 pathto('api/api_changes.html', 1) }}">api changes</a> file.</p>
 
diff --git a/doc/api/afm_api.rst b/doc/api/afm_api.rst
@@ -1,6 +1,6 @@
-**************
-matplotlib afm
-**************
+**********************************
+afm (Adobe Font Metrics interface)
+**********************************
 
 
 :mod:`matplotlib.afm`
diff --git a/doc/api/artist_api.rst b/doc/api/artist_api.rst
@@ -1,8 +1,8 @@
 .. _artist-api:
 
-*******************
-matplotlib artists
-*******************
+*******
+artists
+*******
 
 .. inheritance-diagram:: matplotlib.patches matplotlib.lines matplotlib.text
    :parts: 2
diff --git a/doc/api/axes_api.rst b/doc/api/axes_api.rst
@@ -1,6 +1,6 @@
-***************
-matplotlib axes
-***************
+****
+axes
+****
 
 
 :mod:`matplotlib.axes`
diff --git a/doc/api/axis_api.rst b/doc/api/axis_api.rst
@@ -1,6 +1,6 @@
-***************
-matplotlib axis
-***************
+****
+axis
+****
 
 
 :mod:`matplotlib.axis`
diff --git a/doc/api/cbook_api.rst b/doc/api/cbook_api.rst
@@ -1,6 +1,6 @@
-****************
-matplotlib cbook
-****************
+*****
+cbook
+*****
 
 
 :mod:`matplotlib.cbook`
diff --git a/doc/api/cm_api.rst b/doc/api/cm_api.rst
@@ -1,5 +1,5 @@
 *************
-matplotlib cm
+cm (colormap)
 *************
 
 
diff --git a/doc/api/collections_api.rst b/doc/api/collections_api.rst
@@ -1,6 +1,6 @@
-**********************
-matplotlib collections
-**********************
+***********
+collections
+***********
 
 .. inheritance-diagram:: matplotlib.collections
    :parts: 2
diff --git a/doc/api/colorbar_api.rst b/doc/api/colorbar_api.rst
@@ -1,6 +1,6 @@
-*******************
-matplotlib colorbar
-*******************
+********
+colorbar
+********
 
 
 :mod:`matplotlib.colorbar`
diff --git a/doc/api/colors_api.rst b/doc/api/colors_api.rst
@@ -1,6 +1,6 @@
-*****************
-matplotlib colors
-*****************
+******
+colors
+******
 
 
 :mod:`matplotlib.colors`
diff --git a/doc/api/dates_api.rst b/doc/api/dates_api.rst
@@ -1,6 +1,6 @@
-****************
-matplotlib dates
-****************
+*****
+dates
+*****
 
 .. inheritance-diagram:: matplotlib.dates
    :parts: 1
diff --git a/doc/api/figure_api.rst b/doc/api/figure_api.rst
@@ -1,6 +1,6 @@
-*****************
-matplotlib figure
-*****************
+******
+figure
+******
 
 
 :mod:`matplotlib.figure`
diff --git a/doc/api/font_manager_api.rst b/doc/api/font_manager_api.rst
@@ -1,6 +1,6 @@
-***********************
-matplotlib font_manager
-***********************
+************
+font_manager
+************
 
 :mod:`matplotlib.font_manager`
 ==============================
diff --git a/doc/api/gridspec_api.rst b/doc/api/gridspec_api.rst
@@ -1,6 +1,6 @@
-*******************
-matplotlib gridspec
-*******************
+********
+gridspec
+********
 
 
 :mod:`matplotlib.gridspec`
diff --git a/doc/api/index.rst b/doc/api/index.rst
@@ -10,6 +10,7 @@
    :Date: |today|
 
 .. toctree::
+   :maxdepth: 1
 
    api_changes.rst
    matplotlib_configuration_api.rst
@@ -31,7 +32,8 @@
    path_api.rst
    pyplot_api.rst
    nxutils_api.rst
-   spine_api.rst
+   spines_api.rst
    ticker_api.rst
    units_api.rst
    index_backend_api.rst
+   widgets_api.rst
diff --git a/doc/api/index_backend_api.rst b/doc/api/index_backend_api.rst
@@ -1,6 +1,6 @@
-*******************
-matplotlib backends
-*******************
+********
+backends
+********
 
 .. toctree::
 
diff --git a/doc/api/mathtext_api.rst b/doc/api/mathtext_api.rst
@@ -1,6 +1,6 @@
-*******************
-matplotlib mathtext
-*******************
+********
+mathtext
+********
 
 .. inheritance-diagram:: matplotlib.mathtext
    :parts: 1
diff --git a/doc/api/matplotlib_configuration_api.rst b/doc/api/matplotlib_configuration_api.rst
@@ -1,6 +1,6 @@
-************************
-matplotlib configuration
-************************
+*************
+configuration
+*************
 
 
 :mod:`matplotlib`
diff --git a/doc/api/mlab_api.rst b/doc/api/mlab_api.rst
@@ -1,6 +1,6 @@
-****************
-matplotlib mlab
-****************
+****
+mlab
+****
 
 
 :mod:`matplotlib.mlab`
diff --git a/doc/api/nxutils_api.rst b/doc/api/nxutils_api.rst
@@ -1,9 +1,12 @@
-
-*******************
-matplotlib nxutils
-*******************
+*******
+nxutils
+*******
 
 :mod:`matplotlib.nxutils`
 ===========================
 
 .. automodule:: matplotlib.nxutils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/doc/api/path_api.rst b/doc/api/path_api.rst
@@ -1,6 +1,6 @@
-***************
-matplotlib path
-***************
+****
+path
+****
 
 
 :mod:`matplotlib.path`
diff --git a/doc/api/pyplot_api.rst b/doc/api/pyplot_api.rst
@@ -1,6 +1,6 @@
-*****************
-matplotlib pyplot
-*****************
+******
+pyplot
+******
  
 
 :mod:`matplotlib.pyplot`
diff --git a/doc/api/spines_api.rst b/doc/api/spines_api.rst
@@ -1,9 +1,9 @@
-*****************
-matplotlib spine
-*****************
+******
+spines
+******
 
 
-:mod:`matplotlib.spine`
+:mod:`matplotlib.spines`
 ========================
 
 .. automodule:: matplotlib.spines
diff --git a/doc/api/ticker_api.rst b/doc/api/ticker_api.rst
@@ -1,6 +1,6 @@
-*******************
-matplotlib ticker
-*******************
+******
+ticker
+******
 
 
 :mod:`matplotlib.ticker`
diff --git a/doc/api/units_api.rst b/doc/api/units_api.rst
@@ -1,6 +1,6 @@
-*****************
-matplotlib units
-*****************
+*****
+units
+*****
 
 
 :mod:`matplotlib.units`
diff --git a/doc/api/widgets_api.rst b/doc/api/widgets_api.rst
@@ -0,0 +1,12 @@
+*******
+widgets
+*******
+
+
+:mod:`matplotlib.widgets`
+=========================
+
+.. automodule:: matplotlib.widgets
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/devel/coding_guide.rst b/doc/devel/coding_guide.rst
@@ -372,6 +372,22 @@ please ignore it while we consolidate our testing to these locations.)
 
 .. _nose: http://somethingaboutorange.com/mrl/projects/nose/
 
+Requirements
+------------
+
+The following software is required to run the tests:
+
+  - nose_, version 0.11.1 or later
+
+  - `Python Imaging Library
+    <http://www.pythonware.com/products/pil/>`_ (to compare image
+    results)
+
+  - `Ghostscript <http://pages.cs.wisc.edu/~ghost/>`_ (to render PDF
+    files)
+
+  - `Inkscape <http://inkscape.org>`_ (to render SVG files)
+
 Running the tests
 -----------------
 
diff --git a/doc/faq/installing_faq.rst b/doc/faq/installing_faq.rst
@@ -117,12 +117,18 @@ and build and install as usual with::
 
       sudo apt-get build-dep python-matplotlib
 
-    This does not build matplotlib, but it does get the install the
+    If you are on Fedora/RedHat, you can get all the dependencies
+    required to build matplotlib by first installing ``yum-builddep``
+    and then running::
+
+       su -c "yum-builddep python-matplotlib"
+
+    This does not build matplotlib, but it does get all of the
     build dependencies, which will make building from source easier.
 
 
 If you want to be able to follow the development branch as it changes just replace
-the last step with (Make sure you have **setuptools** installed)::
+the last step with (make sure you have **setuptools** installed)::
 
   > python setupegg.py develop
 
@@ -138,11 +144,6 @@ setupegg.py develop` command again to compile them.
 There is more information on :ref:`using git <using-git>` in
 the developer docs.
 
-Install from git
-================
-
-See :ref:`using-git`.
-
 Backends
 ========
 
diff --git a/doc/sphinxext/gen_rst.py b/doc/sphinxext/gen_rst.py
@@ -111,7 +111,7 @@ def generate_example_rst(app):
             rstfile = '%s.rst'%basename
             outrstfile = os.path.join(rstdir, rstfile)
 
-            fhsubdirIndex.write('    %s\n'%rstfile)
+            fhsubdirIndex.write('    %s <%s>\n'%(os.path.basename(basename),rstfile))
 
             if not out_of_date(fullpath, outrstfile):
                 continue
diff --git a/doc/users/installing.rst b/doc/users/installing.rst
diff --git a/lib/matplotlib/contour.py b/lib/matplotlib/contour.py
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
diff --git a/lib/matplotlib/mlab.py b/lib/matplotlib/mlab.py
diff --git a/lib/matplotlib/scale.py b/lib/matplotlib/scale.py
diff --git a/lib/matplotlib/widgets.py b/lib/matplotlib/widgets.py
