Skip to content

Commit f744ca0

Browse files
committed
Restore matplotlib.__doc__ in Sphinx docs
Since we already have an explicit listing of module members, that needs to be turned off here. Also, don't add it to the index as we already have `matplotlib` pointing to the top level page (though maybe that should change?) Fixes matplotlib#17973
1 parent c936ef5 commit f744ca0

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

doc/api/matplotlib_configuration_api.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44

55
.. py:currentmodule:: matplotlib
66
7+
.. automodule:: matplotlib
8+
:no-members:
9+
:no-undoc-members:
10+
:noindex:
11+
712
Backend management
813
==================
914

lib/matplotlib/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363
:mod:`matplotlib.ticker`
6464
Calculation of tick mark locations and formatting of tick labels.
6565
66-
:mod:`matplotlib.backends`
66+
:doc:`matplotlib.backends </api/index_backend_api>`
6767
A subpackage with modules for various GUI libraries and output formats.
6868
6969
The base matplotlib namespace includes:
@@ -81,7 +81,7 @@
8181
developed and maintained by a host of others.
8282
8383
Occasionally the internal documentation (python docstrings) will refer
84-
to MATLAB&reg;, a registered trademark of The MathWorks, Inc.
84+
to MATLAB®, a registered trademark of The MathWorks, Inc.
8585
8686
"""
8787

0 commit comments

Comments
 (0)