Use new "show-inheritance" feature to show base classes in Sphinx autodoc.

mdboom · mdboom · commit 1fe36c32309b · 2008-06-17T17:23:30.000Z
svn path=/trunk/matplotlib/; revision=5582
diff --git a/doc/api/artist_api.rst b/doc/api/artist_api.rst
@@ -8,24 +8,28 @@ matplotlib artists
 .. automodule:: matplotlib.artist
    :members:
    :undoc-members:
+   :show-inheritance:
 
 :mod:`matplotlib.lines`
 =============================
 
 .. automodule:: matplotlib.lines
    :members:
    :undoc-members:
+   :show-inheritance:
 
 :mod:`matplotlib.patches`
 =============================
 
 .. automodule:: matplotlib.patches
    :members:
    :undoc-members:
+   :show-inheritance:
 
 :mod:`matplotlib.text`
 =============================
 
 .. automodule:: matplotlib.text
    :members:
    :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/axes_api.rst b/doc/api/axes_api.rst
@@ -9,3 +9,4 @@ matplotlib axes
 .. automodule:: matplotlib.axes
    :members:
    :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/axis_api.rst b/doc/api/axis_api.rst
@@ -9,3 +9,4 @@ matplotlib axis
 .. automodule:: matplotlib.axis
    :members:
    :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/backend_bases_api.rst b/doc/api/backend_bases_api.rst
@@ -5,3 +5,4 @@
 .. automodule:: matplotlib.backend_bases
    :members:
    :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/backend_gtkagg_api.rst b/doc/api/backend_gtkagg_api.rst
@@ -7,4 +7,5 @@ X-session, which is not compatible with cron jobs.
 
 .. .. automodule:: matplotlib.backends.backend_gtkagg
 ..    :members:
-..    :undoc-members:
+..    :undoc-members:
+..    :show-inheritance:
diff --git a/doc/api/backend_qt4agg_api.rst b/doc/api/backend_qt4agg_api.rst
@@ -4,4 +4,6 @@
 
 .. automodule:: matplotlib.backends.backend_qt4agg
    :members:
-   :undoc-members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/doc/api/backend_wxagg_api.rst b/doc/api/backend_wxagg_api.rst
@@ -4,4 +4,5 @@
 
 .. automodule:: matplotlib.backends.backend_wxagg
    :members:
-   :undoc-members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/cbook_api.rst b/doc/api/cbook_api.rst
@@ -9,3 +9,4 @@ matplotlib cbook
 .. automodule:: matplotlib.cbook
    :members:
    :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/cm_api.rst b/doc/api/cm_api.rst
@@ -9,3 +9,4 @@ matplotlib cm
 .. automodule:: matplotlib.cm
    :members:
    :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/collections_api.rst b/doc/api/collections_api.rst
@@ -9,3 +9,4 @@ matplotlib collections
 .. automodule:: matplotlib.collections
    :members:
    :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/colorbar_api.rst b/doc/api/colorbar_api.rst
@@ -9,3 +9,4 @@ matplotlib colorbar
 .. automodule:: matplotlib.colorbar
    :members:
    :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/matplotlib_configuration_api.rst b/doc/api/matplotlib_configuration_api.rst
@@ -9,4 +9,5 @@ matplotlib configuration
 .. automodule:: matplotlib
    :members: rc, rcdefaults, use
    :undoc-members:
+   :show-inheritance:
 
diff --git a/doc/api/pyplot_api.rst b/doc/api/pyplot_api.rst
@@ -8,4 +8,5 @@ matplotlib pyplot
 
 .. automodule:: matplotlib.pyplot
    :members:
-   :undoc-members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/devel/transformations.rst b/doc/devel/transformations.rst
@@ -13,9 +13,11 @@
        composite_transform_factory, BboxTransform, BboxTransformTo,
        BboxTransformFrom, ScaledTranslation, TransformedPath, nonsingular,
        interval_contains, interval_contains_open
+   :show-inheritance:
 
 :mod:`matplotlib.path`
 =============================
 
 .. automodule:: matplotlib.path
    :members: Path, get_path_collection_extents
+   :show-inheritance:
