Merge pull request #34 from analog-garage/fix-bug32

Fix bug32

Author: analog-cbarber

CHANGELOG.md

@@ -1,5 +1,10 @@
 # mkdocstring-python-xref changes
 
+## 1.16.0
+
+* Compatibility with mkdocstrings-python 1.16.*
+* Removed some deprecated imports from mkdoctrings
+
 ## 1.14.1
 
 * Restrict to mkdocstrings-python <1.16 (see bug #32)

environment.yml

@@ -5,7 +5,7 @@ channels:
 dependencies:
   # runtime
   - python >=3.9,<3.14
-  - mkdocstrings-python >=1.14,<1.16 # BUG: #32
+  - mkdocstrings-python >=1.16.6,<2
   - griffe >=1.0
   # build
   - python-build >=1.0.0
@@ -24,3 +24,4 @@ dependencies:
   - mkdocs >=1.5.3,<2.0
   - mkdocs-material >=9.5.4
   - linkchecker >=10.4
+  - pydantic >=2.0

pyproject.toml

@@ -25,7 +25,7 @@ keywords = [
 dynamic = ["version"]
 requires-python = ">=3.9"
 dependencies = [
-    "mkdocstrings-python >=1.14,<1.16", # BUG: #32
+    "mkdocstrings-python >=1.16.6,<2.0",
     "griffe >=1.0"
 ]
 

src/mkdocstrings_handlers/python_xref/VERSION

@@ -1 +1,2 @@
-1.14.1
+1.16
+

src/mkdocstrings_handlers/python_xref/crossref.py

@@ -19,7 +19,7 @@
 from typing import Callable, List, Optional, cast
 
 from griffe import Docstring, Object
-from mkdocstrings.loggers import get_logger
+from mkdocstrings import get_logger
 
 __all__ = [
     "substitute_relative_crossrefs"

src/mkdocstrings_handlers/python_xref/handler.py

@@ -20,15 +20,12 @@
 import sys
 from dataclasses import dataclass, fields
 from pathlib import Path
-from textwrap import dedent
-from typing import Annotated, Any, ClassVar, Mapping, MutableMapping, Optional
+from typing import Any, ClassVar, Mapping, MutableMapping, Optional
 from warnings import warn
 
 from mkdocs.config.defaults import MkDocsConfig
-from mkdocstrings.handlers.base import CollectorItem
-from mkdocstrings.loggers import get_logger
-from mkdocstrings_handlers.python.config import PythonOptions, Field, PythonConfig
-from mkdocstrings_handlers.python.handler import PythonHandler
+from mkdocstrings import CollectorItem, get_logger
+from mkdocstrings_handlers.python import PythonHandler, PythonOptions, PythonConfig
 
 from .crossref import substitute_relative_crossrefs
 
@@ -38,38 +35,14 @@
 
 logger = get_logger(__name__)
 
-
-# TODO mkdocstrings 0.28
-#   - `name` and `domain` (py) must be specified as class attributes
-#   - `handler` arg to superclass is deprecated
-#   -  add `mdx` arg to constructor to pass on to superclass
-#   - `config_file_path` arg will no longer be passed
-#
-
 # TODO python 3.9 - remove when 3.9 support is dropped
 _dataclass_options = {"frozen": True}
 if sys.version_info >= (3, 10):
     _dataclass_options["kw_only"] = True
 
 @dataclass(**_dataclass_options)
 class PythonRelXRefOptions(PythonOptions):
-    check_crossrefs: Annotated[
-        bool,
-        Field(
-            group="docstrings",
-            parent="docstring_options",
-            description=dedent(
-                """
-                Enables early checking of all cross-references. 
-                
-                Note that this option only takes affect if **relative_crossrefs** is 
-                also true. This option is true by default, so this option is used to
-                disable checking. Checking can also be disabled on a per-case basis by 
-                prefixing the reference with '?', e.g. `[something][?dontcheckme]`.
-                """
-            ),
-        ),
-    ] = True
+    check_crossrefs: bool = True
 
 class PythonRelXRefHandler(PythonHandler):
     """Extended version of mkdocstrings Python handler