python-docs-theme 2024.10__tar.gz → 2025.2__tar.gz

{python_docs_theme-2024.10 → python_docs_theme-2025.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: python-docs-theme
-Version: 2024.10
+Version: 2025.2
 Summary: The Sphinx theme for the CPython docs and related projects
 Author-email: PyPA <distutils-sig@python.org>
 Requires-Python: >=3.9
@@ -19,6 +19,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Documentation
 Classifier: Topic :: Software Development :: Documentation
+Requires-Dist: sphinx>=3.4
 Project-URL: Code, https://github.com/python/python-docs-theme
 Project-URL: Download, https://pypi.org/project/python-docs-theme/
 Project-URL: Homepage, https://github.com/python/python-docs-theme/
@@ -27,6 +28,7 @@ Project-URL: Issue tracker, https://github.com/python/python-docs-theme/issues
 # Python Docs Sphinx Theme
 
 This is the theme for the Python documentation.
+It requires Python 3.9 or newer and Sphinx 3.4 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

{python_docs_theme-2024.10 → python_docs_theme-2025.2}/README.md

@@ -1,6 +1,7 @@
 # Python Docs Sphinx Theme
 
 This is the theme for the Python documentation.
+It requires Python 3.9 or newer and Sphinx 3.4 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

{python_docs_theme-2024.10 → python_docs_theme-2025.2}/pyproject.toml

@@ -6,7 +6,6 @@ requires = [
 
 [project]
 name = "python-docs-theme"
-version = "2024.10"
 description = "The Sphinx theme for the CPython docs and related projects"
 readme = "README.md"
 license.file = "LICENSE"
@@ -28,6 +27,12 @@ classifiers = [
   "Topic :: Documentation",
   "Topic :: Software Development :: Documentation",
 ]
+dynamic = [ "version" ]
+
+dependencies = [
+  "sphinx>=3.4",
+]
+
 urls.Code = "https://github.com/python/python-docs-theme"
 urls.Download = "https://pypi.org/project/python-docs-theme/"
 urls.Homepage = "https://github.com/python/python-docs-theme/"

{python_docs_theme-2024.10 → python_docs_theme-2025.2}/python_docs_theme/__init__.py

@@ -1,15 +1,22 @@
 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()
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Any
+
+    from sphinx.application import Sphinx
+    from sphinx.util.typing import ExtensionMetadata
+
+__version__ = "2025.2"
+
+THEME_PATH = Path(__file__).resolve().parent
 
 
 @cache
@@ -52,13 +59,15 @@ def _html_page_context(
         )
 
 
-def setup(app):
-    current_dir = os.path.abspath(os.path.dirname(__file__))
-    app.add_html_theme("python_docs_theme", current_dir)
+def setup(app: Sphinx) -> ExtensionMetadata:
+    app.require_sphinx("3.4")
+
+    app.add_html_theme("python_docs_theme", str(THEME_PATH))
 
     app.connect("html-page-context", _html_page_context)
 
     return {
+        "version": __version__,
         "parallel_read_safe": True,
         "parallel_write_safe": True,
     }

{python_docs_theme-2024.10 → python_docs_theme-2025.2}/python_docs_theme/static/pydoctheme.css

@@ -140,6 +140,8 @@ span.pre {
 }
 
 div.sphinxsidebar {
+    display: flex;
+    width: min(25vw, 350px);
     float: none;
     position: sticky;
     top: 0;
@@ -156,13 +158,17 @@ div.sphinxsidebar h4 {
     margin-top: 1.5em;
 }
 
+div.bodywrapper {
+    margin-left: min(25vw, 350px);
+}
+
 div.sphinxsidebarwrapper {
-    width: 217px;
     box-sizing: border-box;
     height: 100%;
     overflow-x: hidden;
     overflow-y: auto;
-    float: left;
+    float: none;
+    flex-grow: 1;
 }
 
 div.sphinxsidebarwrapper > h3:first-child {
@@ -191,6 +197,9 @@ div.sphinxsidebar input[type='text'] {
 }
 
 #sidebarbutton {
+    display: flex;
+    justify-content: center;
+    align-items: center;
     /* Sphinx 4.x and earlier compat */
     height: 100%;
     background-color: #CCCCCC;
@@ -199,20 +208,14 @@ div.sphinxsidebar input[type='text'] {
     font-size: 1.2em;
     cursor: pointer;
     padding-top: 1px;
-    float: right;
-    display: table;
+    float: none;
     /* after Sphinx 4.x and earlier is dropped, only the below is needed */
     width: 12px;
+    min-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;
 }
@@ -489,7 +492,7 @@ div.genindex-jumpbox a {
         margin-inline-end: 0;
     }
     /* Remove sidebar and top related bar */
-    div.related, .sphinxsidebar {
+    div.related, div.sphinxsidebar {
         display: none;
     }
     /* Anchorlinks are not hidden by fixed-positioned navbar when scrolled to */
@@ -754,3 +757,10 @@ div.deprecated-removed .versionmodified,
 div.versionremoved .versionmodified {
     color: var(--deprecated);
 }
+
+/* Hide header when printing */
+@media print {
+    div.mobile-nav {
+        display: none;
+    }
+}