Repository navigation
docs: Replace the social preview image and the sidebar logo - #250
Merged
Merged
Conversation
The new designs are made outside the book build, so they are committed as images instead of being drawn by matplotlib at build time. Only the front page's banner is still drawn from the demos, so the script is renamed to banner.py. The logo already shows the title, so the theme's title text above it is turned off with logo_only. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What this changes
social_preview.png, 1280x640) and the logo at the top left of the web book's sidebar (logo.png, 540x220) with new designsdoc/_extra/instead of being drawn by matplotlib at build time..gitignorenow ignores onlybanner.png, which is still drawn from the demosdoc/social_preview.pyonly draws the front page's banner now, so it is renamed todoc/banner.pyand the functions that drew the preview and the logo are removedlogo_only: Truein the theme options, since the new logo already shows the title and the theme would repeat it as text above the logoThe published URL of the preview image (
/social_preview.png, used byog:image) is unchanged. The repository's social preview in Settings has already been updated to the same image.How I checked it works
sphinx-build -W --keep-going -b html doc doc/_build/htmlbuilds without warningssocial_preview.pngand_static/logo.pngare byte-identical to the new images, andog:imagestill points to/social_preview.png#2980B9), the title is no longer shown twice, and the mobile layout is unchanged🤖 Generated with Claude Code