GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Append a hash ?digest to CSS files for cache-busting by hugovk · Pull Request #1054 · python/devguide

Conversation

@hugovk

@hugovk hugovk commented Feb 16, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

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/

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@hugovk

hugovk commented Feb 16, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member Author

<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!

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@hugovk
hugovk marked this pull request as draft February 16, 2023 21:02
@hugovk
Append a hash ?digest to CSS files for cache-busting
aff9360
@hugovk
hugovk force-pushed the add-hash-digest-to-css branch from 706bc8c to aff9360 Compare February 16, 2023 21:03
@hugovk
hugovk marked this pull request as ready for review February 16, 2023 21:06
pradyunsg
pradyunsg approved these changes Feb 16, 2023
View reviewed changes
CAM-Gerlach
CAM-Gerlach approved these changes Feb 17, 2023
View reviewed changes

@CAM-Gerlach CAM-Gerlach left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this 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!

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Comment thread conf.py Resolved

Uh oh!

There was an error while loading. Please reload this page.

@hugovk @CAM-Gerlach
os.PathLike[str] works with any str path-like object (e.g. pathlib.Pa…
eea9d02
…th) too

Co-authored-by: C.A.M. Gerlach <[email protected]>
CAM-Gerlach
CAM-Gerlach approved these changes Feb 23, 2023
View reviewed changes

@CAM-Gerlach CAM-Gerlach left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

(Still LGTM)

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

hugovk reacted with rocket emoji
All reactions
  • 🚀 1 reaction
@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

Reviewers

@pradyunsg pradyunsg pradyunsg approved these changes
@CAM-Gerlach CAM-Gerlach CAM-Gerlach approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@hugovk @pradyunsg @CAM-Gerlach
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.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.