Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Add Python favicon #992

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 2 commits into from
Nov 28, 2022
Merged

Add Python favicon #992

merged 2 commits into from
Nov 28, 2022

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Nov 26, 2022

Use the Python logo as favicon instead of the default Read the Docs one.

Sphinx docs for html_favicon:

Preview

https://cpython-devguide--992.org.readthedocs.build/

Before and after, in Chrome, Firefox and Safari on macOS:

image

Copy link
Member

@Mariatta Mariatta left a comment

Choose a reason for hiding this comment

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

Seems to work on the preview.

@CAM-Gerlach
Copy link
Member

If we can only go with a single favicon (which rules out SVG thanks to Safari being backwards as usual), PNG support is essentially universal, so I recommend a 192 px PNG.

@hugovk
Copy link
Member Author

hugovk commented Nov 27, 2022

Updated to 192px PNG!

Sphinx says "It should be a Windows-style icon file (.ico), which is 16x16 or 32x32 pixels large" but it doesn't seem to matter.

Also "The image file will be copied to the _static directory of the output HTML, but only if the file does not already exist there", so let's put it there already. Keeps the root tidier too.


If we wanted to cover a lot of the possible options (to see them, go to https://realfavicongenerator.net/ and "Demo with a random image"), we could look at https://pypi.org/project/sphinx-favicon/

@CAM-Gerlach
Copy link
Member

If we wanted to cover a lot of the possible options (to see them, go to https://realfavicongenerator.net/ and "Demo with a random image"), we could look at https://pypi.org/project/sphinx-favicon/

Yeah, I thought about that, I just figured it wasn't worth it for now just for the devguide

Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @hugovk !

@AlexWaygood AlexWaygood merged commit 7dcba58 into python:main Nov 28, 2022
@hugovk hugovk deleted the favicon branch November 28, 2022 09:12
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.

5 participants
Morty Proxy This is a proxified and sanitized view of the page, visit original site.