Skip to content

Commit 2cd5a67

Browse files
committed
Define the supported rcParams as code
Until now, the parameter definition was dispersed: valid names and defaults are loaded from the canonical `matplotlibrc` data file. Docs are only available as comments in there. Validators are attached ad-hoc in `rcsetup.py`. This makes for a more formal definition of parameters, including meta-information, like validators, docs in a single place. It will simplify the rcParams related code in `matplotlib.__init__.py` and `matplotlib.rcsetup.py`. It also enables us to generate sphinx documentation on the parameters.
1 parent b70e324 commit 2cd5a67

File tree

3 files changed

+819
-3
lines changed

3 files changed

+819
-3
lines changed

galleries/users_explain/customizing.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,13 @@ def plotting_function():
202202
plt.show()
203203

204204
# %%
205+
#
206+
# Description of rcParams
207+
# =======================
208+
#
209+
# .. include:: /users/_rcparams_generated.rst
210+
#
211+
#
205212
# .. _customizing-with-matplotlibrc-files:
206213
#
207214
# The :file:`matplotlibrc` file

0 commit comments

Comments
 (0)