From 8df468e1be2311de55ba174692dbc9bd1652dc48 Mon Sep 17 00:00:00 2001
From: Christopher Barber <christopher.barber@analog.com>
Date: Thu, 19 Sep 2024 12:14:19 -0400
Subject: [PATCH] Update to griffe 1.0 or later (#27)

---
 CHANGELOG.md                                      | 4 ++++
 environment.yml                                   | 3 ++-
 pyproject.toml                                    | 3 ++-
 src/mkdocstrings_handlers/python_xref/VERSION     | 2 +-
 src/mkdocstrings_handlers/python_xref/crossref.py | 4 ++--
 src/mkdocstrings_handlers/python_xref/handler.py  | 2 +-
 tests/test_crossref.py                            | 2 +-
 tests/test_handler.py                             | 2 +-
 8 files changed, 14 insertions(+), 8 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 698e5e1..3591c88 100644
--- a/CHANGELOG.md
+++ b/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
diff --git a/environment.yml b/environment.yml
index 98131ad..437c633 100644
--- a/environment.yml
+++ b/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
diff --git a/pyproject.toml b/pyproject.toml
index 636767a..a1d7f52 100644
--- a/pyproject.toml
+++ b/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]
diff --git a/src/mkdocstrings_handlers/python_xref/VERSION b/src/mkdocstrings_handlers/python_xref/VERSION
index 9c6d629..fdd3be6 100644
--- a/src/mkdocstrings_handlers/python_xref/VERSION
+++ b/src/mkdocstrings_handlers/python_xref/VERSION
@@ -1 +1 @@
-1.6.1
+1.6.2
diff --git a/src/mkdocstrings_handlers/python_xref/crossref.py b/src/mkdocstrings_handlers/python_xref/crossref.py
index 9f3a8f1..1035d4e 100644
--- a/src/mkdocstrings_handlers/python_xref/crossref.py
+++ b/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.
     """
diff --git a/src/mkdocstrings_handlers/python_xref/handler.py b/src/mkdocstrings_handlers/python_xref/handler.py
index d8e6b69..5128e2f 100644
--- a/src/mkdocstrings_handlers/python_xref/handler.py
+++ b/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
 
diff --git a/tests/test_crossref.py b/tests/test_crossref.py
index 08c4aa2..48e102d 100644
--- a/tests/test_crossref.py
+++ b/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 (
diff --git a/tests/test_handler.py b/tests/test_handler.py
index d56ca1d..bd61bf4 100644
--- a/tests/test_handler.py
+++ b/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