applied Darren's sphinx patch, cleaned up some docstrings

jdh2358 · jdh2358 · commit 107bddd73da3 · 2008-12-16T16:13:07.000Z
svn path=/branches/v0_98_5_maint/; revision=6629
diff --git a/doc/api/api_changes.rst b/doc/api/api_changes.rst
@@ -253,7 +253,7 @@ The :class:`Polar` class has moved to :mod:`matplotlib.projections.polar`.
    `Axes.toggle_log_lineary()` has been removed.
 
 :mod:`matplotlib.artist`
-~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 ============================================================ ============================================================
 Old method                                                   New method
diff --git a/doc/api/font_manager_api.rst b/doc/api/font_manager_api.rst
@@ -11,7 +11,7 @@ matplotlib font_manager
    :show-inheritance:
 
 :mod:`matplotlib.fontconfig_pattern`
-==============================
+========================================
 
 .. automodule:: matplotlib.fontconfig_pattern
    :members:
diff --git a/doc/pyplots/plotmap.py b/doc/pyplots/plotmap.py
@@ -11,7 +11,7 @@
 # read in topo data (on a regular lat/lon grid)
 # longitudes go from 20 to 380.
 # you can get this data from matplolib svn matplotlib/htdocs/screenshots/data/
-datadir = '/home/jdhunter/python/svn/matplotlib/htdocs/screenshots/data/'
+datadir = '/home/jdhunter/python/svn/matplotlib/trunk/htdocs/screenshots/data/'
 if not os.path.exists(datadir):
     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__)
 
diff --git a/doc/sphinxext/inheritance_diagram.py b/doc/sphinxext/inheritance_diagram.py
@@ -39,8 +39,6 @@ class E(B): pass
     from md5 import md5
 
 from docutils.nodes import Body, Element
-from docutils.writers.html4css1 import HTMLTranslator
-from sphinx.latexwriter import LaTeXTranslator
 from docutils.parsers.rst import directives
 from sphinx.roles import xfileref_role
 
@@ -409,12 +407,9 @@ def run(self):
                                   inheritance_diagram_directive)
 
 def setup(app):
-    app.add_node(inheritance_diagram)
-
-    HTMLTranslator.visit_inheritance_diagram = \
-        visit_inheritance_diagram(html_output_graph)
-    HTMLTranslator.depart_inheritance_diagram = do_nothing
-
-    LaTeXTranslator.visit_inheritance_diagram = \
-        visit_inheritance_diagram(latex_output_graph)
-    LaTeXTranslator.depart_inheritance_diagram = do_nothing
+    app.add_node(inheritance_diagram,
+                 html=(visit_inheritance_diagram(html_output_graph),
+                       do_nothing))
+    app.add_node(inheritance_diagram,
+                 latex=(visit_inheritance_diagram(latex_output_graph),
+                        do_nothing))
diff --git a/doc/sphinxext/mathmpl.py b/doc/sphinxext/mathmpl.py
@@ -6,8 +6,6 @@
 
 from docutils import nodes
 from docutils.parsers.rst import directives
-from docutils.writers.html4css1 import HTMLTranslator
-from sphinx.latexwriter import LaTeXTranslator
 import warnings
 
 # Define LaTeX math node:
@@ -69,8 +67,6 @@ def visit_latex_math_html(self, node):
         self.body.append(latex2html(node, source))
     def depart_latex_math_html(self, node):
             pass
-    HTMLTranslator.visit_latex_math = visit_latex_math_html
-    HTMLTranslator.depart_latex_math = depart_latex_math_html
 
     # Add visit/depart methods to LaTeX-Translator:
     def visit_latex_math_latex(self, node):
@@ -83,8 +79,13 @@ def visit_latex_math_latex(self, node):
                               '\\end{equation}'])
     def depart_latex_math_latex(self, node):
             pass
-    LaTeXTranslator.visit_latex_math = visit_latex_math_latex
-    LaTeXTranslator.depart_latex_math = depart_latex_math_latex
+
+    app.add_node(latex_math, html=(visit_latex_math_html,
+                                   depart_latex_math_html))
+    app.add_node(latex_math, latex=(visit_latex_math_latex,
+                                    depart_latex_math_latex))
+    app.add_role('math', math_role)
+
 
 from matplotlib import rcParams
 from matplotlib.mathtext import MathTextParser
