refactor: Update cross-reference markup to new autorefs format

Issue-6: #6 PR-7: #7 Co-authored-by: Timothée Mazzucotelli <[email protected]>
mkdocstrings · Sep 7, 2024 · 89592bd · 89592bd
1 parent d426136
commit 89592bd
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/pyproject.toml b/pyproject.toml
@@ -30,6 +30,7 @@ classifiers = [
 ]
 dependencies = [
  "mkdocstrings>=0.19",
+ "mkdocs-autorefs>=1.1",
  "pytkdocs>=0.14",
 ]
 

diff --git a/src/mkdocstrings_handlers/python/rendering.py b/src/mkdocstrings_handlers/python/rendering.py
@@ -20,7 +20,7 @@ def do_brief_xref(path: str) -> Markup:
  A span containing the brief cross-reference and the full one on hover.
  """
  brief = path.split(".")[-1]
- return Markup("<span data-autorefs-optional-hover={path}>{brief}</span>").format(path=path, brief=brief)
+ return Markup("<autoref identifier={path} optional hover>{brief}</autoref>").format(path=path, brief=brief)
 
 
 def sort_object(obj: CollectorItem, sort_function: Callable[[CollectorItem], Any]) -> None: