Skip to content

DOC: Generate rcParams docs directly during build #31028

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
story645 merged 1 commit into from
Feb 2, 2026
Merged

DOC: Generate rcParams docs directly during build #31028

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,9 @@ def _parse_skip_subdirs_file():
'sphinxext.math_symbol_table',
'sphinxext.missing_references',
'sphinxext.mock_gui_toolkits',
'sphinxext.skip_deprecated',
'sphinxext.rcparams',
'sphinxext.redirect_from',
'sphinxext.skip_deprecated',
'sphinx_copybutton',
'sphinx_design',
'sphinx_tags',
Expand Down
39 changes: 39 additions & 0 deletions doc/sphinxext/rcparams.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
from docutils.parsers.rst import Directive

from matplotlib import rcsetup


class RcParamsDirective(Directive):
has_content = False
required_arguments = 0
optional_arguments = 0
final_argument_whitespace = False
option_spec = {}

def run(self):
"""
Generate rst documentation for rcParams.

Note: The style is very simple, but will be refined later.
"""
self.state.document.settings.env.note_dependency(__file__)
self.state.document.settings.env.note_dependency(rcsetup.__file__)
lines = []
for param in rcsetup._params:
if param.name[0] == '_':
continue
lines += [
f'.. _rcparam_{param.name.replace(".", "_")}:',
'',
f'{param.name}: ``{param.default!r}``',
f' {param.description if param.description else "*no description*"}'
]
self.state_machine.insert_input(lines, 'rcParams table')
return []


def setup(app):
app.add_directive("rcparams", RcParamsDirective)

metadata = {'parallel_read_safe': True, 'parallel_write_safe': True}
return metadata
Loading
Loading