python-docs-theme 2024.4__py3-none-any.whl → 2024.10__py3-none-any.whl

python_docs_theme/__init__.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 import hashlib
 import os
-from functools import lru_cache
+from functools import cache
 from pathlib import Path
 from typing import Any
 
@@ -12,7 +12,7 @@ from sphinx.builders.html import StandaloneHTMLBuilder
 THEME_PATH = Path(__file__).parent.resolve()
 
 
-@lru_cache(maxsize=None)
+@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/")
@@ -24,7 +24,7 @@ def _asset_hash(path: str) -> str:
 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
+        static[index].filename = _asset_hash(asset)  # type: ignore[attr-defined]
 
 
 def _html_page_context(

python_docs_theme/static/pydoctheme.css

@@ -1,5 +1,15 @@
 @import url('classic.css');
 
+/* Common colours */
+:root {
+    --good-color: rgb(41 100 51);
+    --good-border: rgb(79 196 100);
+    --middle-color: rgb(133 72 38);
+    --middle-border: rgb(244, 227, 76);
+    --bad-color: rgb(159 49 51);
+    --bad-border: rgb(244, 76, 78);
+}
+
 /* unset some styles from the classic stylesheet */
 div.document,
 div.body,
@@ -232,7 +242,76 @@ div.body pre {
     border: 1px solid #ac9;
 }
 
-div.body div.admonition,
+/* Admonitions */
+:root {
+    --admonition-background: #eee;
+    --admonition-border: #ccc;
+    --admonition-color: black;
+    --attention-background: #bbddff5c;
+    --attention-border: #0000ff36;
+    --caution-background: #ffc;
+    --caution-border: #dd6;
+    --danger-background: #ffe4e4;
+    --danger-border: red;
+    --error-background: #ffe4e4;
+    --error-border: red;
+    --hint-background: #dfd;
+    --hint-border: green;
+    --seealso-background: #ffc;
+    --seealso-border: #dd6;
+    --tip-background: #dfd;
+    --tip-border: green;
+    --warning-background: #ffe4e4;
+    --warning-border: red;
+}
+
+div.body div.admonition {
+    background-color: var(--admonition-background);
+    border: 1px solid var(--admonition-border);
+    border-radius: 3px;
+    color: var(--admonition-color);
+}
+
+div.body div.admonition.attention {
+    background-color: var(--attention-background);
+    border-color: var(--attention-border);
+}
+
+div.body div.admonition.caution {
+    background-color: var(--caution-background);
+    border-color: var(--caution-border);
+}
+
+div.body div.admonition.danger {
+    background-color: var(--danger-background);
+    border-color: var(--danger-border);
+}
+
+div.body div.admonition.error {
+    background-color: var(--error-background);
+    border-color: var(--error-border);
+}
+
+div.body div.admonition.hint {
+    background-color: var(--hint-background);
+    border-color: var(--hint-border);
+}
+
+div.body div.admonition.seealso {
+    background-color: var(--seealso-background);
+    border-color: var(--seealso-border);
+}
+
+div.body div.admonition.tip {
+    background-color: var(--tip-background);
+    border-color: var(--tip-border);
+}
+
+div.body div.admonition.warning {
+    background-color: var(--warning-background);
+    border-color: var(--warning-border);
+}
+
 div.body div.impl-detail {
     border-radius: 3px;
 }
@@ -241,10 +320,6 @@ div.body div.impl-detail > p {
     margin: 0;
 }
 
-div.body div.seealso {
-    border: 1px solid #dddd66;
-}
-
 div.body a {
     color: #0072aa;
 }
@@ -323,8 +398,18 @@ div.footer a:hover {
     color: #0095c4;
 }
 
+/* C API return value annotations */
+:root {
+    --refcount: var(--good-color);
+    --refcount-return-borrowed-ref: var(--middle-color);
+}
+
 .refcount {
-    color: #060;
+    color: var(--refcount);
+}
+
+.refcount.return_borrowed_ref {
+    color: var(--refcount-return-borrowed-ref)
 }
 
 .stableabi {
@@ -625,13 +710,13 @@ div.genindex-jumpbox a {
 
 /* Version change directives */
 :root {
-    --versionadded: rgb(41 100 51);
-    --versionchanged: rgb(133 72 38);
-    --deprecated: rgb(159 49 51);
+    --versionadded: var(--good-color);
+    --versionchanged: var(--middle-color);
+    --deprecated: var(--bad-color);
 
-    --versionadded-border: rgb(79 196 100);
-    --versionchanged-border: rgb(244, 227, 76);
-    --deprecated-border: rgb(244, 76, 78);
+    --versionadded-border: var(--good-border);
+    --versionchanged-border: var(--middle-border);
+    --deprecated-border: var(--bad-border);
 }
 
 div.versionadded,

python_docs_theme/static/pydoctheme_dark.css

@@ -1,3 +1,13 @@
+/* Common colours */
+:root {
+    --good-color: rgb(79 196 100);
+    --good-border: var(--good-color);
+    --middle-color: rgb(244, 227, 76);
+    --middle-border: var(--middle-color);
+    --bad-color: rgb(244, 76, 78);
+    --bad-border: var(--bad-color);
+}
+
 
 /* Browser elements */
 :root {
@@ -79,10 +89,6 @@ table.docutils th {
     background-color: #424242;
 }
 
-.refcount {
-    color: #afa;
-}
-
 .stableabi {
     color: #bbf;
 }
@@ -107,6 +113,29 @@ div.warning {
     background-color: rgba(255, 0, 0, 0.5);
 }
 
+/* Admonitions */
+:root {
+    --admonition-background: #ffffff1a;
+    --admonition-border: currentColor;
+    --admonition-color: #ffffffde;
+    --attention-background: #ffffff1a;
+    --attention-border: currentColor;
+    --caution-background: #ffff001a;
+    --caution-border: #dd6;
+    --danger-background: #f003;
+    --danger-border: #f66;
+    --error-background: #f003;
+    --error-border: #f66;
+    --hint-background: #0044117a;
+    --hint-border: green;
+    --seealso-background: #ffff001a;
+    --seealso-border: #dd6;
+    --tip-background: #0044117a;
+    --tip-border: green;
+    --warning-background: #ff000033;
+    --warning-border: #ff6666;
+}
+
 aside.topic,
 div.topic,
 div.note,
@@ -143,7 +172,7 @@ img.invert-in-dark-mode {
 
 /* Version change directives */
 :root {
-    --versionadded: rgb(79 196 100);
-    --versionchanged: rgb(244, 227, 76);
-    --deprecated: rgb(244, 76, 78);
+    --versionadded: var(--good-color);
+    --versionchanged: var(--middle-color);
+    --deprecated: var(--bad-color);
 }

{python_docs_theme-2024.4.dist-info → python_docs_theme-2024.10.dist-info}/METADATA

@@ -1,9 +1,9 @@
 Metadata-Version: 2.1
 Name: python-docs-theme
-Version: 2024.4
+Version: 2024.10
 Summary: The Sphinx theme for the CPython docs and related projects
 Author-email: PyPA <distutils-sig@python.org>
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Framework :: Sphinx :: Theme
@@ -12,7 +12,6 @@ Classifier: License :: OSI Approved :: Python Software Foundation License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11

{python_docs_theme-2024.4.dist-info → python_docs_theme-2024.10.dist-info}/RECORD

@@ -1,4 +1,4 @@
-python_docs_theme/__init__.py,sha256=lohzhV2LTSRLhxi0G8Emc_TkccarW1O4aYXvFGU1HR8,1814
+python_docs_theme/__init__.py,sha256=y9oW_V56hYBi9-aRpCvmHNwsbkAWeTog39_y844Aau8,1806
 python_docs_theme/footerdonate.html,sha256=SVxLBvbrliqOzjau4SdhhtkRGXxX5ZrZN6Yr6luRhIQ,184
 python_docs_theme/layout.html,sha256=W5gSelJr85H5a1uaSPUDFoONpaGscpqdJkKszq5t95E,7891
 python_docs_theme/theme.conf,sha256=y8hpLRiQymGaL7AuTvXRxmhUMk6I3ehHCh5fUWbfD88,1040
@@ -6,13 +6,13 @@ python_docs_theme/static/copybutton.js,sha256=LSeNL29gDNKg3fv4rfcb8t-8xkH6HozpCb
 python_docs_theme/static/menu.js,sha256=JmrKD08_6CiCgQH32As9AgiSiV-th1fZInVrmTCihzA,2137
 python_docs_theme/static/py.png,sha256=rhc9xIQjUfwcilUa-9tYyyspVJB4ITDapPNZpqgNclY,695
 python_docs_theme/static/py.svg,sha256=WGW-i8wK-IhZSQPqARL2yNkjxXJsQIHoyFYRDMcznO8,2041
-python_docs_theme/static/pydoctheme.css,sha256=86sc2-vQq1GqDK6h0Jxkgv9uWO1Za547qg_kewKf66Y,13101
-python_docs_theme/static/pydoctheme_dark.css,sha256=hLQOuwzSg9ccMMluYPrD3Z2Mc4yBNhPpkUb02a4YdOA,2371
+python_docs_theme/static/pydoctheme.css,sha256=TBPi9HIqrSmIrMdmXpmCGsdUgjQItFm6cXB_0rviccc,15305
+python_docs_theme/static/pydoctheme_dark.css,sha256=NJ3l0yMhn_hH3CPJ5f_DwxxSr6j4OHHEvaxzkM9Yy2k,3252
 python_docs_theme/static/search-focus.js,sha256=DwWV71ssKvrzagPenP7yLvFQCdyqFJirbBk1PFRvVoA,559
 python_docs_theme/static/sidebar.js_t,sha256=swTyAoy6dNGm6Ro0_iRl_9ujRrIz5nq207tMIqNnYgs,3350
 python_docs_theme/static/themetoggle.js,sha256=6D1LE0wg8DjPP776_KxPCxXdIk-gGJJX5DYpHFLG1Uw,779
-python_docs_theme-2024.4.dist-info/entry_points.txt,sha256=VqpxCWQkYo2DkZVV2D2vA9LKmexR1Yhicqsrff4JAag,58
-python_docs_theme-2024.4.dist-info/LICENSE,sha256=lx_9CsorlYBu9cw97FX-A1VnHHmrwk-H-jydZBJlWmY,2460
-python_docs_theme-2024.4.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
-python_docs_theme-2024.4.dist-info/METADATA,sha256=CreIC3i0jCE1j6slzNX4eKffMvTKl3L1gqosZ6p1Hfw,2343
-python_docs_theme-2024.4.dist-info/RECORD,,
+python_docs_theme-2024.10.dist-info/entry_points.txt,sha256=VqpxCWQkYo2DkZVV2D2vA9LKmexR1Yhicqsrff4JAag,58
+python_docs_theme-2024.10.dist-info/LICENSE,sha256=lx_9CsorlYBu9cw97FX-A1VnHHmrwk-H-jydZBJlWmY,2460
+python_docs_theme-2024.10.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
+python_docs_theme-2024.10.dist-info/METADATA,sha256=05pxr7bO3oIe8TP2ZxxmdtIUyECVjnyhukQeGrh_k8k,2294
+python_docs_theme-2024.10.dist-info/RECORD,,