Skip to content

Improve layout of cheatsheets in sidebar #29789

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.

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
merged 1 commit into from
Apr 30, 2025

Conversation

dstansby
Copy link
Member

@dstansby dstansby commented Mar 21, 2025

PR summary

This improves the layout of the cheatsheets so:

  • The image takes up the full width of the sidebar
  • The heading is aligned with the top of the RH sidebar
  • The title drops "Matplotlib" (there are already many 'Matplotlib' strings on the home page 😄) and is now just "Cheatsheets"

Note this depends on matplotlib/mpl-sphinx-theme#97 to remove existing CSS for styling the cheatsheets that was in the theme.

For a before/after comparison, see the companion PR at matplotlib/mpl-sphinx-theme#97

PR checklist

@dstansby dstansby marked this pull request as ready for review March 21, 2025 12:50
@story645
Copy link
Member

@dstansby if all the machinery is in place you're welcome to self merge, I'm just not sure if this is waiting on a release of the theme.

@dstansby dstansby force-pushed the cheatsheet-sidebar branch from 913b9c7 to 8cb05b8 Compare April 30, 2025 09:21
@dstansby
Copy link
Member Author

Even without a new release of mpl-sphinx-theme this is a minor improvement, so I don't see the harm in merging this now instead of waiting for a release of mpl-sphinx-theme.

@dstansby dstansby merged commit 07b3032 into matplotlib:main Apr 30, 2025
22 of 23 checks passed
@dstansby dstansby deleted the cheatsheet-sidebar branch April 30, 2025 09:36
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Apr 30, 2025
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Apr 30, 2025
dstansby added a commit that referenced this pull request Apr 30, 2025
…789-on-v3.10.x

Backport PR #29789 on branch v3.10.x (Improve layout of cheatsheets in sidebar)
dstansby added a commit that referenced this pull request Apr 30, 2025
…789-on-v3.10.1-doc

Backport PR #29789 on branch v3.10.1-doc (Improve layout of cheatsheets in sidebar)
@ksunden ksunden mentioned this pull request May 9, 2025
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants