Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit ae6db3c

Browse filesBrowse files
authored
Merge pull request #23682 from timhoffm/doc-deprecated-modules
Fix generated documentation for deprecated modules
2 parents ba7b86f + 9e76fef commit ae6db3c
Copy full SHA for ae6db3c

File tree

Expand file treeCollapse file tree

7 files changed

+32
-7
lines changed
Filter options
Expand file treeCollapse file tree

7 files changed

+32
-7
lines changed

‎doc/api/afm_api.rst

Copy file name to clipboardExpand all lines: doc/api/afm_api.rst
+6-1Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,12 @@
22
``matplotlib.afm``
33
******************
44

5-
.. automodule:: matplotlib.afm
5+
.. attention::
6+
This module is considered internal.
7+
8+
Its use is deprecated and it will be removed in a future version.
9+
10+
.. automodule:: matplotlib._afm
611
:members:
712
:undoc-members:
813
:show-inheritance:

‎doc/api/docstring_api.rst

Copy file name to clipboardExpand all lines: doc/api/docstring_api.rst
+6-1Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,12 @@
22
``matplotlib.docstring``
33
************************
44

5-
.. automodule:: matplotlib.docstring
5+
.. attention::
6+
This module is considered internal.
7+
8+
Its use is deprecated and it will be removed in a future version.
9+
10+
.. automodule:: matplotlib._docstring
611
:members:
712
:undoc-members:
813
:show-inheritance:

‎doc/api/prev_api_changes/api_changes_0.91.0.rst

Copy file name to clipboardExpand all lines: doc/api/prev_api_changes/api_changes_0.91.0.rst
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Changes for 0.91.0
2525
* The :mod:`matplotlib.dviread` file now has a parser for files like
2626
psfonts.map and pdftex.map, to map TeX font names to external files.
2727

28-
* The file :mod:`matplotlib.type1font` contains a new class for Type 1
28+
* The file ``matplotlib.type1font`` contains a new class for Type 1
2929
fonts. Currently it simply reads pfa and pfb format files and
3030
stores the data in a way that is suitable for embedding in pdf
3131
files. In the future the class might actually parse the font to

‎doc/api/tight_bbox_api.rst

Copy file name to clipboardExpand all lines: doc/api/tight_bbox_api.rst
+6-1Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,12 @@
22
``matplotlib.tight_bbox``
33
*************************
44

5-
.. automodule:: matplotlib.tight_bbox
5+
.. attention::
6+
This module is considered internal.
7+
8+
Its use is deprecated and it will be removed in a future version.
9+
10+
.. automodule:: matplotlib._tight_bbox
611
:members:
712
:undoc-members:
813
:show-inheritance:

‎doc/api/tight_layout_api.rst

Copy file name to clipboardExpand all lines: doc/api/tight_layout_api.rst
+6-1Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,12 @@
22
``matplotlib.tight_layout``
33
***************************
44

5-
.. automodule:: matplotlib.tight_layout
5+
.. attention::
6+
This module is considered internal.
7+
8+
Its use is deprecated and it will be removed in a future version.
9+
10+
.. automodule:: matplotlib._tight_layout
611
:members:
712
:undoc-members:
813
:show-inheritance:

‎doc/api/type1font.rst

Copy file name to clipboardExpand all lines: doc/api/type1font.rst
+6-1Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,12 @@
22
``matplotlib.type1font``
33
************************
44

5-
.. automodule:: matplotlib.type1font
5+
.. attention::
6+
This module is considered internal.
7+
8+
Its use is deprecated and it will be removed in a future version.
9+
10+
.. automodule:: matplotlib._type1font
611
:members:
712
:undoc-members:
813
:show-inheritance:

‎doc/users/prev_whats_new/whats_new_1.1.rst

Copy file name to clipboardExpand all lines: doc/users/prev_whats_new/whats_new_1.1.rst
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Tight Layout
5151
A frequent issue raised by users of matplotlib is the lack of a layout
5252
engine to nicely space out elements of the plots. While matplotlib still
5353
adheres to the philosophy of giving users complete control over the placement
54-
of plot elements, Jae-Joon Lee created the :mod:`~matplotlib.tight_layout`
54+
of plot elements, Jae-Joon Lee created the ``matplotlib.tight_layout``
5555
module and introduced a new
5656
command :func:`~matplotlib.pyplot.tight_layout`
5757
to address the most common layout issues.

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.