Merge branch 'main' into 3.16-support

Author: StanFromIreland

.github/workflows/lint.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
         with:
           persist-credentials: false
-      - uses: j178/prek-action@cbc2f23eb5539cf20d82d1aabd0d0ecbcc56f4e3 # v2.0.2
+      - uses: j178/prek-action@4e14d07f9231acabce116ccfca13b13dd9755ece # v3.0.0

.github/workflows/pypi-package.yml

@@ -20,18 +20,12 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
         with:
           persist-credentials: false
-      - uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
+      - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
 
-      - name: Compile translations
-        run: |
-          pip install --upgrade pip
-          pip install -r requirements.txt
-          python babel_runner.py compile
-
-      - uses: hynek/build-and-inspect-python-package@fe0a0fb1925ca263d076ca4f2c13e93a6e92a33e # v2.17.0
+      - uses: hynek/build-and-inspect-python-package@2abe76da66d0a6a4a227101f9348ee855797cfa5 # v3.0.1
 
   # Upload to real PyPI on GitHub Releases.
   release-pypi:
@@ -55,4 +49,4 @@ jobs:
           path: dist
 
       - name: Upload package to PyPI
-        uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b # v1.14.0
+        uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2

.github/workflows/tests.yml

@@ -20,10 +20,10 @@ jobs:
             branch: "main"
             allow-prerelease: "true"
     steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
         with:
           persist-credentials: false
-      - uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
+      - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
         with:
           python-version: ${{ matrix.python-version }}
           allow-prereleases: true
@@ -67,10 +67,10 @@ jobs:
         # Test minimum supported and latest stable from 3.x series
         python-version: ["3.12", "3"]
     steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
         with:
           persist-credentials: false
-      - uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
+      - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
         with:
           python-version: ${{ matrix.python-version }}
           allow-prereleases: true

.github/zizmor.yml

@@ -1,12 +1,12 @@
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.15.9
+    rev: v0.15.20
     hooks:
       - id: ruff-check
         args: [--exit-non-zero-on-fix]
 
   - repo: https://github.com/psf/black-pre-commit-mirror
-    rev: 26.3.1
+    rev: 26.5.1
     hooks:
       - id: black
 
@@ -22,7 +22,7 @@ repos:
       - id: trailing-whitespace
 
   - repo: https://github.com/python-jsonschema/check-jsonschema
-    rev: 0.37.1
+    rev: 0.37.4
     hooks:
       - id: check-dependabot
       - id: check-github-workflows
@@ -33,12 +33,12 @@ repos:
       - id: actionlint
 
   - repo: https://github.com/zizmorcore/zizmor-pre-commit
-    rev: v1.23.1
+    rev: v1.26.1
     hooks:
       - id: zizmor
 
   - repo: https://github.com/tox-dev/pyproject-fmt
-    rev: v2.21.0
+    rev: v2.25.1
     hooks:
       - id: pyproject-fmt
 

.pre-commit-config.yaml

@@ -1,5 +1,19 @@
 # Changelog
 
+## [2026.9](https://github.com/python/python-docs-theme/releases/tag/2026.9)
+
+* Add support for right-to-left page layout by @sepehr-rs in https://github.com/python/python-docs-theme/pull/324
+* Improve contrast between unvisited and visited links in dark mode
+  by @StanFromIreland in https://github.com/python/python-docs-theme/pull/329
+* Keep breadcrumb navigation visible on mobile by @undeMalum in
+  https://github.com/python/python-docs-theme/pull/326
+* Add Persian translation by @sepehr-rs in https://github.com/python/python-docs-theme/pull/322
+
+## [2026.7](https://github.com/python/python-docs-theme/releases/tag/2026.7)
+
+* Add Vietnamese translation by @StanFromIreland in https://github.com/python/python-docs-theme/pull/309
+* Switch to Hatchling build hooks for i18n packaging and exclude .po from wheels by @StanFromIreland in https://github.com/python/python-docs-theme/pull/312
+
 ## [2026.4](https://github.com/python/python-docs-theme/releases/tag/2026.4)
 
 * Add styling for the `soft-deprecated` class by @StanFromIreland

