forked from python/python-docs-theme
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path__init__.py
More file actions
64 lines (47 loc) · 1.76 KB
/
Copy path__init__.py
File metadata and controls
64 lines (47 loc) · 1.76 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
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):
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 {
"parallel_read_safe": True,
"parallel_write_safe": True,
}