Merge pull request #11454 from fredrik-1/doc_rendering_subplots

jklymak · web-flow · commit 2b51fa36d8ac · 2018-06-21T08:49:08.000-07:00
add subplots to axes documentation
diff --git a/doc/api/axes_api.rst b/doc/api/axes_api.rst
@@ -1,18 +1,30 @@
-================
- ``Axes`` class
-================
+====
+axes
+====
+
 .. currentmodule:: matplotlib.axes
 
 .. autoclass:: Axes
    :no-members:
    :no-undoc-members:
+   :show-inheritance:
 
 .. contents:: Table of Contents
    :depth: 2
    :local:
    :backlinks: entry
    :class: multicol-toc
 
+Subplots
+========
+
+.. autosummary::
+   :toctree: _as_gen
+   :template: autosummary.rst
+   :nosignatures:
+
+   SubplotBase
+   subplot_class_factory
 
 Plotting
 ========
diff --git a/doc/api/figure_api.rst b/doc/api/figure_api.rst
@@ -18,6 +18,7 @@ Classes
 .. autosummary::
    :toctree: _as_gen/
    :template: autosummary.rst
+   :nosignatures:
 
    AxesStack
    Figure
@@ -29,6 +30,6 @@ Functions
 .. autosummary::
    :toctree: _as_gen/
    :template: autosummary.rst
+   :nosignatures:
 
    figaspect
-   
diff --git a/lib/matplotlib/axes/_subplots.py b/lib/matplotlib/axes/_subplots.py
@@ -187,11 +187,13 @@ def _make_twin_axes(self, *kl, **kwargs):
 
 @functools.lru_cache(None)
 def subplot_class_factory(axes_class=None):
-    # This makes a new class that inherits from SubplotBase and the
-    # given axes_class (which is assumed to be a subclass of Axes).
-    # This is perhaps a little bit roundabout to make a new class on
-    # the fly like this, but it means that a new Subplot class does
-    # not have to be created for every type of Axes.
+    """
+    This makes a new class that inherits from `.SubplotBase` and the
+    given axes_class (which is assumed to be a subclass of `.axes.Axes`).
+    This is perhaps a little bit roundabout to make a new class on
+    the fly like this, but it means that a new Subplot class does
+    not have to be created for every type of Axes.
+    """
     if axes_class is None:
         axes_class = Axes
     return type("%sSubplot" % axes_class.__name__,
