Append a hash ?digest to CSS files for cache-busting - #1054
Merged
hugovk merged 2 commits intoFeb 23, 2023
Merged
hugovk merged 2 commits into
hugovk merged 2 commits into
Conversation
Copy link
Copy Markdown
Member
Sorry, something went wrong.
Copy link
Copy Markdown
Member
Author
Hang on, that double _static isn't right :) Will update! Edit: fixed! |
Sorry, something went wrong.
hugovk
marked this pull request as draft
February 16, 2023 21:02
hugovk
force-pushed
the
add-hash-digest-to-css
branch
from
706bc8c to
aff9360
Compare
February 16, 2023 21:03
hugovk
marked this pull request as ready for review
February 16, 2023 21:06
pradyunsg
approved these changes
Feb 16, 2023
CAM-Gerlach
approved these changes
Feb 17, 2023
CAM-Gerlach
left a comment
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
One minor comment, otherwise LGTM thanks!
Sorry, something went wrong.
Comment thread
conf.py
Outdated
…th) too Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
CAM-Gerlach
approved these changes
Feb 23, 2023
CAM-Gerlach
left a comment
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
(Still LGTM)
Sorry, something went wrong.
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
Reviewers
3 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.
Similar to python/python-docs-theme#108.
Fix the problems we saw at #1034 (comment) when the CSS file changed but browsers kept the old version cached for 24 hours.
Append a ?digest=hash to the end of the pydoctheme.css, computed from the file contents, so when a new CSS file is deployed, the old one is no longer used from the browser cache.
For example:
<link rel="stylesheet" type="text/css" href="_static/devguide_overrides.css?digest=951d6a16b747d96c03796069dbeb516764307ae2" />
This is based on how @pradyunsg's Furo theme does it:
https://github.com/pradyunsg/furo/blob/193643fdb6787501195555244f4a9e953ef544bb/src/furo/__init__.py#L149-L161
Thanks @pradyunsg!
Demo
View the source of pages at https://cpython-devguide--1054.org.readthedocs.build/.
Furo's css already has a digest, this PR adds it to devguide_overrides.css.
Check the colours load in the EOL chart at https://cpython-devguide--1054.org.readthedocs.build/versions/