Skip to content

DOC: remove rcparams listing from user guide #32025

Open
story645 wants to merge 2 commits into
matplotlib:mainfrom
story645:rcindex
Open

DOC: remove rcparams listing from user guide #32025
story645 wants to merge 2 commits into
matplotlib:mainfrom
story645:rcindex

Conversation

@story645

@story645 story645 commented Jul 9, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

PR summary

This pr moves the rcParams listing on https://matplotlib.org/devdocs/users/index.html into a dropdown b/c currently I think it swamps the page but I wanted to keep the ease of browsing through the listings. This is the change:

image

going back and forth if I wanna change the dropdown header color to the background color or keep it to flag it's a dropdown.

AI Disclosure

nopes

PR checklist

@github-actions github-actions Bot added the Documentation: user guide files in galleries/users_explain or doc/users label Jul 9, 2026
@timhoffm

timhoffm commented Jul 9, 2026

Copy link
Copy Markdown
Member

Id rather remove the subsections here (toctree depth 1). Opening the dropdown and clicking on a subsection title is two clicks. Just like clicking the section title and selecting the subsection from the „on this page“ menu on the right of the page.

A dropdown is thus not faster to navigate but it adds visual clutter.

@story645

story645 commented Jul 9, 2026

Copy link
Copy Markdown
Member Author

dropdown is thus not faster to navigate but it adds visual clutter

Was more so folks can skim the params w/o having to go to the new page.

@story645

story645 commented Jul 10, 2026

Copy link
Copy Markdown
Member Author

also very much dislike this mixed font size:
image

@timhoffm

timhoffm commented Jul 10, 2026

Copy link
Copy Markdown
Member

dropdown is thus not faster to navigate but it adds visual clutter

Was more so folks can skim the params w/o having to go to the new page.

The page is primarily for overview of the topics and navigation. IHMO Which groups of rcParams exist falls in neither category as it's rather a content detail of rcParams.

Something strange is happening with Sphinx here. The 2-toc version seems to ignore the first toc

/home/circleci/project/doc/users/explain/configuration.rst: WARNING: document isn't included in any toctree [toc.not_included]

and it does not show up in rendering
image

@story645

story645 commented Jul 10, 2026

Copy link
Copy Markdown
Member Author

fixed and now font sizes look reasonable:
image

timhoffm
timhoffm approved these changes Jul 10, 2026
View reviewed changes

@timhoffm timhoffm left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good now AFAICS.

@story645 story645 changed the title DOC: stash rcparams listing in a dropdown DOC: remove rcparams listing from user guide Jul 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@timhoffm timhoffm timhoffm approved these changes

Assignees

No one assigned

Labels

Documentation: user guide files in galleries/users_explain or doc/users

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@story645 @timhoffm