Taking cues from the math symbol table, this adds a directive to generate a listing from theRcParams dictionary, with types taken from the validators (partially complete), though there could perhaps be other ways to implement it. Then therc role is updated to point to these individual anchors.

We also have nowhere to put the documentation for each one yet, so the actual information is all just stubs. This would be the main obstacle to completing this change.

PR checklist

"closes #0000" is in the body of the PR description tolink the related issue
new and changed code istested
Plotting related features are demonstrated in anexample
New Features andAPI Changes are noted with adirective and release note
Documentation complies withgeneral anddocstring guidelines

PoC: Document each rcParam individually

750793c

Taking cues from the math symbol table, this adds a directive togenerate a listing from the `RcParams` dictionary, with types taken fromthe validators (partially complete), though there could perhaps be otherways to implement it. Then the `rc` role is updated to point to theseindividual anchors.We also have nowhere to put the documentation for each one yet, so theactual information is all just stubs.

github-actionsbot added topic: rcparams topic: sphinx extension Documentation: build

building the docs

Documentation: user guidefiles in galleries/users_explain or doc/users labels

Oct 3, 2024

Copy link

Member

timhoffm commentedOct 3, 2024

I believe we eventually should have a function-based/declarative approach to specifying rcParams, similar toargparse.

e.g.

config.add_param(""figure.dpi", type=float, default=100, help="figure dots per inch")

This would bind all relevant information together and make it easy to generate documentation. A minor obstacle would be to generate a reasonably formatted defaultmatplotlibrc (but we could also leave the existing matplotlibrc for now and instead just write a function that checks that it's consistent with the config.