[Docs] Use sphinx-favicon instead of custom in-tree extension#3008
Merged
abravalheri merged 5 commits intopypa:mainfrom Jan 6, 2022
Merged
[Docs] Use sphinx-favicon instead of custom in-tree extension#3008abravalheri merged 5 commits intopypa:mainfrom
sphinx-favicon instead of custom in-tree extension#3008abravalheri merged 5 commits intopypa:mainfrom
Conversation
Unfortunately sphinx do not accept `.rst` files inside folders that are added to the `html_static_path`. (Adding `docs/images` to `html_static_path` will be required in a follow up commit to adopt the `sphinx-favicon` extension)
This change has been previously proposed and agreed upon in pypa#2869. The idea here is to avoid the burden of maintaining an in-tree sphinx extension, now that `sphinx-favicon` is available and covers setuptools use-case.
In this commit the SVG images (logo, banners, etc) were optimised with the help of https://pypi.org/project/scour/. This change has been previously requested/discussed and agreed upon on pypa#2869. The `*editable-inkscape.svg` files are preserved in the original form.
sphinx-favicon instead of custom in-tree extension
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
1 participant
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-faviconextension 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)