Merge pull request #55 from analog-garage/mkdocstrings-python-2

Mkdocstrings python 2

Author: analog-cbarber

.idea/inspectionProfiles/Project_Default.xml

@@ -3,6 +3,10 @@
 *Note that versions roughly correspond to the version of mkdocstrings-python that they 
 are compatible with.*
 
+## 2.0.0
+
+* Depends on mkdocstrings-python >=2.0 and mkdocstrings >=1.0
+
 ## 1.16.5
 
 * Drop python 3.9 support

CHANGELOG.md

@@ -34,9 +34,11 @@ Additional options are added by this extension. Currently, there are three:
             default_handler: python_xref
             handlers:
               python_xref:
-                import:
-                - https://docs.python.org/3/objects.inv
-                - https://pytorch.org/docs/stable/objects.inv
+                inventories:
+                - url: https://docs.python.org/3/objects.inv
+                  domains: [std, py]
+                - url: https://pytorch.org/docs/stable/objects.inv
+                  domains: [py]
                 options:
                   relative_crossrefs: yes
         ```
@@ -49,9 +51,11 @@ Additional options are added by this extension. Currently, there are three:
             default_handler: python_xref
             handlers:
               python_xref:
-                import:
-                - https://docs.python.org/3/objects.inv
-                - https://pytorch.org/docs/stable/objects.inv
+                inventories:
+                - url: https://docs.python.org/3/objects.inv
+                  domains: [std, py]
+                - url: https://pytorch.org/docs/stable/objects.inv
+                  domains: [py]
                 options:
                   relative_crossrefs: yes
                   check_crossrefs_exclude:
@@ -66,9 +70,11 @@ Additional options are added by this extension. Currently, there are three:
             default_handler: python_xref
             handlers:
               python_xref:
-                import:
-                - https://docs.python.org/3/objects.inv
-                - https://pytorch.org/docs/stable/objects.inv
+                inventories:
+                - url: https://docs.python.org/3/objects.inv
+                  domains: [std, py]
+                - url: https://pytorch.org/docs/stable/objects.inv
+                  domains: [py]
                 options:
                   relative_crossrefs: yes
                   check_crossrefs: no

docs/config.md

@@ -25,7 +25,8 @@ keywords = [
 dynamic = ["version"]
 requires-python = ">=3.10"
 dependencies = [
-    "mkdocstrings-python >=1.16.6,<2.0",
+    "mkdocstrings-python >=2.0",
+    "mkdocstrings >=1.0",
     "griffe >=1.0",
 ]
 

pixi.lock

@@ -1 +1 @@
-1.16.5
+2.0.0

pyproject.toml

@@ -78,7 +78,7 @@ def get_options(self, local_options: Mapping[str, Any]) -> PythonRelXRefOptions:
         )
         return opts
 
-    def render(self, data: CollectorItem, options: PythonOptions) -> str:
+    def render(self, data: CollectorItem, options: PythonOptions, locale: str | None = None) -> str:
         if options.relative_crossrefs:
             if isinstance(options, PythonRelXRefOptions) and options.check_crossrefs:
                 checkref = partial(
@@ -88,7 +88,7 @@ def render(self, data: CollectorItem, options: PythonOptions) -> str:
             substitute_relative_crossrefs(data, checkref=checkref)
 
         try:
-            return super().render(data, options)
+            return super().render(data, options, locale=locale)
         except Exception:  # pragma: no cover
             print(f"{data.path=}")
             raise

src/mkdocstrings_handlers/python_xref/VERSION

@@ -1,4 +1,4 @@
-#  Copyright (c) 2022-2025.   Analog Devices Inc.
+#  Copyright (c) 2022-2026.   Analog Devices Inc.
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -58,6 +58,8 @@ def test_handler(tmpdir: PathLike,
         Path(tmpdir),
         theme = 'material',
         custom_templates = 'custom_templates',
+        mdx = [],
+        mdx_config= {},
     )
     assert handler.name == 'python_xref'
 
@@ -83,7 +85,7 @@ def fake_collect(_self: PythonHandler, identifier: str, _config: dict) -> Any:
             return Object(identifier)
         raise CollectionError(identifier)
 
-    def fake_render(_self: PythonHandler, data: Object, _config: dict) -> str:
+    def fake_render(_self: PythonHandler, data: Object, _config: dict, locale: str|None = None) -> str:
         assert data.docstring is not None
         return data.docstring.value