diff --git a/doc/sphinxext/only_directives.py b/doc/sphinxext/only_directives.py
@@ -4,8 +4,6 @@
 #
 
 from docutils.nodes import Body, Element
-from docutils.writers.html4css1 import HTMLTranslator
-from sphinx.latexwriter import LaTeXTranslator
 from docutils.parsers.rst import directives
 
 class html_only(Body, Element):
@@ -63,9 +61,6 @@ class LatexOnlyDirective(OnlyDirective):
     directives.register_directive('latexonly', LatexOnlyDirective)
 
 def setup(app):
-    app.add_node(html_only)
-    app.add_node(latex_only)
-
     # Add visit/depart methods to HTML-Translator:
     def visit_perform(self, node):
         pass
@@ -76,12 +71,7 @@ def visit_ignore(self, node):
     def depart_ignore(self, node):
         node.children = []
 
-    HTMLTranslator.visit_html_only = visit_perform
-    HTMLTranslator.depart_html_only = depart_perform
-    HTMLTranslator.visit_latex_only = visit_ignore
-    HTMLTranslator.depart_latex_only = depart_ignore
-
-    LaTeXTranslator.visit_html_only = visit_ignore
-    LaTeXTranslator.depart_html_only = depart_ignore
-    LaTeXTranslator.visit_latex_only = visit_perform
-    LaTeXTranslator.depart_latex_only = depart_perform
+    app.add_node(html_only, html=(visit_perform, depart_perform))
+    app.add_node(html_only, latex=(visit_ignore, depart_ignore))
+    app.add_node(latex_only, latex=(visit_perform, depart_perform))
+    app.add_node(latex_only, html=(visit_ignore, depart_ignore))
diff --git a/doc/users/event_handling.rst b/doc/users/event_handling.rst
@@ -64,8 +64,8 @@ Event name               Class and description
 'scroll_event'           :class:`~matplotlib.backend_bases.MouseEvent`     - mouse scroll wheel is rolled
 'figure_enter_event'     :class:`~matplotlib.backend_bases.LocationEvent`  - mouse enters a new figure
 'figure_leave_event'     :class:`~matplotlib.backend_bases.LocationEvent`  - mouse leaves a figure
-'axes_enter_event'     :class:`~matplotlib.backend_bases.LocationEvent`    - mouse enters a new axes
-'axes_leave_event'     :class:`~matplotlib.backend_bases.LocationEvent`    - mouse leaves an axes
+'axes_enter_event'       :class:`~matplotlib.backend_bases.LocationEvent`  - mouse enters a new axes
+'axes_leave_event'       :class:`~matplotlib.backend_bases.LocationEvent`  - mouse leaves an axes
 =======================  ======================================================================================
 
 .. _event-attributes:
diff --git a/lib/matplotlib/collections.py b/lib/matplotlib/collections.py
@@ -703,7 +703,7 @@ def span_where(x, ymin, ymax, where, **kwargs):
         on the y-axis from *ymin* to *ymax*
 
         A :class:`BrokenBarHCollection` is returned.
-        **kwargs are passed on to the collection
+        *kwargs* are passed on to the collection
         """
         xranges = []
         for ind0, ind1 in mlab.contiguous_regions(where):
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -603,7 +603,7 @@ def subplot(*args, **kwargs):
 
       *axisbg*:
         The background color of the subplot, which can be any valid
-        color specifier.  See :module:`matplotlib.colors` for more
+        color specifier.  See :mod:`matplotlib.colors` for more
         information.
 
       *polar*:
@@ -1138,63 +1138,62 @@ def thetagrids(*args, **kwargs):
 def plotting():
     """
     Plotting commands