CHANGELOG.md

@@ -1,7 +1,6 @@
 # You can set these variables from the command line.
 CPYTHON_PATH = ../cpython
 PYTHON       = python3
-PACKAGE_ABS_PATH = $(shell pwd)/$(shell find dist/python-docs-theme-*.tar.gz)
 SPHINXOPTS   =
 
 
@@ -15,10 +14,11 @@ help:
 .PHONY: venv
 venv:
 	$(PYTHON) -m pip install build
+	rm -rf dist/
 	$(PYTHON) -m build
 	cd $(CPYTHON_PATH)/Doc \
 		&& make venv \
-		&& ./venv/bin/pip install $(PACKAGE_ABS_PATH)
+		&& ./venv/bin/pip install $(CURDIR)/dist/python_docs_theme-*.tar.gz
 
 .PHONY: html
 html: venv

Makefile

@@ -22,6 +22,8 @@ To use this theme, add the following to `conf.py`:
 
 - `html_sidebars`, defaults taken from https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_sidebars
 
+- To lay pages out right-to-left for languages such as Persian, Arabic, or Hebrew,
+  set `html_theme_options = {"is_rtl": True}`. Defaults to `false`.
 
 ## Translation
 

README.md

@@ -8,6 +8,8 @@
 import tomllib
 from pathlib import Path
 
+from hatchling.builders.hooks.plugin.interface import BuildHookInterface
+
 # Global variables used by pybabel below (paths relative to PROJECT_DIR)
 DOMAIN = "python-docs-theme"
 COPYRIGHT_HOLDER = "Python Software Foundation"
@@ -106,6 +108,11 @@ def compile_catalogs(locale: str) -> None:
     subprocess.run(cmd, cwd=PROJECT_DIR, check=True)
 
 
+class CustomBuildHook(BuildHookInterface):
+    def initialize(self, version: str, build_data: dict[str, object]) -> None:
+        compile_catalogs("")
+
+
 def main() -> None:
     parser = argparse.ArgumentParser(description=__doc__)
     parser.add_argument(

babel_runner.py

@@ -1,15 +1,16 @@
 [build-system]
-build-backend = "flit_core.buildapi"
+build-backend = "hatchling.build"
 requires = [
-  "flit-core>=3.7",
+  "babel",
+  "hatchling",
 ]
 
 [project]
 name = "python-docs-theme"
 description = "The Sphinx theme for the CPython docs and related projects"
 readme = "README.md"
 license = "PSF-2.0"
-license-files = [ "LICENSE" ]
+license-files = [ "LICENSE", "python_docs_theme/static/fonts/OFL.txt" ]
 authors = [ { name = "Python Docs Sphinx Theme maintainers" } ]
 requires-python = ">=3.12"
 classifiers = [
@@ -37,9 +38,15 @@ urls.Download = "https://pypi.org/project/python-docs-theme/"
 urls.Homepage = "https://github.com/python/python-docs-theme/"
 entry-points."sphinx.html_themes".python_docs_theme = "python_docs_theme"
 
-[tool.flit]
-module.name = "python_docs_theme"
-sdist.include = [ "python_docs_theme/" ]
+[tool.hatch]
+version.path = "python_docs_theme/__init__.py"
+build.artifacts = [ "python_docs_theme/locale/**/*.mo" ]
+build.hooks.custom.path = "babel_runner.py"
+build.targets.wheel.packages = [ "python_docs_theme" ]
+build.targets.wheel.exclude = [
+  "python_docs_theme/locale/**/*.po",
+  "python_docs_theme/static/fonts/OFL.txt",
+]
 
 [tool.ruff]
 fix = true