Merge pull request #19977 from QuLogic/fix-doc-build

tacaswell · web-flow · commit 642c6d0db071 · 2021-04-15T22:39:21.000-04:00
Fix doc build
diff --git a/.gitignore b/.gitignore
@@ -67,9 +67,10 @@ doc/api/_as_gen
 # autogenerated by sphinx-gallery
 doc/examples
 doc/gallery
-doc/tutorials
 doc/modules
+doc/plot_types
 doc/pyplots/tex_demo.png
+doc/tutorials
 lib/dateutil
 examples/*/*.eps
 examples/*/*.pdf
diff --git a/doc/api/patches_api.rst b/doc/api/patches_api.rst
@@ -17,6 +17,7 @@ Classes
    :toctree: _as_gen/
    :template: autosummary.rst
 
+   Annulus
    Arc
    Arrow
    ArrowStyle
diff --git a/doc/users/next_whats_new/annulus.rst b/doc/users/next_whats_new/annulus.rst
@@ -1,7 +1,7 @@
 Add ``Annulus`` patch
 ---------------------
 
-A new class for drawing elliptical annuli.
+`.Annulus` is a new class for drawing elliptical annuli.
 
 .. plot::
 
@@ -14,4 +14,4 @@ A new class for drawing elliptical annuli.
                 fc='m', ec='b', alpha=0.5, hatch='xxx') 
     ax.add_patch(cir)
     ax.add_patch(ell)
-    ax.set_aspect('equal')
+    ax.set_aspect('equal')
diff --git a/lib/matplotlib/patches.py b/lib/matplotlib/patches.py
@@ -1577,24 +1577,27 @@ class Annulus(Patch):
     @docstring.dedent_interpd
     def __init__(self, xy, r, width, angle=0.0, **kwargs):
         """
+        Parameters
+        ----------
         xy : (float, float)
             xy coordinates of annulus centre.
         r : float or (float, float)
-            The radius, or semi-axes.
-                - If float: radius of the outer circle.
-                - If two floats: semi-major and -minor axes of outer ellipse.
+            The radius, or semi-axes:
+
+            - If float: radius of the outer circle.
+            - If two floats: semi-major and -minor axes of outer ellipse.
         width : float
             Width (thickness) of the annular ring. The width is measured inward
             from the outer ellipse so that for the inner ellipse the semi-axes
-            are given by `r - width`. `width` must be less than or equal to the
-            semi-minor axis.
-        angle : float, default=0
+            are given by ``r - width``. *width* must be less than or equal to
+            the semi-minor axis.
+        angle : float, default: 0
             Rotation angle in degrees (anti-clockwise from the positive
-            x-axis). Ignored for circular annuli (ie. if *r* is a scalar).
-
-        Valid kwargs are:
+            x-axis). Ignored for circular annuli (i.e., if *r* is a scalar).
+        **kwargs
+            Keyword arguments control the `Patch` properties:
 
-        %(Patch_kwdoc)s
+            %(Patch_kwdoc)s
         """
         super().__init__(**kwargs)
 
@@ -1633,8 +1636,9 @@ def get_center(self):
 
     def set_width(self, width):
         """
-        Set the width (thickness) of the annulus ring. The width is measured
-        inwards from the outer ellipse.
+        Set the width (thickness) of the annulus ring.
+
+        The width is measured inwards from the outer ellipse.
 
         Parameters
         ----------
@@ -1649,9 +1653,7 @@ def set_width(self, width):
         self.stale = True
 
     def get_width(self):
-        """
-        Return the width (thickness) of the annulus ring.
-        """
+        """Return the width (thickness) of the annulus ring."""
         return self._width
 
     width = property(get_width, set_width)
@@ -1700,12 +1702,15 @@ def set_semiminor(self, b):
 
     def set_radii(self, r):
         """
-        Set the both the semi-major (*a*) and -minor radii (*b*) of the
-        annulus.
+        Set the semi-major (*a*) and semi-minor radii (*b*) of the annulus.
 
         Parameters
         ----------
-        r : (float, float)
+        r : float or (float, float)
+            The radius, or semi-axes:
+
+            - If float: radius of the outer circle.
+            - If two floats: semi-major and -minor axes of outer ellipse.
         """
         if np.shape(r) == (2,):
             self.a, self.b = r
@@ -1718,6 +1723,7 @@ def set_radii(self, r):
         self.stale = True
 
     def get_radii(self):
+        """Return the semi-major and semi-minor radii of the annulus."""
         return self.a, self.b
 
     radii = property(get_radii, set_radii)
