Don't warn about .png format favicons #3715
Closed
Conversation
This file contains 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
|
Travis failed, but I don't see how the errors could be my fault... is this expected? |
tk0miya
requested changes
May 7, 2017
sphinx/builders/html.py
Outdated
| if favicon and os.path.splitext(favicon)[1] != '.ico': | ||
| logger.warning('html_favicon is not an .ico file') | ||
| if favicon and os.path.splitext(favicon)[1] not in ['.ico', '.png']: | ||
| logger.warning('html_favicon is not an .ico or .png file') |
There was a problem hiding this comment.
Now many image formats are allowed to favicon, so there are no meaning to warn about file types here.
https://en.wikipedia.org/wiki/Favicon#Browser_implementation
How about removing this block?
Support for at least .png and .gif is now essentially universal, and other formats (.jpg, .svg, etc.) are relatively widespread. This was only a warning, but it's common to run sphinx with warnings turned into errors, so it caused problems.
|
It looks like the only way to change the target from master to stable is to close this pull request and recreate it. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
It looks like every browser can now handle .png favicons:
(When looking at that page, note that iOS Safari and Opera Mini don't
support .ico favicons either.) So I don't think sphinx needs to warn
about this anymore...
This is especially annoying because I build with -nW, which is great
for catching lots of real errors but means that currently it's
actually impossible for me to use a .png favicon, even though it's
smaller, easier to work with, and supported by everything except
sphinx.