Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Append a hash ?digest to CSS files for cache-busting #1054

Merged
merged 2 commits into from
Feb 23, 2023

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Feb 16, 2023

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/

@hugovk
Copy link
Member Author

hugovk commented Feb 16, 2023

<link rel="stylesheet" type="text/css" href="_static/_static/devguide_overrides.css?digest=951d6a16b747d96c03796069dbeb516764307ae2" />

Hang on, that double _static isn't right :) Will update!

Edit: fixed!

@hugovk hugovk marked this pull request as draft February 16, 2023 21:02
@hugovk hugovk marked this pull request as ready for review February 16, 2023 21:06
Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One minor comment, otherwise LGTM thanks!

conf.py Outdated Show resolved Hide resolved
…th) too

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Still LGTM)

@hugovk hugovk merged commit f04b23c into python:main Feb 23, 2023
@hugovk hugovk deleted the add-hash-digest-to-css branch February 23, 2023 07:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants