Merge branch 'master' into drop-reqs

AA-Turner · AA-Turner · commit f2c2dbbaf83d · 2025-02-04T15:10:25.000Z
# Conflicts:
#	python_docs_theme/__init__.py
#	python_docs_theme/static/pydoctheme.css
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,6 +1,18 @@
 Changelog
 =========
 
+`2025.2 <https://github.com/python/python-docs-theme/releases/tag/2025.2>`_
+---------------------------------------------------------------------------
+
+- Note minimum requirements for Sphinx (#216)
+    Contributed by Adam Turner
+- Horizontally centre the sidebar collapse button (#219)
+    Contributed by Tomas Roun
+- Make sidebar width more flexible (#218)
+    Contributed by Tomas Roun
+- Set ``__version__`` in the runtime package (#222)
+    Contributed by Adam Turner
+
 `2024.12 <https://github.com/python/python-docs-theme/releases/tag/2024.12>`_
 -----------------------------------------------------------------------------
 
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -2,7 +2,7 @@ How to release
 --------------
 
 - Update ``CHANGELOG.rst``
-- Bump version (YYYY.MM) in ``pyproject.toml``
+- Bump version (YYYY.MM) in ``python_docs_theme/__init__.py``
 - Commit
 - Push to check tests pass on
   `GitHub Actions <https://github.com/python/python-docs-theme/actions>`__
diff --git a/babel_runner.py b/babel_runner.py
@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 import argparse
+import ast
 import subprocess
 from pathlib import Path
 
@@ -17,6 +18,8 @@
         ) from ie
 
 PROJECT_DIR = Path(__file__).resolve().parent
+PYPROJECT_TOML = PROJECT_DIR / "pyproject.toml"
+INIT_PY = PROJECT_DIR / "python_docs_theme" / "__init__.py"
 
 # Global variables used by pybabel below (paths relative to PROJECT_DIR)
 DOMAIN = "messages"
@@ -29,9 +32,23 @@
 
 def get_project_info() -> dict:
     """Retrieve project's info to populate the message catalog template"""
-    with open(Path(PROJECT_DIR / "pyproject.toml"), "rb") as f:
-        data = tomllib.load(f)
-    return data["project"]
+    pyproject_text = PYPROJECT_TOML.read_text(encoding="utf-8")
+    project_data = tomllib.loads(pyproject_text)["project"]
+
+    # read __version__ from __init__.py
+    for child in ast.parse(INIT_PY.read_bytes()).body:
+        if not isinstance(child, ast.Assign):
+            continue
+        target = child.targets[0]
+        if not isinstance(target, ast.Name) or target.id != "__version__":
+            continue
+        version_node = child.value
+        if not isinstance(version_node, ast.Constant):
+            continue
+        project_data["version"] = version_node.value
+        break
+
+    return project_data
 
 
 def extract_messages() -> None:
diff --git a/pyproject.toml b/pyproject.toml
@@ -6,7 +6,6 @@ requires = [
 
 [project]
 name = "python-docs-theme"
-version = "2024.12"
 description = "The Sphinx theme for the CPython docs and related projects"
 readme = "README.md"
 license.file = "LICENSE"
@@ -27,6 +26,8 @@ classifiers = [
   "Topic :: Documentation",
   "Topic :: Software Development :: Documentation",
 ]
+dynamic = [ "version" ]
+
 dependencies = [
   "sphinx>=7.3",
 ]
diff --git a/python_docs_theme/__init__.py b/python_docs_theme/__init__.py
@@ -1,21 +1,24 @@
 from __future__ import annotations
 
 from pathlib import Path
-from typing import TYPE_CHECKING
 
+TYPE_CHECKING = False
 if TYPE_CHECKING:
     from sphinx.application import Sphinx
     from sphinx.util.typing import ExtensionMetadata
 
+__version__ = "2025.2"
+
 THEME_PATH = Path(__file__).resolve().parent
 
 
 def setup(app: Sphinx) -> ExtensionMetadata:
     app.require_sphinx("7.3")
+
     app.add_html_theme("python_docs_theme", THEME_PATH)
 
     return {
-        "version": "2024.12",
+        "version": __version__,
         "parallel_read_safe": True,
         "parallel_write_safe": True,
     }
diff --git a/python_docs_theme/static/pydoctheme.css b/python_docs_theme/static/pydoctheme.css
@@ -138,6 +138,8 @@ span.pre {
 }
 
 div.sphinxsidebar {
+    display: flex;
+    width: min(25vw, 350px);
     float: none;
     position: sticky;
     top: 0;
@@ -154,13 +156,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 {
@@ -189,7 +195,11 @@ div.sphinxsidebar input[type='text'] {
 }
 
 #sidebarbutton {
+    display: flex;
+    justify-content: center;
+    align-items: center;
     width: 12px;
+    min-width: 12px;
     border-radius: 0 5px 5px 0;
     border-left: none;
 }
@@ -470,7 +480,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 */
