[Docs] Use sphinx-favicon
instead of custom in-tree extension
#3008
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.
Summary of changes
The changes introduced here were mostly requested/agreed upon on #2869.
At that time, the
sphinx-favicon
extension was not ready yet. But now it can be used to avoid the burden of maintaining a custom in-tree extension.When it comes to SVG optimisation, I have used https://pypi.org/project/scour/, which is a (easy to install) pure-Python utility tool directly on the files stored in the repository (except the ones intended to be edited, e.g.
docs/images/*editable-inkscape.svg
).The approach of dynamically running the SVG optimiser when the docs are build was discarded for the time being, since RTD has its own tooling that does not call
tox -e docs
(this means that any SVG optimisation should be implemented as a sphinx extension, and I could not find any currently available). This might change in the future if such extension is created/discovered.Pull Request Checklist
changelog.d/
.(See documentation for details)