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

hugovk · CAM-Gerlach · web-flow · commit f04b23c019f3 · 2023-02-23T09:25:18.000+02:00
Co-authored-by: C.A.M. Gerlach &lt;CAM.Gerlach@Gerlach.CAM&gt;
diff --git a/conf.py b/conf.py
@@ -1,6 +1,8 @@
+import hashlib
 import os
 import sys
 import time
+from pathlib import Path
 
 # Location of custom extensions.
 sys.path.insert(0, os.path.abspath(".") + "/_extensions")
@@ -32,14 +34,22 @@
     '.github',
 ]
 
+def _asset_hash(path: os.PathLike[str]) -> str:
+    """Append a `?digest=` to an url based on the file content."""
+    full_path = (Path(html_static_path[0]) / path).resolve()
+    digest = hashlib.sha1(full_path.read_bytes()).hexdigest()
+
+    return f"{path}?digest={digest}"
+
+
 html_theme = 'furo'
 html_theme_options = {
     "source_repository": "https://github.com/python/devguide",
     "source_branch": "main",
 }
 html_static_path = ['_static']
 html_css_files = [
-    'devguide_overrides.css',
+    _asset_hash('devguide_overrides.css'),
 ]
 html_logo = "_static/python-logo.svg"
 html_favicon = "_static/favicon.png"
