DOC: Update sphinx to include typing module (and remove aliases which moved)

Fix sphinx build ignores

Add HashableList for subplot_mosaic, change subplots return to Any

HashableList ignore missing reference for sphinx

Author: ksunden

doc/api/colors_api.rst

@@ -52,7 +52,6 @@ Other classes
 
    ColorSequenceRegistry
    LightSource
-   Color
 
 Functions
 ---------

doc/api/index.rst

@@ -153,6 +153,7 @@ Alphabetical list of modules:
    transformations.rst
    tri_api.rst
    type1font.rst
+   typing_api.rst
    units_api.rst
    widgets_api.rst
    _api_api.rst

doc/api/lines_api.rst

@@ -17,9 +17,6 @@ Classes
 
    Line2D
    VertexSelector
-   LineStyleType
-   DrawStyleType
-   MarkEveryType
 
 Functions
 ---------

doc/api/markers_api.rst

@@ -16,5 +16,3 @@ Classes
    :template: autosummary.rst
 
    MarkerStyle
-   MarkerType
-   FillStyleType

doc/api/typing_api.rst

@@ -0,0 +1,11 @@
+*********************
+``matplotlib.typing``
+*********************
+
+.. autodata:: matplotlib.typing.ColorType
+.. autodata:: matplotlib.typing.ColourType
+.. autodata:: matplotlib.typing.LineStyleType
+.. autodata:: matplotlib.typing.DrawStyleType
+.. autodata:: matplotlib.typing.MarkEveryType
+.. autodata:: matplotlib.typing.FillStyleType
+.. autodata:: matplotlib.typing.RcStyleType

doc/missing-references.json

@@ -146,7 +146,7 @@
       "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.twinx:1",
       "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.twiny:1"
     ],
-    "Color": [
+    "ColorType": [
       "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.errorbar:1",
       "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.eventplot:1",
       "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.hist:1",
@@ -155,6 +155,9 @@
       "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.scatter:1",
       "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.vlines:1"
     ],
+    "HashableList": [
+      "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot_mosaic:1"
+    ],
     "LineStyleType": [
       "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.eventplot:1",
       "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.hlines:1",

lib/matplotlib/figure.pyi

@@ -41,7 +41,7 @@ from numpy.typing import ArrayLike
 
 from collections.abc import Callable, Iterable
 from typing import Any, Literal, overload
-from .typing import ColorType
+from .typing import ColorType, HashableList
 
 class SubplotParams:
     def __init__(
@@ -237,7 +237,7 @@ class FigureBase(Artist):
     # Any in list of list is recursive list[list[Hashable | list[Hashable | ...]]] but that can't really be type checked
     def subplot_mosaic(
         self,
-        mosaic: str | list[list[Any]],
+        mosaic: str | HashableList,
         *,
         sharex: bool = ...,
         sharey: bool = ...,

lib/matplotlib/pyplot.py

@@ -123,7 +123,7 @@
     from matplotlib.quiver import Barbs, Quiver, QuiverKey
     from matplotlib.scale import ScaleBase
     from matplotlib.transforms import Transform, Bbox
-    from matplotlib.typing import ColorType, LineStyleType, MarkerType
+    from matplotlib.typing import ColorType, LineStyleType, MarkerType, HashableList
     from matplotlib.widgets import SubplotTool
 
 # We may not need the following imports here:
@@ -1415,7 +1415,7 @@ def subplots(
     subplot_kw: dict[str, Any] | None = None,
     gridspec_kw: dict[str, Any] | None = None,
     **fig_kw
-) -> tuple[Figure, Axes | np.ndarray | SubplotBase]:
+) -> tuple[Figure, Any]:
     """
     Create a figure and a set of subplots.
 
@@ -1568,7 +1568,7 @@ def subplots(
 
 
 def subplot_mosaic(
-    mosaic: str | list[list[Any]],
+    mosaic: str | HashableList,
     *,
     sharex: bool = False,
     sharey: bool = False,

lib/matplotlib/typing.py

@@ -4,14 +4,14 @@
 This module contains Type aliases which are useful for Matplotlib and potentially
 downstream libraries.
 
-.. admonition::
+.. admonition:: Provisional status of typing
 
-    The ``typing`` module is considered provisional and may change at any time without
-    a deprecation period.
+    The ``typing`` module and type stub files are considered provisional and may change
+    at any time without a deprecation period.
 """
 from collections.abc import Sequence
 import pathlib
-from typing import Any, Literal, Union
+from typing import Any, Hashable, Literal, Union
 
 from . import path
 from .markers import MarkerStyle
@@ -41,3 +41,5 @@
 RcStyleType = Union[
     str, dict[str, Any], pathlib.Path, list[Union[str, pathlib.Path, dict[str, Any]]]
 ]
+
+HashableList = list[Union[Hashable, "HashableList"]]