Merge pull request #28 from analog-garage/update-griffe

Update to griffe 1.0 or later (#27)

CHANGELOG.md

@@ -1,5 +1,9 @@
 # mkdocstring-python-xref changes
 
+## 1.6.2
+
+* Use griffe 1.0 or later
+
 ## 1.6.1
 
 * Available on conda-forge

environment.yml

@@ -6,8 +6,9 @@ dependencies:
   # runtime
   - python >=3.8,<3.13
   - mkdocstrings-python >=1.6.2,<2.0
+  - griffe >=1.0
   # build
-  - build >=0.7.0
+  - python-build >=1.0.0
   - hatchling >=1.21
   # test
   - coverage >=7.4.0

pyproject.toml

@@ -25,7 +25,8 @@ keywords = [
 dynamic = ["version"]
 requires-python = ">=3.8"
 dependencies = [
-    "mkdocstrings-python >=1.6.2,<2.0"
+    "mkdocstrings-python >=1.6.2,<2.0",
+    "griffe >=1.0"
 ]
 
 [project.urls]

src/mkdocstrings_handlers/python_xref/VERSION

@@ -1 +1 @@
-1.6.1
+1.6.2

src/mkdocstrings_handlers/python_xref/crossref.py

@@ -18,7 +18,7 @@
 import re
 from typing import Callable, List, Optional, cast
 
-from griffe.dataclasses import Docstring, Object
+from griffe import Docstring, Object
 from mkdocstrings.loggers import get_logger
 
 __all__ = [
@@ -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.
     """

src/mkdocstrings_handlers/python_xref/handler.py

@@ -21,7 +21,7 @@
 from pathlib import Path
 from typing import Any, List, Mapping, Optional
 
-from griffe.dataclasses import Object
+from griffe import Object
 from mkdocstrings.loggers import get_logger
 from mkdocstrings_handlers.python.handler import PythonHandler
 

tests/test_crossref.py

@@ -22,7 +22,7 @@
 from typing import Callable, Optional
 
 import pytest
-from griffe.dataclasses import Class, Docstring, Function, Module, Object
+from griffe import Class, Docstring, Function, Module, Object
 
 # noinspection PyProtectedMember
 from mkdocstrings_handlers.python_xref.crossref import (

tests/test_handler.py

@@ -23,7 +23,7 @@
 
 import pytest
 
-from griffe.dataclasses import Docstring, Object, Module
+from griffe import Docstring, Object, Module
 from mkdocstrings.handlers.base import CollectionError
 from mkdocstrings_handlers.python.handler import PythonHandler
 from mkdocstrings_handlers.python_xref.handler import PythonRelXRefHandler