Merge pull request matplotlib#17638 from matplotlib/v3.2.1-doc

V3.2.1 doc

Author: QuLogic

doc/_static/mpl.css

@@ -926,6 +926,30 @@ figcaption {
 #unreleased-message a {
   color: #fff;
   text-decoration:underline;
+
+}
+
+/* top-banner style message. */
+#annc-banner {
+  box-sizing: border-box;
+  left: 0;
+  min-height: 3em;
+  padding: 0.7em;
+  top: 0;
+  width: 100%;
+  z-index: 10000;
+  background-image: linear-gradient(90deg, #440154, #482475, #414487, #355f8d, #2a788e, #21908d, #22a884, #42be71, #7ad151, #bddf26, #bddf26);
+  padding: 5px
+}
+
+#annc-banner a {
+    font-weight: bold;
+}
+
+#annc-banner p{
+    background-color: rgba(255, 255, 255, .8);
+    padding: 13px;
+    margin:0;
 }
 
 /* Fork me on GitHub "button" */
@@ -1079,10 +1103,6 @@ p.caption {
     font-weight: bold;
 }
 
-div#gallery.section, div#tutorials.section {
-    overflow: hidden;
-}
-
 .sphx-glr-multi-img{
     max-width: 99% !important;
 }
@@ -1254,3 +1274,7 @@ div.bullet-box li {
         flex: 0 0 90%;
     }
 }
+
+div#gallery.section .sphx-glr-clear:first-of-type, div#tutorials.section .sphx-glr-clear:first-of-type{
+    display: none;
+}

doc/_templates/layout.html

@@ -5,6 +5,7 @@
         <li><a href="{{ pathto('contents') }}">contents</a> &raquo;</li>
 {%- endblock %}
 
+
 {%- block relbar1 %}{{ relbar() }}{% endblock %}
 {%- block relbar2 %}{% endblock %}
 
@@ -27,7 +28,15 @@
         Try searching for the released version of this page instead?
     </a>
 </div>
+
 {%- endif %}
+
+<!--
+<div id="annc-banner">
+
+</div>
+-->
+
 <div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
     {%- if builder in ('htmlhelp', 'devhelp', 'latex') %}
     <a href="{{ pathto('index') }}">

doc/conf.py

@@ -29,6 +29,10 @@
 # General configuration
 # ---------------------
 
+# Strip backslahes in function's signature
+# To be removed when numpydoc > 0.9.x
+strip_signature_backslash = True
+
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [

doc/faq/howto_faq.rst

@@ -21,20 +21,12 @@ Plot `numpy.datetime64` values
 As of Matplotlib 2.2, `numpy.datetime64` objects are handled the same way
 as `datetime.datetime` objects.
 
-If you prefer the pandas converters and locators, you can register their
-converter with the `matplotlib.units` module::
-
-  from pandas.tseries import converter as pdtc
-  pdtc.register()
-
-If you only want to use the `pandas` converter for `numpy.datetime64` values ::
-
-  from pandas.tseries import converter as pdtc
-  import matplotlib.units as munits
-  import numpy as np
-
-  munits.registry[np.datetime64] = pdtc.DatetimeConverter()
+If you prefer the pandas converters and locators, you can register them.  This
+is done automatically when calling a pandas plot function and may be
+unnecessary when using pandas instead of Matplotlib directly. ::
 
+  from pandas.plotting import register_matplotlib_converters
+  register_matplotlib_converters()
 
 
 .. _howto-figure-empty:

examples/pyplots/auto_subplots_adjust.py

@@ -28,14 +28,12 @@ def on_draw(event):
         # want the inverse of that
         bboxi = bbox.inverse_transformed(fig.transFigure)
         bboxes.append(bboxi)
-
-        # this is the bbox that bounds all the bboxes, again in relative
-        # figure coords
-        bbox = mtransforms.Bbox.union(bboxes)
-        if fig.subplotpars.left < bbox.width:
-            # we need to move it over
-            fig.subplots_adjust(left=1.1*bbox.width)  # pad a little
-            fig.canvas.draw()
+    # the bbox that bounds all the bboxes, again in relative figure coords
+    bbox = mtransforms.Bbox.union(bboxes)
+    if fig.subplotpars.left < bbox.width:
+        # we need to move it over
+        fig.subplots_adjust(left=1.1*bbox.width)  # pad a little
+        fig.canvas.draw()
 
 fig.canvas.mpl_connect('draw_event', on_draw)
 

lib/matplotlib/colorbar.py

@@ -405,7 +405,7 @@ class ColorbarBase(_ColorbarMappableDummy):
 
     ticklocation : {'auto', 'left', 'right', 'top', 'bottom'}
 
-    extend : {'neiter', 'both', 'min', 'max'}
+    extend : {'neither', 'both', 'min', 'max'}
 
     spacing : {'uniform', 'proportional'}
 

lib/matplotlib/pyplot.py

@@ -1500,7 +1500,7 @@ def yticks(ticks=None, labels=None, **kwargs):
     Parameters
     ----------
     ticks : array-like, optional
-        The list of xtick locations.  Passing an empty list removes all xticks.
+        The list of ytick locations.  Passing an empty list removes all yticks.
     labels : array-like, optional
         The labels to place at the given *ticks* locations.  This argument can
         only be passed if *ticks* is passed as well.

requirements/doc/doc-requirements.txt

@@ -13,5 +13,5 @@ ipython
 ipywidgets
 numpydoc>=0.8
 pillow>=3.4,!=5.4.0
-sphinx-gallery>=0.2
+sphinx-gallery>=0.5
 sphinx-copybutton