Fix generated documentation for deprecated modules

timhoffm · timhoffm · commit 9e76fef18190 · 2022-08-19T23:08:08.000+02:00
Closes #23679.
diff --git a/doc/api/afm_api.rst b/doc/api/afm_api.rst
@@ -2,7 +2,12 @@
 ``matplotlib.afm``
 ******************
 
-.. automodule:: matplotlib.afm
+.. attention::
+    This module is considered internal.
+
+    Its use is deprecated and it will be removed in a future version.
+
+.. automodule:: matplotlib._afm
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/doc/api/docstring_api.rst b/doc/api/docstring_api.rst
@@ -2,7 +2,12 @@
 ``matplotlib.docstring``
 ************************
 
-.. automodule:: matplotlib.docstring
+.. attention::
+    This module is considered internal.
+
+    Its use is deprecated and it will be removed in a future version.
+
+.. automodule:: matplotlib._docstring
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/doc/api/prev_api_changes/api_changes_0.91.0.rst b/doc/api/prev_api_changes/api_changes_0.91.0.rst
@@ -25,7 +25,7 @@ Changes for 0.91.0
 * The :mod:`matplotlib.dviread` file now has a parser for files like
   psfonts.map and pdftex.map, to map TeX font names to external files.
 
-* The file :mod:`matplotlib.type1font` contains a new class for Type 1
+* The file ``matplotlib.type1font`` contains a new class for Type 1
   fonts.  Currently it simply reads pfa and pfb format files and
   stores the data in a way that is suitable for embedding in pdf
   files. In the future the class might actually parse the font to
diff --git a/doc/api/tight_bbox_api.rst b/doc/api/tight_bbox_api.rst
@@ -2,7 +2,12 @@
 ``matplotlib.tight_bbox``
 *************************
 
-.. automodule:: matplotlib.tight_bbox
+.. attention::
+    This module is considered internal.
+
+    Its use is deprecated and it will be removed in a future version.
+
+.. automodule:: matplotlib._tight_bbox
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/doc/api/tight_layout_api.rst b/doc/api/tight_layout_api.rst
@@ -2,7 +2,12 @@
 ``matplotlib.tight_layout``
 ***************************
 
-.. automodule:: matplotlib.tight_layout
+.. attention::
+    This module is considered internal.
+
+    Its use is deprecated and it will be removed in a future version.
+
+.. automodule:: matplotlib._tight_layout
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/doc/api/type1font.rst b/doc/api/type1font.rst
@@ -2,7 +2,12 @@
 ``matplotlib.type1font``
 ************************
 
-.. automodule:: matplotlib.type1font
+.. attention::
+    This module is considered internal.
+
+    Its use is deprecated and it will be removed in a future version.
+
+.. automodule:: matplotlib._type1font
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/doc/users/prev_whats_new/whats_new_1.1.rst b/doc/users/prev_whats_new/whats_new_1.1.rst
@@ -51,7 +51,7 @@ Tight Layout
 A frequent issue raised by users of matplotlib is the lack of a layout
 engine to nicely space out elements of the plots. While matplotlib still
 adheres to the philosophy of giving users complete control over the placement
-of plot elements, Jae-Joon Lee created the :mod:`~matplotlib.tight_layout`
+of plot elements, Jae-Joon Lee created the ``matplotlib.tight_layout``
 module and introduced a new
 command :func:`~matplotlib.pyplot.tight_layout`
 to address the most common layout issues.
