Skip to content

DOC: Improve linkage between rcParams-related documentation #30948

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
timhoffm merged 2 commits into from
Jan 10, 2026
+25 −16
Merged

DOC: Improve linkage between rcParams-related documentation #30948

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9ce96aa
DOC: Improve linkage between rcParams-related documentation
timhoffm Jan 9, 2026
99c2135
Update matplotlib_configuration_api.rst
timhoffm Jan 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion doc/api/matplotlib_configuration_api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,24 @@ Default values and styling
==========================

.. py:data:: rcParams
:type: RcParams

The global configuration settings for Matplotlib.

This is a dictionary-like variable that stores the current configuration
settings. Many of the values control styling, but others control
various aspects of Matplotlib's behavior.

See :doc:`/users/explain/configuration` for a full list of config
parameters.

See :ref:`customizing` for usage information.

Notes
-----
This object is also available as ``plt.rcParams`` via the
`matplotlib.pyplot` module (which by convention is imported as ``plt``).

An instance of `RcParams` for handling default Matplotlib values.

.. autoclass:: RcParams
:no-members:
Expand Down
7 changes: 5 additions & 2 deletions galleries/users_explain/customizing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,12 @@
Customizing Matplotlib with style sheets and rcParams
=====================================================

Tips for customizing the properties and default styles of Matplotlib.
Many aspects of Matplotlib's behavior and default styles can be customized
through the use of rc (runtime configuration) settings. The current values
are stored in `~matplotlib.rcParams`.

There are three ways to customize Matplotlib:
There are three ways to customize Matplotlib, all of which effectively change
`~matplotlib.rcParams`:

1. :ref:`Setting rcParams at runtime<customizing-with-dynamic-rc-settings>`.
2. :ref:`Using style sheets<customizing-with-style-sheets>`.
Expand Down
16 changes: 3 additions & 13 deletions lib/matplotlib/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@

# cbook must import matplotlib only within function
# definitions, so it is safe to import from it here.
from . import _api, _version, cbook, _docstring, rcsetup
from . import _api, _version, cbook, rcsetup
from matplotlib._api import MatplotlibDeprecationWarning
from matplotlib.colors import _color_sequences as color_sequences
from matplotlib.rcsetup import cycler # noqa: F401
Expand Down Expand Up @@ -658,23 +658,13 @@ def gen_candidates():
"install is broken")


@_docstring.Substitution(
"\n".join(map("- {}".format, sorted(rcsetup._validators, key=str.lower)))
)
class RcParams(MutableMapping, dict):
"""
A dict-like key-value store for config parameters, including validation.

Validating functions are defined and associated with rc parameters in
:mod:`matplotlib.rcsetup`.
This is the data structure behind `matplotlib.rcParams`.

The list of rcParams is:

%s

See Also
--------
:ref:`customizing-with-matplotlibrc-files`
The complete list of rcParams can be found in :doc:`/users/explain/configuration`.
"""

validate = rcsetup._validators
Expand Down
Loading