mkdocstrings-python-xref 1.14.0__tar.gz → 1.16__tar.gz

{mkdocstrings_python_xref-1.14.0 → mkdocstrings_python_xref-1.16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-python-xref
-Version: 1.14.0
+Version: 1.16
 Summary: Enhanced mkdocstrings python handler
 Project-URL: Repository, https://github.com/analog-garage/mkdocstrings-python-xref
 Project-URL: Documentation, https://analog-garage.github.io/mkdocstrings-python-xref/
@@ -17,7 +17,7 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Documentation
 Requires-Python: >=3.9
 Requires-Dist: griffe>=1.0
-Requires-Dist: mkdocstrings-python<2.0,>=1.14
+Requires-Dist: mkdocstrings-python<2.0,>=1.16.6
 Description-Content-Type: text/markdown
 
 # mkdocstrings-python-xref

mkdocstrings_python_xref-1.16/mkdocstrings_handlers/python_xref/VERSION

@@ -0,0 +1,2 @@
+1.16
+

{mkdocstrings_python_xref-1.14.0 → mkdocstrings_python_xref-1.16}/mkdocstrings_handlers/python_xref/crossref.py

@@ -19,7 +19,7 @@ import re
 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"
@@ -322,7 +322,7 @@ def substitute_relative_crossrefs(obj: Object, checkref: Optional[Callable[[str]
     """Recursively expand relative cross-references in all docstrings in tree.
 
     Arguments:
-        obj: a Griffe [Object][griffe.dataclasses.] whose docstrings should be modified
+        obj: a Griffe [Object][griffe.] whose docstrings should be modified
         checkref: optional function to check whether computed cross-reference is valid.
             Should return True if valid, False if not valid.
     """

{mkdocstrings_python_xref-1.14.0 → mkdocstrings_python_xref-1.16}/mkdocstrings_handlers/python_xref/handler.py

@@ -20,15 +20,12 @@ from __future__ import annotations
 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,14 +35,6 @@ __all__ = [
 
 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):
@@ -53,23 +42,7 @@ if sys.version_info >= (3, 10):
 
 @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

{mkdocstrings_python_xref-1.14.0 → mkdocstrings_python_xref-1.16}/pyproject.toml

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

mkdocstrings_python_xref-1.14.0/mkdocstrings_handlers/python_xref/VERSION

@@ -1 +0,0 @@
-1.14.0