GeezerVison is showing github.com — python-docs-theme/python_docs_theme/__init__.py at 2024.10 · python/python-docs-theme

Expand file tree

init.py

Copy path

More file actions

Latest commit

History

64 lines (47 loc) · 1.76 KB

init.py

Copy path

File metadata and controls

64 lines (47 loc) · 1.76 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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,

}