Require Sphinx 7.2+

AA-Turner · AA-Turner · commit 7c199faeeb82 · 2025-02-02T17:10:50.000Z
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # Python Docs Sphinx Theme
 
 This is the theme for the Python documentation.
-It requires Python 3.10 or newer and Sphinx 3.4 or newer.
+It requires Python 3.10 or newer and Sphinx 7.2 or newer.
 
 Note that when adopting this theme, you're also borrowing an element of the
 trust and credibility established by the CPython core developers over the
diff --git a/pyproject.toml b/pyproject.toml
@@ -28,7 +28,7 @@ classifiers = [
   "Topic :: Software Development :: Documentation",
 ]
 dependencies = [
-  "sphinx>=3.4",
+  "sphinx>=7.2",
 ]
 
 urls.Code = "https://github.com/python/python-docs-theme"
diff --git a/python_docs_theme/__init__.py b/python_docs_theme/__init__.py
@@ -1,65 +1,17 @@
 from __future__ import annotations
 
-import hashlib
 import os
-from functools import cache
 from pathlib import Path
-from typing import Any
-
-import sphinx.application
-from sphinx.builders.html import StandaloneHTMLBuilder
 
 THEME_PATH = Path(__file__).parent.resolve()
 
 
-@cache
-def _asset_hash(path: str) -> str:
-    """Append a `?digest=` to an url based on the file content."""
-    full_path = THEME_PATH / path.replace("_static/", "static/")
-    digest = hashlib.sha1(full_path.read_bytes()).hexdigest()
-
-    return f"{path}?digest={digest}"
-
-
-def _add_asset_hashes(static: list[str], add_digest_to: list[str]) -> None:
-    for asset in add_digest_to:
-        index = static.index(asset)
-        static[index].filename = _asset_hash(asset)  # type: ignore[attr-defined]
-
-
-def _html_page_context(
-    app: sphinx.application.Sphinx,
-    pagename: str,
-    templatename: str,
-    context: dict[str, Any],
-    doctree: Any,
-) -> None:
-    if app.config.html_theme != "python_docs_theme":
-        return
-
-    assert isinstance(app.builder, StandaloneHTMLBuilder)
-
-    if (4,) <= sphinx.version_info < (7, 1) and "css_files" in context:
-        if "_static/pydoctheme.css" not in context["css_files"]:
-            raise ValueError(
-                "This documentation is not using `pydoctheme.css` as the stylesheet. "
-                "If you have set `html_style` in your conf.py file, remove it."
-            )
-
-        _add_asset_hashes(
-            context["css_files"],
-            ["_static/pydoctheme.css"],
-        )
-
-
 def setup(app):
-    app.require_sphinx("3.4")
+    app.require_sphinx("7.2")
 
     current_dir = os.path.abspath(os.path.dirname(__file__))
     app.add_html_theme("python_docs_theme", current_dir)
 
-    app.connect("html-page-context", _html_page_context)
-
     return {
         "version": "2024.12",
         "parallel_read_safe": True,
diff --git a/python_docs_theme/static/pydoctheme.css b/python_docs_theme/static/pydoctheme.css
@@ -191,28 +191,11 @@ div.sphinxsidebar input[type='text'] {
 }
 
 #sidebarbutton {
-    /* Sphinx 4.x and earlier compat */
-    height: 100%;
-    background-color: #CCCCCC;
-    margin-left: 0;
-    color: #444444;
-    font-size: 1.2em;
-    cursor: pointer;
-    padding-top: 1px;
-    float: right;
-    display: table;
-    /* after Sphinx 4.x and earlier is dropped, only the below is needed */
     width: 12px;
     border-radius: 0 5px 5px 0;
     border-left: none;
 }
 
-#sidebarbutton span {
-    /* Sphinx 4.x and earlier compat */
-    display: table-cell;
-    vertical-align: middle;
-}
-
 #sidebarbutton:hover {
     background-color: #AAAAAA;
 }
diff --git a/python_docs_theme/static/sidebar.js_t b/python_docs_theme/static/sidebar.js_t

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ classifiers = [`
`28`	`28`	`"Topic :: Software Development :: Documentation",`
`29`	`29`	`]`
`30`	`30`	`dependencies = [`
`31`		`- "sphinx>=3.4",`
	`31`	`+ "sphinx>=7.2",`
`32`	`32`	`]`
`33`	`33`
`34`	`34`	`urls.Code = "https://github.com/python/python-docs-theme"`