DOC: Generate rcParams docs directly during build #31028
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
topic: rcparams
Documentation: build
timhoffm
reviewed
Jan 24, 2026
doc/sphinxext/rcparams.py
Outdated
| self.state.document.settings.env.note_dependency(__file__) | ||
| self.state.document.settings.env.note_dependency(rcsetup.__file__) | ||
| lines = [] | ||
| for param in sorted(rcsetup._params): |
Member
There was a problem hiding this comment.
I believe sorting goes into the wrong direction. I've created the parameters with the same order as in matplotlibrc. This has some implicit logical grouping and should be "ordered enough" for a start. The plan is to make the grouping more explicit and also be able to add group information, like matplotlibrc does informally already.
I still have to figure out how to best define the groups on a technical level. That's why I've started with a plain list.
Member
Author
There was a problem hiding this comment.
Sure, if you have a better layout in mind, we can go with that.
QuLogic
force-pushed
the
doc-auto-rcparams
branch
from
5fe6925 to
fd6d8fd
Compare
Using the extension from matplotlib#28930, drop the static generated rcParams file, and move to a directive that gets generated on build. This avoids the table getting out of date as rcParams are changed. Note, that this also hides the private (`_`-prefixed) rcParams.
QuLogic
force-pushed
the
doc-auto-rcparams
branch
from
fd6d8fd to
125c4f0
Compare
timhoffm
approved these changes
Feb 2, 2026
story645
approved these changes
Feb 2, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR summary
Using the extension from #28930 (and data from #30871), drop the static generated rcParams file, and move to a directive that gets generated on build. This avoids the table getting out of date as rcParams are changed (which I've already accidentally forgotten about on the
text-overhaulbranch.)Note, that this also
sorts the rcParams andhides the private (_-prefixed) ones.PR checklist