Fix sidebar logo not loading in HTML docs #12939
Merged
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
The mypy logo wasn't loading on https://mypy.readthedocs.io/ because it's referenced via an http:// (not https) URL. The logo's URL is http://mypy-lang.org/static/mypy_light.svg; that server is not accessible via https, so I've moved mypy_light.svg into docs/source and referenced it from there. The project README also referenced the logo via the same URL, so for consistency, the README now points at the same logo file in docs/source. (Although the README's logo did load because GitHub proxies external resources referenced in markdown files).
|
mypy's readthedocs page currently looks like this:
Edit: And after rebuilding:
|
JelleZijlstra
approved these changes
Jun 4, 2022
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
The mypy logo wasn't loading on https://mypy.readthedocs.io/ because
it's referenced via an http:// (not https) URL. The logo's URL is
http://mypy-lang.org/static/mypy_light.svg; that server is not
accessible via https, so I've moved mypy_light.svg into docs/source and
referenced it from there.
The project README also referenced the logo via the same URL, so for
consistency, the README now points at the same logo file in docs/source.
(Although the README's logo did load because GitHub proxies external
resources referenced in markdown files).
Test Plan
I've rebuilt the HTML docs after this change, and verified the HTML correctly references the logo file via a relative path. So it should load correctly on readthedocs, as the logo will be available via https from their server, alongside the HTML.