Set up html_favicon for custom favicon image in Sphinx docs #217
+6
−0
Conversation
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
jbampton
reviewed
Oct 23, 2025
Member
jbampton
left a comment
jbampton
left a comment
There was a problem hiding this comment.
Do we need a favicon.ico file ?
Author
|
Yes we do need a favicon.ico file (or another supported format like PNG) placed at _static/images/favicon.ico as configured so the custom favicon appears correctly in the documentation site. Without it the favicon won't show up in browsers. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This pull request adds a custom favicon to the 64 Shades documentation site by configuring the html_favicon option in the Sphinx conf.py file. The favicon file is specified as _static/images/favicon.ico to be incorporated into the generated HTML documentation.
#192