Merge pull request matplotlib#24891 from tacaswell/doc_mosaic_not_provisional

DOC: mark mosaic as no longer provisional

Author: ksunden

doc/users/next_whats_new/per_subplot_mosaic.rst

@@ -1,3 +1,11 @@
+``subplot_mosaic`` no longer provisional
+----------------------------------------
+
+The API on `.Figure.subplot_mosaic` and `.pyplot.subplot_mosaic` are now
+considered stable and will change under Matplotlib's normal deprecation
+process.
+
+
 Per-subplot keyword arguments  in ``subplot_mosaic``
 ----------------------------------------------------
 

doc/users/prev_whats_new/whats_new_3.3.0.rst

@@ -50,7 +50,7 @@ or as a string (with single-character Axes labels):
                ha='center', va='center', fontsize=36,
                color='darkgrey')
 
-See :doc:`/tutorials/provisional/mosaic` for more details and examples.
+See :doc:`/gallery/subplots_axes_and_figures/mosaic` for more details and examples.
 
 ``GridSpec.subplots()``
 -----------------------

tutorials/provisional/mosaic.py renamed to examples/subplots_axes_and_figures/mosaic.py

@@ -1,14 +1,11 @@
 """
-=======================================
-Complex and semantic figure composition
-=======================================
+.. redirect-from:: /tutorials/provisional/mosaic
 
-.. warning::
 
-   This tutorial documents experimental / provisional API.
-   We are releasing this in v3.3 to get user feedback.  We may
-   make breaking changes in future versions with no warning.
 
+========================================================
+Complex and semantic figure composition (subplot_mosaic)
+========================================================
 
 Laying out Axes in a Figure in a non-uniform grid can be both tedious
 and verbose.  For dense, even grids we have `.Figure.subplots` but for

lib/matplotlib/figure.py

@@ -1797,12 +1797,7 @@ def subplot_mosaic(self, mosaic, *, sharex=False, sharey=False,
 
         This is a helper function to build complex GridSpec layouts visually.
 
-        .. note::
-
-           This API is provisional and may be revised in the future based on
-           early user feedback.
-
-        See :doc:`/tutorials/provisional/mosaic`
+        See :doc:`/gallery/subplots_axes_and_figures/mosaic`
         for an example and full API documentation
 
         Parameters

lib/matplotlib/pyplot.py

@@ -1504,7 +1504,7 @@ def subplot_mosaic(mosaic, *, sharex=False, sharey=False,
        This API is provisional and may be revised in the future based on
        early user feedback.
 
-    See :doc:`/tutorials/provisional/mosaic`
+    See :doc:`/gallery/subplots_axes_and_figures/mosaic`
     for an example and full API documentation
 
     Parameters

tutorials/intermediate/arranging_axes.py

@@ -32,9 +32,10 @@
 
 `~matplotlib.pyplot.subplot_mosaic`
     A simple way to create figures and a grid of Axes, with the added
-    flexibility that Axes can also span rows or columns. The Axes
-    are returned in a labelled dictionary instead of an array.  See also
-    `.Figure.subplot_mosaic` and :doc:`/tutorials/provisional/mosaic`.
+    flexibility that Axes can also span rows or columns. The Axes are returned
+    in a labelled dictionary instead of an array.  See also
+    `.Figure.subplot_mosaic` and
+    :doc:`/gallery/subplots_axes_and_figures/mosaic`.
 
 Sometimes it is natural to have more than one distinct group of Axes grids,
 in which case Matplotlib has the concept of `.SubFigure`:
@@ -393,7 +394,8 @@ def squiggle_xy(a, b, c, d, i=np.arange(0.0, 2*np.pi, 0.05)):
 # More reading
 # ============
 #
-#  - More details about :doc:`subplot mosaic </tutorials/provisional/mosaic>`.
+#  - More details about :doc:`subplot mosaic
+#    </gallery/subplots_axes_and_figures/mosaic>`.
 #  - More details about :doc:`constrained layout
 #    </tutorials/intermediate/constrainedlayout_guide>`, used to align
 #    spacing in most of these examples.

tutorials/introductory/quick_start.py

@@ -566,7 +566,7 @@ def my_plotter(ax, data1, data2, param_dict):
 ###############################################################################
 # Matplotlib has quite sophisticated tools for arranging Axes: See
 # :doc:`/tutorials/intermediate/arranging_axes` and
-# :doc:`/tutorials/provisional/mosaic`.
+# :doc:`/gallery/subplots_axes_and_figures/mosaic`.
 #
 #
 # More reading