mkdocstrings-python 1.10.8__tar.gz → 1.11.0__tar.gz

{mkdocstrings_python-1.10.8 → mkdocstrings_python-1.11.0}/CHANGELOG.md

@@ -5,6 +5,26 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 <!-- insertion marker -->
+## [1.11.0](https://github.com/mkdocstrings/python/releases/tag/1.11.0) - 2024-09-03
+
+<small>[Compare with 1.10.9](https://github.com/mkdocstrings/python/compare/1.10.9...1.11.0)</small>
+
+### Features
+
+- Hook into autorefs to provide context around cross-ref errors ([bb4be5b](https://github.com/mkdocstrings/python/commit/bb4be5be1b85be50f46c7889231a2d4a3bd05165) by Timothée Mazzucotelli).
+
+## [1.10.9](https://github.com/mkdocstrings/python/releases/tag/1.10.9) - 2024-08-30
+
+<small>[Compare with 1.10.8](https://github.com/mkdocstrings/python/compare/1.10.8...1.10.9)</small>
+
+### Build
+
+- Explicitly depend on mkdocs-autorefs to be able to specify lower bound ([2299ab5](https://github.com/mkdocstrings/python/commit/2299ab55641585d65babe0e116a6465b4736dcd9) by Timothée Mazzucotelli).
+
+### Code Refactoring
+
+- Use new autorefs syntax ([68cb72f](https://github.com/mkdocstrings/python/commit/68cb72f62253f54146ece621345b36c90d712913) by Timothée Mazzucotelli).
+
 ## [1.10.8](https://github.com/mkdocstrings/python/releases/tag/1.10.8) - 2024-08-14
 
 <small>[Compare with 1.10.7](https://github.com/mkdocstrings/python/compare/1.10.7...1.10.8)</small>

{mkdocstrings_python-1.10.8 → mkdocstrings_python-1.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mkdocstrings-python
-Version: 1.10.8
+Version: 1.11.0
 Summary: A Python handler for mkdocstrings.
 Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
 License: ISC
@@ -28,7 +28,8 @@ Project-URL: Discussions, https://github.com/mkdocstrings/python/discussions
 Project-URL: Gitter, https://gitter.im/mkdocstrings/python
 Project-URL: Funding, https://github.com/sponsors/pawamoy
 Requires-Python: >=3.8
-Requires-Dist: mkdocstrings>=0.25
+Requires-Dist: mkdocstrings>=0.26
+Requires-Dist: mkdocs-autorefs>=1.2
 Requires-Dist: griffe>=0.49
 Description-Content-Type: text/markdown
 

{mkdocstrings_python-1.10.8 → mkdocstrings_python-1.11.0}/docs/usage/configuration/docstrings.md

@@ -208,8 +208,8 @@ In that case, the Spacy tables can help.
 
 **Type**   | **Name**    | **Description**          | **Default**
 ---------- | ----------- | ------------------------ | -----------
-<code><span data-autorefs-optional="list">list</span>[<span data-autorefs-optional="int">int</span> \| <span data-autorefs-optional="float">float</span>]</code> | `gravity_forces` | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. | *required*
-<code><span data-autorefs-optional="VacuumType">VacuumType</span> \| <span data-autorefs-optional="typing.Literal">Literal</span>["regular"]</code> | `vacuum_type` | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. | `VacuumType.PLASMA`
+<code><autoref identifier="list" optional>list</autoref>[<autoref identifier="int" optional>int</autoref> \| <autoref identifier="float" optional>float</autoref>]</code> | `gravity_forces` | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. | *required*
+<code><autoref identifier="VacuumType" optional>VacuumType</autoref> \| <autoref identifier="typing.Literal" optional>Literal</autoref>["regular"]</code> | `vacuum_type` | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. | `VacuumType.PLASMA`
 ////
 
 //// tab | List
@@ -222,8 +222,8 @@ Lists work well whatever the length of names, type annotations, descriptions, et
 
 **Other Parameters:**
 
-- `gravity_forces` (<code><span data-autorefs-optional="list">list</span>[<span data-autorefs-optional="int">int</span> \| <span data-autorefs-optional="float">float</span>]</code>) &mdash; Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
-- `vacuum_type` (<code><span data-autorefs-optional="VacuumType">VacuumType</span> \| <span data-autorefs-optional="typing.Literal">Literal</span>["regular"]</code>) &mdash; Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+- `gravity_forces` (<code><autoref identifier="list" optional>list</autoref>[<autoref identifier="int" optional>int</autoref> \| <autoref identifier="float" optional>float</autoref>]</code>) &mdash; Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+- `vacuum_type` (<code><autoref identifier="VacuumType" optional>VacuumType</autoref> \| <autoref identifier="typing.Literal" optional>Literal</autoref>["regular"]</code>) &mdash; Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
 ////
 
 //// tab | Spacy
@@ -241,8 +241,8 @@ by reserving more horizontal space on the second column.
 
 **Name**    | **Description**
 ----------- | ---------------
-`gravity_forces` | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.<br>**TYPE:** <code><span data-autorefs-optional="list">list</span>[<span data-autorefs-optional="int">int</span> \| <span data-autorefs-optional="float">float</span>]</code> <span style="float: right;"><b>DEFAULT:</b> <i>required</i></span>
-`vacuum_type` | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.<br>**TYPE:**<code><span data-autorefs-optional="VacuumType">VacuumType</span> \| <span data-autorefs-optional="typing.Literal">Literal</span>["regular"]</code> <span style="float: right;"><b>DEFAULT:</b> <code>VacuumType.PLASMA</code></span>
+`gravity_forces` | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.<br>**TYPE:** <code><autoref identifier="list" optional>list</autoref>[<autoref identifier="int" optional>int</autoref> \| <autoref identifier="float" optional>float</autoref>]</code> <span style="float: right;"><b>DEFAULT:</b> <i>required</i></span>
+`vacuum_type` | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.<br>**TYPE:**<code><autoref identifier="VacuumType" optional>VacuumType</autoref> \| <autoref identifier="typing.Literal" optional>Literal</autoref>["regular"]</code> <span style="float: right;"><b>DEFAULT:</b> <code>VacuumType.PLASMA</code></span>
 ////
 ///
 

{mkdocstrings_python-1.10.8 → mkdocstrings_python-1.11.0}/docs/usage/configuration/general.md

@@ -139,7 +139,7 @@ def some_function():
 
 ## `preload_modules`
 
-- **:octicons-package-24: Type <code><span data-autorefs-optional="list">list</span>[<span data-autorefs-optional="str">str</span>] | None</code>  :material-equal: `None`{ title="default value" }**
+- **:octicons-package-24: Type <code><autoref identifier="list" optional>list</autoref>[<autoref identifier="str" optional>str</autoref>] | None</code>  :material-equal: `None`{ title="default value" }**
 <!-- - **:octicons-project-template-24: Template :material-null:** (N/A) -->
 
 Pre-load modules that are not specified directly in [autodoc instructions][autodoc syntax] (`::: identifier`).

{mkdocstrings_python-1.10.8 → mkdocstrings_python-1.11.0}/docs/usage/configuration/members.md

@@ -2,8 +2,8 @@
 
 ## `members`
 
-- **:octicons-package-24: Type <code><span data-autorefs-optional="list">list</span>[<span data-autorefs-optional="str">str</span>] |
-    <span data-autorefs-optional="bool">bool</span> | None</code>  :material-equal: `None`{ title="default value" }**
+- **:octicons-package-24: Type <code><autoref identifier="list" optional>list</autoref>[<autoref identifier="str" optional>str</autoref>] |
+    <autoref identifier="bool" optional>bool</autoref> | None</code>  :material-equal: `None`{ title="default value" }**
 <!-- - **:octicons-project-template-24: Template :material-null:** (N/A) -->
 
 An explicit list of members to render.
@@ -97,8 +97,8 @@ INFO: **The default behavior (with unspecified `members` or `members: null`) is
 
 ## `inherited_members`
 
-- **:octicons-package-24: Type <code><span data-autorefs-optional="list">list</span>[<span data-autorefs-optional="str">str</span>] |
-    <span data-autorefs-optional="bool">bool</span></code>  :material-equal: `False`{ title="default value" }**
+- **:octicons-package-24: Type <code><autoref identifier="list" optional>list</autoref>[<autoref identifier="str" optional>str</autoref>] |
+    <autoref identifier="bool" optional>bool</autoref></code>  :material-equal: `False`{ title="default value" }**
 <!-- - **:octicons-project-template-24: Template :material-null:** (N/A) -->
 
 An explicit list of inherited members (for classes) to render.
@@ -331,7 +331,7 @@ def function_c():
 
 ## `filters`
 
-- **:octicons-package-24: Type <code><span data-autorefs-optional="list">list</span>[<span data-autorefs-optional="str">str</span>] | None</code>  :material-equal: `["!^_[^_]"]`{ title="default value" }**
+- **:octicons-package-24: Type <code><autoref identifier="list" optional>list</autoref>[<autoref identifier="str" optional>str</autoref>] | None</code>  :material-equal: `["!^_[^_]"]`{ title="default value" }**
 <!-- - **:octicons-project-template-24: Template :material-null:** (N/A) -->
 
 A list of filters applied to filter objects based on their name.
@@ -555,7 +555,7 @@ package
 [:octicons-heart-fill-24:{ .pulse } Sponsors only](../../insiders/index.md){ .insiders } &mdash;
 [:octicons-tag-24: Insiders 1.2.0](../../insiders/changelog.md#1.2.0)
 
-- **:octicons-package-24: Type <code><span data-autorefs-optional="bool">bool</span> | <span data-autorefs-optional="dict">dict</span>[<span data-autorefs-optional="str">str</span>, <span data-autorefs-optional="bool">bool</span>]</code>  :material-equal: `False`{ title="default value" }**
+- **:octicons-package-24: Type <code><autoref identifier="bool" optional>bool</autoref> | <autoref identifier="dict" optional>dict</autoref>[<autoref identifier="str" optional>str</autoref>, <autoref identifier="bool" optional>bool</autoref>]</code>  :material-equal: `False`{ title="default value" }**
 <!-- - **:octicons-project-template-24: Template :material-null:** (N/A) -->
 
 Whether to render summaries of modules, classes, functions (methods) and attributes.

{mkdocstrings_python-1.10.8 → mkdocstrings_python-1.11.0}/duties.py

@@ -53,8 +53,8 @@ def changelog(ctx: Context, bump: str = "") -> None:
     ctx.run(tools.git_changelog(bump=bump or None), title="Updating changelog")
 
 
-@duty(pre=["check_quality", "check_types", "check_docs", "check_dependencies", "check-api"])
-def check(ctx: Context) -> None:  # noqa: ARG001
+@duty(pre=["check_quality", "check_types", "check_docs", "check-api"])
+def check(ctx: Context) -> None:
     """Check it all!"""
 
 

{mkdocstrings_python-1.10.8 → mkdocstrings_python-1.11.0}/pyproject.toml

@@ -32,10 +32,11 @@ classifiers = [
     "Typing :: Typed",
 ]
 dependencies = [
-    "mkdocstrings>=0.25",
+    "mkdocstrings>=0.26",
+    "mkdocs-autorefs>=1.2",
     "griffe>=0.49",
 ]
-version = "1.10.8"
+version = "1.11.0"
 
 [project.license]
 text = "ISC"

{mkdocstrings_python-1.10.8 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/handler.py

@@ -426,6 +426,7 @@ class PythonHandler(BaseHandler):
         self.env.filters["as_functions_section"] = rendering.do_as_functions_section
         self.env.filters["as_classes_section"] = rendering.do_as_classes_section
         self.env.filters["as_modules_section"] = rendering.do_as_modules_section
+        self.env.globals["AutorefsHook"] = rendering.AutorefsHook
         self.env.tests["existing_template"] = lambda template_name: template_name in self.env.list_templates()
 
     def get_anchors(self, data: CollectorItem) -> tuple[str, ...]:  # noqa: D102 (ignore missing docstring)

{mkdocstrings_python-1.10.8 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/rendering.py

@@ -22,6 +22,7 @@ from griffe import (
 )
 from jinja2 import TemplateNotFound, pass_context, pass_environment
 from markupsafe import Markup
+from mkdocs_autorefs.references import AutorefsHookInterface
 from mkdocstrings.loggers import get_logger
 
 if TYPE_CHECKING:
@@ -295,7 +296,10 @@ def do_crossref(path: str, *, brief: bool = True) -> Markup:
     full_path = path
     if brief:
         path = full_path.split(".")[-1]
-    return Markup("<span data-autorefs-optional-hover={full_path}>{path}</span>").format(full_path=full_path, path=path)
+    return Markup("<autoref identifier={full_path} optional hover>{path}</autoref>").format(
+        full_path=full_path,
+        path=path,
+    )
 
 
 @lru_cache
@@ -327,7 +331,7 @@ def do_multi_crossref(text: str, *, code: bool = True) -> Markup:
         path = match.group()
         path_var = f"path{group_number}"
         variables[path_var] = path
-        return f"<span data-autorefs-optional-hover={{{path_var}}}>{{{path_var}}}</span>"
+        return f"<autoref identifier={{{path_var}}} optional hover>{{{path_var}}}</autoref>"
 
     text = re.sub(r"([\w.]+)", repl, text)
     if code:
@@ -568,3 +572,60 @@ def do_as_modules_section(
         A modules docstring section.
     """
     return DocstringSectionModules([])
+
+
+class AutorefsHook(AutorefsHookInterface):
+    """Autorefs hook.
+
+    With this hook, we're able to add context to autorefs (cross-references),
+    such as originating file path and line number, to improve error reporting.
+    """
+
+    def __init__(self, current_object: Object | Alias, config: dict[str, Any]) -> None:
+        """Initialize the hook.
+
+        Parameters:
+            current_object: The object being rendered.
+            config: The configuration dictionary.
+        """
+        self.current_object = current_object
+        self.config = config
+
+    def expand_identifier(self, identifier: str) -> str:
+        """Expand an identifier.
+
+        Parameters:
+            identifier: The identifier to expand.
+
+        Returns:
+            The expanded identifier.
+        """
+        return identifier
+
+    def get_context(self) -> AutorefsHookInterface.Context:
+        """Get the context for the current object.
+
+        Returns:
+            The context.
+        """
+        role = {
+            "attribute": "data" if self.current_object.parent and self.current_object.parent.is_module else "attr",
+            "class": "class",
+            "function": "meth" if self.current_object.parent and self.current_object.parent.is_class else "func",
+            "module": "mod",
+        }.get(self.current_object.kind.value.lower(), "obj")
+        origin = self.current_object.path
+        try:
+            filepath = self.current_object.docstring.parent.filepath  # type: ignore[union-attr]
+            lineno = self.current_object.docstring.lineno or 0  # type: ignore[union-attr]
+        except AttributeError:
+            filepath = self.current_object.filepath
+            lineno = 0
+
+        return AutorefsHookInterface.Context(
+            domain="py",
+            role=role,
+            origin=origin,
+            filepath=str(filepath),
+            lineno=lineno,
+        )

{mkdocstrings_python-1.10.8 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/admonition.html.jinja

@@ -15,6 +15,6 @@ Context:
 {% endblock logs %}
 
 <details class="{{ section.value.kind }}" open>
-  <summary>{{ section.title|convert_markdown(heading_level, html_id, strip_paragraph=True) }}</summary>
-  {{ section.value.contents|convert_markdown(heading_level, html_id) }}
+  <summary>{{ section.title|convert_markdown(heading_level, html_id, strip_paragraph=True, autoref_hook=autoref_hook) }}</summary>
+  {{ section.value.contents|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
 </details>

{mkdocstrings_python-1.10.8 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html.jinja

@@ -33,7 +33,7 @@ Context:
       <tbody>
         {% for attribute in section.value %}
           <tr class="doc-section-item">
-            <td><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ attribute.name }}">{{ attribute.name }}</span></code></td>
+            <td><code><autoref identifier="{{ obj.path }}.{{ attribute.name }}" optional hover>{{ attribute.name }}</autoref></code></td>
             <td>
               {% if attribute.annotation %}
                 {% with expression = attribute.annotation %}
@@ -43,7 +43,7 @@ Context:
             </td>
             <td>
               <div class="doc-md-description">
-                {{ attribute.description|convert_markdown(heading_level, html_id) }}
+                {{ attribute.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
               </div>
             </td>
           </tr>
@@ -58,7 +58,7 @@ Context:
     <ul>
       {% for attribute in section.value %}
         <li class="doc-section-item field-body">
-          <b><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ attribute.name }}">{{ attribute.name }}</span></code></b>
+          <b><code><autoref identifier="{{ obj.path }}.{{ attribute.name }}" optional hover>{{ attribute.name }}</autoref></code></b>
           {% if attribute.annotation %}
             {% with expression = attribute.annotation %}
               (<code>{% include "expression"|get_template with context %}</code>)
@@ -66,7 +66,7 @@ Context:
           {% endif %}
           –
           <div class="doc-md-description">
-            {{ attribute.description|convert_markdown(heading_level, html_id) }}
+            {{ attribute.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
           </div>
         </li>
       {% endfor %}
@@ -85,10 +85,10 @@ Context:
       <tbody>
         {% for attribute in section.value %}
           <tr class="doc-section-item">
-            <td><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ attribute.name }}">{{ attribute.name }}</span></code></td>
+            <td><code><autoref identifier="{{ obj.path }}.{{ attribute.name }}" optional hover>{{ attribute.name }}</autoref></code></td>
             <td class="doc-attribute-details">
               <div class="doc-md-description">
-                {{ attribute.description|convert_markdown(heading_level, html_id) }}
+                {{ attribute.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
               </div>
               <p>
                 {% if attribute.annotation %}

{mkdocstrings_python-1.10.8 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/classes.html.jinja

@@ -32,10 +32,10 @@ Context:
       <tbody>
         {% for class in section.value %}
           <tr class="doc-section-item">
-            <td><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ class.name }}">{{ class.name }}</span></code></td>
+            <td><code><autoref identifier="{{ obj.path }}.{{ class.name }}" optional hover>{{ class.name }}</autoref></code></td>
             <td>
               <div class="doc-md-description">
-                {{ class.description|convert_markdown(heading_level, html_id) }}
+                {{ class.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
               </div>
             </td>
           </tr>
@@ -50,10 +50,10 @@ Context:
     <ul>
       {% for class in section.value %}
         <li class="doc-section-item field-body">
-          <b><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ class.name }}">{{ class.name }}</span></code></b>
+          <b><code><autoref identifier="{{ obj.path }}.{{ class.name }}" optional hover>{{ class.name }}</autoref></code></b>
           –
           <div class="doc-md-description">
-            {{ class.description|convert_markdown(heading_level, html_id) }}
+            {{ class.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
           </div>
         </li>
       {% endfor %}
@@ -72,10 +72,10 @@ Context:
       <tbody>
         {% for class in section.value %}
           <tr class="doc-section-item">
-            <td><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ class.name }}">{{ class.name }}</span></code></td>
+            <td><code><autoref identifier="{{ obj.path }}.{{ class.name }}" optional hover>{{ class.name }}</autoref></code></td>
             <td class="doc-class-details">
               <div class="doc-md-description">
-                {{ class.description|convert_markdown(heading_level, html_id) }}
+                {{ class.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
               </div>
             </td>
           </tr>

{mkdocstrings_python-1.10.8 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/examples.html.jinja

@@ -21,7 +21,7 @@ Context:
 <p><span class="doc-section-title">{{ section.title or lang.t("Examples:") }}</span></p>
 {% for section_type, sub_section in section.value %}
   {% if section_type.value == "text" %}
-    {{ sub_section|convert_markdown(heading_level, html_id) }}
+    {{ sub_section|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
   {% elif section_type.value == "examples" %}
     {{ sub_section|highlight(language="pycon", linenums=False) }}
   {% endif %}

{mkdocstrings_python-1.10.8 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/functions.html.jinja

@@ -33,10 +33,10 @@ Context:
         {% for function in section.value %}
           {% if not function.name == "__init__" or not config.merge_init_into_class %}
             <tr class="doc-section-item">
-              <td><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ function.name }}">{{ function.name }}</span></code></td>
+              <td><code><autoref identifier="{{ obj.path }}.{{ function.name }}" optional hover>{{ function.name }}</autoref></code></td>
               <td>
                 <div class="doc-md-description">
-                  {{ function.description|convert_markdown(heading_level, html_id) }}
+                  {{ function.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
                 </div>
               </td>
             </tr>
@@ -53,10 +53,10 @@ Context:
       {% for function in section.value %}
         {% if not function.name == "__init__" or not config.merge_init_into_class %}
           <li class="doc-section-item field-body">
-            <b><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ function.name }}">{{ function.name }}</span></code></b>
+            <b><code><autoref identifier="{{ obj.path }}.{{ function.name }}" optional hover>{{ function.name }}</autoref></code></b>
             –
             <div class="doc-md-description">
-              {{ function.description|convert_markdown(heading_level, html_id) }}
+              {{ function.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
             </div>
           </li>
         {% endif %}
@@ -77,10 +77,10 @@ Context:
         {% for function in section.value %}
           {% if not function.name == "__init__" or not config.merge_init_into_class %}
             <tr class="doc-section-item">
-              <td><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ function.name }}">{{ function.name }}</span></code></td>
+              <td><code><autoref identifier="{{ obj.path }}.{{ function.name }}" optional hover>{{ function.name }}</autoref></code></td>
               <td class="doc-function-details">
                 <div class="doc-md-description">
-                  {{ function.description|convert_markdown(heading_level, html_id) }}
+                  {{ function.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
                 </div>
               </td>
             </tr>

{mkdocstrings_python-1.10.8 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/modules.html.jinja

@@ -32,10 +32,10 @@ Context:
       <tbody>
         {% for module in section.value %}
           <tr class="doc-section-item">
-            <td><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ module.name }}">{{ module.name }}</span></code></td>
+            <td><code><autoref identifier="{{ obj.path }}.{{ module.name }}" optional hover>{{ module.name }}</autoref></code></td>
             <td>
               <div class="doc-md-description">
-                {{ module.description|convert_markdown(heading_level, html_id) }}
+                {{ module.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
               </div>
             </td>
           </tr>
@@ -50,10 +50,10 @@ Context:
     <ul>
       {% for module in section.value %}
         <li class="doc-section-item field-body">
-          <b><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ module.name }}">{{ module.name }}</span></code></b>
+          <b><code><autoref identifier="{{ obj.path }}.{{ module.name }}" optional hover>{{ module.name }}</autoref></code></b>
           –
           <div class="doc-md-description">
-            {{ module.description|convert_markdown(heading_level, html_id) }}
+            {{ module.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
           </div>
         </li>
       {% endfor %}
@@ -72,10 +72,10 @@ Context:
       <tbody>
         {% for module in section.value %}
           <tr class="doc-section-item">
-            <td><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ module.name }}">{{ module.name }}</span></code></td>
+            <td><code><autoref identifier="{{ obj.path }}.{{ module.name }}" optional hover>{{ module.name }}</autoref></code></td>
             <td class="doc-module-details">
               <div class="doc-md-description">
-                {{ module.description|convert_markdown(heading_level, html_id) }}
+                {{ module.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
               </div>
             </td>
           </tr>

{mkdocstrings_python-1.10.8 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html.jinja

@@ -43,7 +43,7 @@ Context:
             </td>
             <td>
               <div class="doc-md-description">
-                {{ parameter.description|convert_markdown(heading_level, html_id) }}
+                {{ parameter.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
               </div>
             </td>
           </tr>
@@ -66,7 +66,7 @@ Context:
           {% endif %}
           –
           <div class="doc-md-description">
-            {{ parameter.description|convert_markdown(heading_level, html_id) }}
+            {{ parameter.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
           </div>
         </li>
       {% endfor %}
@@ -88,7 +88,7 @@ Context:
             <td><code>{{ parameter.name }}</code></td>
             <td class="doc-param-details">
               <div class="doc-md-description">
-                {{ parameter.description|convert_markdown(heading_level, html_id) }}
+                {{ parameter.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
               </div>
               <p>
                 {% if parameter.annotation %}

{mkdocstrings_python-1.10.8 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html.jinja

@@ -44,7 +44,7 @@ Context:
             </td>
             <td>
               <div class="doc-md-description">
-                {{ parameter.description|convert_markdown(heading_level, html_id) }}
+                {{ parameter.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
               </div>
             </td>
             <td>
@@ -81,7 +81,7 @@ Context:
           {% endif %}
           –
           <div class="doc-md-description">
-            {{ parameter.description|convert_markdown(heading_level, html_id) }}
+            {{ parameter.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
           </div>
         </li>
       {% endfor %}
@@ -103,7 +103,7 @@ Context:
             <td><code>{{ parameter.name }}</code></td>
             <td class="doc-param-details">
               <div class="doc-md-description">
-                {{ parameter.description|convert_markdown(heading_level, html_id) }}
+                {{ parameter.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
               </div>
               <p>
                 {% if parameter.annotation %}

{mkdocstrings_python-1.10.8 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/raises.html.jinja

@@ -41,7 +41,7 @@ Context:
             </td>
             <td>
               <div class="doc-md-description">
-                {{ raises.description|convert_markdown(heading_level, html_id) }}
+                {{ raises.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
               </div>
             </td>
           </tr>
@@ -63,7 +63,7 @@ Context:
             –
           {% endif %}
           <div class="doc-md-description">
-            {{ raises.description|convert_markdown(heading_level, html_id) }}
+            {{ raises.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
           </div>
         </li>
       {% endfor %}
@@ -91,7 +91,7 @@ Context:
             </td>
             <td class="doc-raises-details">
               <div class="doc-md-description">
-                {{ raises.description|convert_markdown(heading_level, html_id) }}
+                {{ raises.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
               </div>
             </td>
           </tr>

{mkdocstrings_python-1.10.8 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html.jinja

@@ -44,7 +44,7 @@ Context:
             </td>
             <td>
               <div class="doc-md-description">
-                {{ receives.description|convert_markdown(heading_level, html_id) }}
+                {{ receives.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
               </div>
             </td>
           </tr>
@@ -69,7 +69,7 @@ Context:
           {% endif %}
           –
           <div class="doc-md-description">
-            {{ receives.description|convert_markdown(heading_level, html_id) }}
+            {{ receives.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
           </div>
         </li>
       {% endfor %}
@@ -101,7 +101,7 @@ Context:
             </td>
             <td class="doc-receives-details">
               <div class="doc-md-description">
-                {{ receives.description|convert_markdown(heading_level, html_id) }}
+                {{ receives.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
               </div>
               {% if receives.name and receives.annotation %}
                 <p>

{mkdocstrings_python-1.10.8 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html.jinja

@@ -44,7 +44,7 @@ Context:
             </td>
             <td>
               <div class="doc-md-description">
-                {{ returns.description|convert_markdown(heading_level, html_id) }}
+                {{ returns.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
               </div>
             </td>
           </tr>
@@ -69,7 +69,7 @@ Context:
           {% endif %}
           –
           <div class="doc-md-description">
-            {{ returns.description|convert_markdown(heading_level, html_id) }}
+            {{ returns.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
           </div>
         </li>
       {% endfor %}
@@ -101,7 +101,7 @@ Context:
             </td>
             <td class="doc-returns-details">
               <div class="doc-md-description">
-                {{ returns.description|convert_markdown(heading_level, html_id) }}
+                {{ returns.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
               </div>
               {% if returns.name and returns.annotation %}
                 <p>

{mkdocstrings_python-1.10.8 → mkdocstrings_python-1.11.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/warns.html.jinja

@@ -41,7 +41,7 @@ Context:
             </td>
             <td>
               <div class="doc-md-description">
-                {{ warns.description|convert_markdown(heading_level, html_id) }}
+                {{ warns.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
               </div>
             </td>
           </tr>
@@ -63,7 +63,7 @@ Context:
             –
           {% endif %}
           <div class="doc-md-description">
-            {{ warns.description|convert_markdown(heading_level, html_id) }}
+            {{ warns.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
           </div>
         </li>
       {% endfor %}
@@ -91,7 +91,7 @@ Context:
             </td>
             <td class="doc-warns-details">
               <div class="doc-md-description">
-                {{ warns.description|convert_markdown(heading_level, html_id) }}
+                {{ warns.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
               </div>
             </td>
           </tr>