-
-    =========      =================================================
-    Command        Description
-    =========      =================================================
-    axes           Create a new axes
-    axis           Set or return the current axis limits
-    bar            make a bar chart
-    boxplot        make a box and whiskers chart
-    cla            clear current axes
-    clabel         label a contour plot
-    clf            clear a figure window
-    close          close a figure window
-    colorbar       add a colorbar to the current figure
-    cohere         make a plot of coherence
-    contour        make a contour plot
-    contourf       make a filled contour plot
-    csd            make a plot of cross spectral density
-    draw           force a redraw of the current figure
-    errorbar       make an errorbar graph
-    figlegend      add a legend to the figure
-    figimage       add an image to the figure, w/o resampling
-    figtext        add text in figure coords
-    figure         create or change active figure
-    fill           make filled polygons
+    ============    =================================================
+    Command         Description
+    =========       =================================================
+    axes            Create a new axes
+    axis            Set or return the current axis limits
+    bar             make a bar chart
+    boxplot         make a box and whiskers chart
+    cla             clear current axes
+    clabel          label a contour plot
+    clf             clear a figure window
+    close           close a figure window
+    colorbar        add a colorbar to the current figure
+    cohere          make a plot of coherence
+    contour         make a contour plot
+    contourf        make a filled contour plot
+    csd             make a plot of cross spectral density
+    draw            force a redraw of the current figure
+    errorbar        make an errorbar graph
+    figlegend       add a legend to the figure
+    figimage        add an image to the figure, w/o resampling
+    figtext         add text in figure coords
+    figure          create or change active figure
+    fill            make filled polygons
     fill_between    make filled polygons
-    gca            return the current axes
-    gcf            return the current figure
-    gci            get the current image, or None
-    getp           get a handle graphics property
-    hist           make a histogram
-    hold           set the hold state on current axes
-    legend         add a legend to the axes
-    loglog         a log log plot
-    imread         load image file into array
-    imshow         plot image data
-    matshow        display a matrix in a new figure preserving aspect
-    pcolor         make a pseudocolor plot
-    plot           make a line plot
-    plotfile       plot data from a flat file
-    psd            make a plot of power spectral density
-    quiver         make a direction field (arrows) plot
-    rc             control the default params
-    savefig        save the current figure
-    scatter        make a scatter plot
-    setp           set a handle graphics property
-    semilogx       log x axis
-    semilogy       log y axis
-    show           show the figures
-    specgram       a spectrogram plot
-    stem           make a stem plot
-    subplot        make a subplot (numrows, numcols, axesnum)
-    table          add a table to the axes
-    text           add some text at location x,y to the current axes
-    title          add a title to the current axes
-    xlabel         add an xlabel to the current axes
-    ylabel         add a ylabel to the current axes
-    =========      =================================================
+    gca             return the current axes
+    gcf             return the current figure
+    gci             get the current image, or None
+    getp            get a handle graphics property
+    hist            make a histogram
+    hold            set the hold state on current axes
+    legend          add a legend to the axes
+    loglog          a log log plot
+    imread          load image file into array
+    imshow          plot image data
+    matshow         display a matrix in a new figure preserving aspect
+    pcolor          make a pseudocolor plot
+    plot            make a line plot
+    plotfile        plot data from a flat file
+    psd             make a plot of power spectral density
+    quiver          make a direction field (arrows) plot
+    rc              control the default params
+    savefig         save the current figure
+    scatter         make a scatter plot
+    setp            set a handle graphics property
+    semilogx        log x axis
+    semilogy        log y axis
+    show            show the figures
+    specgram        a spectrogram plot
+    stem            make a stem plot
+    subplot         make a subplot (numrows, numcols, axesnum)
+    table           add a table to the axes
+    text            add some text at location x,y to the current axes
+    title           add a title to the current axes
+    xlabel          add an xlabel to the current axes
+    ylabel          add a ylabel to the current axes
+    ============    =================================================
 
     The following commands will set the default colormap accordingly:
 
diff --git a/lib/matplotlib/ticker.py b/lib/matplotlib/ticker.py
@@ -213,7 +213,7 @@ class FixedFormatter(Formatter):
     'Return fixed strings for tick labels'
     def __init__(self, seq):
         """
-        seq is a sequence of strings.  For positions ``i<len(seq)` return
+        seq is a sequence of strings.  For positions `i<len(seq)` return
         *seq[i]* regardless of *x*.  Otherwise return ''
         """
         self.seq = seq
