FIX adapt code for sphinx 8.2.0 app -> registry (#145)

* FIX adapt code for sphinx 8.2.0 app -> registry

* stay backwards-compatible

* test on `sphinx=8.2`

* don't test `sphinx>=8` on `python=3.9`

* use `env` instead of `app` directly

* try passing `events` and `config`

* fetch `events` from the right object

* unpin `sphinx` when building the docs [skip-ci]

---------

Co-authored-by: Justus Magin <[email protected]>

Author: glemaitre

.github/workflows/ci.yaml

@@ -15,13 +15,15 @@ jobs:
       fail-fast: false
       matrix:
         python-version: ["3.9", "3.12", "3.13"]
-        sphinx-version: ["5.3", "6.2", "7.3", "7.4", "8.0", "8.1"]
+        sphinx-version: ["5.3", "6.2", "7.3", "7.4", "8.0", "8.1", "8.2"]
         exclude:
           # sphinx>=8 requires at least python 3.10
           - python-version: "3.9"
             sphinx-version: "8.0"
           - python-version: "3.9"
             sphinx-version: "8.1"
+          - python-version: "3.9"
+            sphinx-version: "8.2"
           # sphinx<6.2 uses imghdr, which was removed in python 3.13
           - python-version: "3.13"
             sphinx-version: "5.3"

docs/requirements.txt

@@ -1,3 +1,3 @@
 packaging
-sphinx>=6,<8.2
+sphinx>=6
 sphinx_rtd_theme

pyproject.toml

@@ -19,6 +19,7 @@ classifiers = [
 ]
 dependencies = [
   "sphinx >= 5.3",
+  "packaging",
 ]
 dynamic = ["version"]
 

sphinx_autosummary_accessors/autosummary.py

@@ -1,5 +1,7 @@
 import re
 
+import sphinx
+from packaging import version
 from sphinx.ext.autosummary import Autosummary, generate
 
 from sphinx_autosummary_accessors.templates import known_templates
@@ -19,34 +21,76 @@ def extract_documenter(content):
     return directive_name, "::".join([modname, name])
 
 
-def create_documenter_from_template(autosummary, app, obj, parent, full_name):
-    real_name = ".".join(full_name.split("::"))
-
-    options = autosummary.options
-    template_name = options.get("template", None)
-    if template_name is None or template_name not in known_templates:
-        return original_create_documenter(autosummary, app, obj, parent, full_name)
-
-    imported_members = options.get("imported_members", False)
-    recursive = options.get("recursive", False)
-
-    context = {}
-    context.update(app.config.autosummary_context)
-
-    rendered = generate.generate_autosummary_content(
-        real_name,
-        obj,
-        parent,
-        template=generate.AutosummaryRenderer(app),
-        template_name=template_name,
-        app=app,
-        context=context,
-        imported_members=imported_members,
-        recursive=recursive,
-    )
-
-    documenter_name, real_name = extract_documenter(rendered)
-    doccls = app.registry.documenters.get(documenter_name)
-    documenter = doccls(autosummary.bridge, real_name)
-
-    return documenter
+if version.parse(sphinx.__version__) >= version.Version("8.2.0"):
+
+    def create_documenter_from_template(
+        autosummary, obj, parent, full_name, *, registry
+    ):
+        real_name = ".".join(full_name.split("::"))
+
+        options = autosummary.options
+        template_name = options.get("template", None)
+        if template_name is None or template_name not in known_templates:
+            return original_create_documenter(
+                autosummary, obj, parent, full_name, registry=registry
+            )
+
+        imported_members = options.get("imported_members", False)
+        recursive = options.get("recursive", False)
+
+        context = {}
+        context.update(autosummary.env.config.autosummary_context)
+
+        rendered = generate.generate_autosummary_content(
+            real_name,
+            obj,
+            parent,
+            template=generate.AutosummaryRenderer(autosummary.env.app),
+            template_name=template_name,
+            context=context,
+            imported_members=imported_members,
+            recursive=recursive,
+            registry=registry,
+            events=autosummary.env.events,
+            config=autosummary.env.config,
+        )
+
+        documenter_name, real_name = extract_documenter(rendered)
+        doccls = registry.documenters.get(documenter_name)
+        documenter = doccls(autosummary.bridge, real_name)
+
+        return documenter
+
+else:
+
+    def create_documenter_from_template(autosummary, app, obj, parent, full_name):
+        real_name = ".".join(full_name.split("::"))
+
+        options = autosummary.options
+        template_name = options.get("template", None)
+        if template_name is None or template_name not in known_templates:
+            return original_create_documenter(autosummary, app, obj, parent, full_name)
+
+        imported_members = options.get("imported_members", False)
+        recursive = options.get("recursive", False)
+
+        context = {}
+        context.update(app.config.autosummary_context)
+
+        rendered = generate.generate_autosummary_content(
+            real_name,
+            obj,
+            parent,
+            template=generate.AutosummaryRenderer(app),
+            template_name=template_name,
+            app=app,
+            context=context,
+            imported_members=imported_members,
+            recursive=recursive,
+        )
+
+        documenter_name, real_name = extract_documenter(rendered)
+        doccls = app.registry.documenters.get(documenter_name)
+        documenter = doccls(autosummary.bridge, real_name)
+
+        return documenter