mkdocstrings-python 1.18.2__py3-none-any.whl → 2.0.0__py3-none-any.whl

mkdocstrings_handlers/python/__init__.py

@@ -24,14 +24,12 @@ from mkdocstrings_handlers.python._internal.rendering import (
     do_as_modules_section,
     do_as_type_aliases_section,
     do_backlink_tree,
-    do_crossref,
     do_filter_objects,
     do_format_attribute,
     do_format_code,
     do_format_signature,
     do_format_type_alias,
     do_get_template,
-    do_multi_crossref,
     do_order_members,
     do_split_path,
     do_stash_crossref,
@@ -59,14 +57,12 @@ __all__ = [
     "do_as_modules_section",
     "do_as_type_aliases_section",
     "do_backlink_tree",
-    "do_crossref",
     "do_filter_objects",
     "do_format_attribute",
     "do_format_code",
     "do_format_signature",
     "do_format_type_alias",
     "do_get_template",
-    "do_multi_crossref",
     "do_order_members",
     "do_split_path",
     "do_stash_crossref",

mkdocstrings_handlers/python/_internal/config.py

@@ -39,18 +39,6 @@ try:
     if getattr(pydantic, "__version__", "1.").startswith("1."):
         raise ImportError  # noqa: TRY301
 
-    # YORE: EOL 3.9: Remove block.
-    if sys.version_info < (3, 10):
-        try:
-            import eval_type_backport  # noqa: F401
-        except ImportError:
-            _logger.debug(
-                "Pydantic needs the `eval-type-backport` package to be installed "
-                "for modern type syntax to work on Python 3.9. "
-                "Deactivating Pydantic validation for Python handler options.",
-            )
-            raise
-
     from inspect import cleandoc
 
     from pydantic import Field as BaseField
@@ -87,14 +75,7 @@ if TYPE_CHECKING:
     from collections.abc import MutableMapping
 
 
-# YORE: EOL 3.9: Remove block.
-_dataclass_options = {"frozen": True}
-if sys.version_info >= (3, 10):
-    _dataclass_options["kw_only"] = True
-
-
-# YORE: EOL 3.9: Replace `**_dataclass_options` with `frozen=True, kw_only=True` within line.
-@dataclass(**_dataclass_options)  # type: ignore[call-overload]
+@dataclass(frozen=True, kw_only=True)
 class GoogleStyleOptions:
     """Google style docstring options."""
 
@@ -205,8 +186,7 @@ class GoogleStyleOptions:
     ] = True
 
 
-# YORE: EOL 3.9: Replace `**_dataclass_options` with `frozen=True, kw_only=True` within line.
-@dataclass(**_dataclass_options)  # type: ignore[call-overload]
+@dataclass(frozen=True, kw_only=True)
 class NumpyStyleOptions:
     """Numpy style docstring options."""
 
@@ -256,8 +236,7 @@ class NumpyStyleOptions:
     ] = True
 
 
-# YORE: EOL 3.9: Replace `**_dataclass_options` with `frozen=True, kw_only=True` within line.
-@dataclass(**_dataclass_options)  # type: ignore[call-overload]
+@dataclass(frozen=True, kw_only=True)
 class SphinxStyleOptions:
     """Sphinx style docstring options."""
 
@@ -289,8 +268,7 @@ class SphinxStyleOptions:
     ] = True
 
 
-# YORE: EOL 3.9: Replace `**_dataclass_options` with `frozen=True, kw_only=True` within line.
-@dataclass(**_dataclass_options)  # type: ignore[call-overload]
+@dataclass(frozen=True, kw_only=True)
 class PerStyleOptions:
     """Per style options."""
 
@@ -333,8 +311,7 @@ class PerStyleOptions:
         return cls(**data)
 
 
-# YORE: EOL 3.9: Replace `**_dataclass_options` with `frozen=True, kw_only=True` within line.
-@dataclass(**_dataclass_options)  # type: ignore[call-overload]
+@dataclass(frozen=True, kw_only=True)
 class AutoStyleOptions:
     """Auto style docstring options."""
 
@@ -382,8 +359,7 @@ class AutoStyleOptions:
         return cls(**data)
 
 
-# YORE: EOL 3.9: Replace `**_dataclass_options` with `frozen=True, kw_only=True` within line.
-@dataclass(**_dataclass_options)  # type: ignore[call-overload]
+@dataclass(frozen=True, kw_only=True)
 class SummaryOption:
     """Summary option."""
 
@@ -433,8 +409,7 @@ class SummaryOption:
     ] = False
 
 
-# YORE: EOL 3.9: Replace `**_dataclass_options` with `frozen=True, kw_only=True` within line.
-@dataclass(**_dataclass_options)  # type: ignore[call-overload]
+@dataclass(frozen=True, kw_only=True)
 class PythonInputOptions:
     """Accepted input options."""
 
@@ -519,9 +494,6 @@ class PythonInputOptions:
 
             **Filtering methods**
 
-            [:octicons-heart-fill-24:{ .pulse } Sponsors only](../insiders/index.md){ .insiders } &mdash;
-            [:octicons-tag-24: Insiders 1.11.0](../insiders/changelog.md#1.11.0)
-
             The `public` method will include only public objects:
             those added to `__all__` or not starting with an underscore (except for special methods/attributes).
             """,
@@ -560,6 +532,14 @@ class PythonInputOptions:
         ),
     ] = 2
 
+    inheritance_diagram_direction: Annotated[
+        Literal["TB", "TD", "BT", "RL", "LR"],
+        _Field(
+            group="docstrings",
+            description="The direction of the Mermaid chart presenting the inheritance diagram of a class.",
+        ),
+    ] = "TD"
+
     inherited_members: Annotated[
         bool | list[str],
         _Field(
@@ -1062,8 +1042,7 @@ class PythonInputOptions:
         return cls(**cls.coerce(**data))
 
 
-# YORE: EOL 3.9: Replace `**_dataclass_options` with `frozen=True, kw_only=True` within line.
-@dataclass(**_dataclass_options)  # type: ignore[call-overload]
+@dataclass(frozen=True, kw_only=True)
 class PythonOptions(PythonInputOptions):  # type: ignore[override,unused-ignore]
     """Final options passed as template context."""
 
@@ -1080,11 +1059,7 @@ class PythonOptions(PythonInputOptions):  # type: ignore[override,unused-ignore]
     @classmethod
     def coerce(cls, **data: Any) -> MutableMapping[str, Any]:
         """Create an instance from a dictionary."""
-        if "filters" in data:
-            # Non-insiders: transform back to default filters.
-            # Next: `if "filters" in data and not isinstance(data["filters"], str):`.
-            if data["filters"] == "public":
-                data["filters"] = _DEFAULT_FILTERS
+        if "filters" in data and not isinstance(data["filters"], str):
             # Filters are `None` or a sequence of strings (tests use tuples).
             data["filters"] = [
                 (re.compile(filtr.removeprefix("!")), filtr.startswith("!")) for filtr in data["filters"] or ()
@@ -1092,8 +1067,7 @@ class PythonOptions(PythonInputOptions):  # type: ignore[override,unused-ignore]
         return super().coerce(**data)
 
 
-# YORE: EOL 3.9: Replace `**_dataclass_options` with `frozen=True, kw_only=True` within line.
-@dataclass(**_dataclass_options)  # type: ignore[call-overload]
+@dataclass(frozen=True, kw_only=True)
 class Inventory:
     """An inventory."""
 
@@ -1126,8 +1100,7 @@ class Inventory:
         return {"base_url": self.base_url, "domains": self.domains}
 
 
-# YORE: EOL 3.9: Replace `**_dataclass_options` with `frozen=True, kw_only=True` within line.
-@dataclass(**_dataclass_options)  # type: ignore[call-overload]
+@dataclass(frozen=True, kw_only=True)
 class PythonInputConfig:
     """Python handler configuration."""
 
@@ -1169,8 +1142,7 @@ class PythonInputConfig:
         return cls(**cls.coerce(**data))
 
 
-# YORE: EOL 3.9: Replace `**_dataclass_options` with `frozen=True, kw_only=True` within line.
-@dataclass(**_dataclass_options)  # type: ignore[call-overload]
+@dataclass(frozen=True, kw_only=True)
 class PythonConfig(PythonInputConfig):  # type: ignore[override,unused-ignore]
     """Python handler configuration."""
 

mkdocstrings_handlers/python/_internal/debug.py

@@ -85,7 +85,7 @@ def _get_debug_info() -> _Environment:
         interpreter_version=py_version,
         interpreter_path=sys.executable,
         platform=platform.platform(),
-        variables=[_Variable(var, val) for var in variables if (val := os.getenv(var))],
+        variables=[_Variable(var, val) for var in variables if (val := os.getenv(var))],  # ty: ignore[invalid-argument-type]
         packages=[_Package(pkg, _get_version(pkg)) for pkg in packages],
     )
 

mkdocstrings_handlers/python/_internal/handler.py

@@ -10,7 +10,6 @@ from contextlib import suppress
 from dataclasses import asdict
 from pathlib import Path
 from typing import TYPE_CHECKING, Any, BinaryIO, ClassVar
-from warnings import warn
 
 from griffe import (
     AliasResolutionError,
@@ -22,15 +21,17 @@ from griffe import (
     patch_loggers,
 )
 from mkdocs.exceptions import PluginError
+from mkdocs_autorefs import BacklinkCrumb
 from mkdocstrings import BaseHandler, CollectionError, CollectorItem, HandlerOptions, Inventory, get_logger
 
 from mkdocstrings_handlers.python._internal import rendering
 from mkdocstrings_handlers.python._internal.config import PythonConfig, PythonOptions
 
 if TYPE_CHECKING:
-    from collections.abc import Iterator, Mapping, MutableMapping, Sequence
+    from collections.abc import Iterable, Iterator, Mapping, MutableMapping, Sequence
 
     from mkdocs.config.defaults import MkDocsConfig
+    from mkdocs_autorefs import Backlink
 
 
 # YORE: EOL 3.10: Replace block with line 2.
@@ -54,17 +55,6 @@ _logger = get_logger(__name__)
 patch_loggers(get_logger)
 
 
-# YORE: Bump 2: Remove block.
-def _warn_extra_options(names: Sequence[str]) -> None:
-    warn(
-        "Passing extra options directly under `options` is deprecated. "
-        "Instead, pass them under `options.extra`, and update your templates. "
-        f"Current extra (unrecognized) options: {', '.join(sorted(names))}",
-        DeprecationWarning,
-        stacklevel=3,
-    )
-
-
 class PythonHandler(BaseHandler):
     """The Python handler class."""
 
@@ -95,18 +85,9 @@ class PythonHandler(BaseHandler):
         self.base_dir = base_dir
         """The base directory of the project."""
 
-        # YORE: Bump 2: Remove block.
-        global_extra, global_options = PythonOptions._extract_extra(config.options)
-        if global_extra:
-            _warn_extra_options(global_extra.keys())  # type: ignore[arg-type]
-        self._global_extra = global_extra
-        self.global_options = global_options
+        self.global_options = config.options
         """The global configuration options (in `mkdocs.yml`)."""
 
-        # YORE: Bump 2: Replace `# ` with `` within block.
-        # self.global_options = config.options
-        # """The global configuration options (in `mkdocs.yml`)."""
-
         # Warn if user overrides base templates.
         if self.custom_templates:
             for theme_dir in base_dir.joinpath(self.custom_templates, "python").iterdir():
@@ -186,25 +167,13 @@ class PythonHandler(BaseHandler):
         Returns:
             The combined options.
         """
-        # YORE: Bump 2: Remove block.
-        local_extra, local_options = PythonOptions._extract_extra(local_options)  # type: ignore[arg-type]
-        if local_extra:
-            _warn_extra_options(local_extra.keys())  # type: ignore[arg-type]
-        unknown_extra = self._global_extra | local_extra
-
         extra = {**self.global_options.get("extra", {}), **local_options.get("extra", {})}
         options = {**self.global_options, **local_options, "extra": extra}
         try:
-            # YORE: Bump 2: Replace `opts =` with `return` within line.
-            opts = PythonOptions.from_data(**options)
+            return PythonOptions.from_data(**options)
         except Exception as error:
             raise PluginError(f"Invalid options: {error}") from error
 
-        # YORE: Bump 2: Remove block.
-        for key, value in unknown_extra.items():
-            object.__setattr__(opts, key, value)
-        return opts
-
     def collect(self, identifier: str, options: PythonOptions) -> CollectorItem:
         """Collect the documentation for the given identifier.
 
@@ -289,7 +258,7 @@ class PythonHandler(BaseHandler):
         Returns:
             The rendered data (HTML).
         """
-        template_name = rendering.do_get_template(self.env, data)
+        template_name = rendering.do_get_template(data)
         template = self.env.get_template(template_name)
 
         return template.render(
@@ -301,11 +270,28 @@ class PythonHandler(BaseHandler):
                 # than as an item in a dictionary.
                 "heading_level": options.heading_level,
                 "root": True,
-                # YORE: Bump 2: Regex-replace ` or .+` with ` or "en",` within line.
-                "locale": locale or self.config.locale,
+                "locale": locale or "en",
             },
         )
 
+    def render_backlinks(self, backlinks: Mapping[str, Iterable[Backlink]], *, locale: str | None = None) -> str:  # noqa: ARG002
+        """Render the backlinks.
+
+        Parameters:
+            backlinks: The backlinks to render.
+
+        Returns:
+            The rendered backlinks (HTML).
+        """
+        template = self.env.get_template("backlinks.html.jinja")
+        verbose_type = {key: key.capitalize().replace("-by", " by") for key in backlinks.keys()}  # noqa: SIM118
+        return template.render(
+            backlinks=backlinks,
+            config=self.get_options({}),
+            verbose_type=verbose_type,
+            default_crumb=BacklinkCrumb(title="", url=""),
+        )
+
     def update_env(self, config: Any) -> None:  # noqa: ARG002
         """Update the Jinja environment with custom filters and tests.
 
@@ -316,8 +302,6 @@ class PythonHandler(BaseHandler):
         self.env.lstrip_blocks = True
         self.env.keep_trailing_newline = False
         self.env.filters["split_path"] = rendering.do_split_path
-        self.env.filters["crossref"] = rendering.do_crossref
-        self.env.filters["multi_crossref"] = rendering.do_multi_crossref
         self.env.filters["order_members"] = rendering.do_order_members
         self.env.filters["format_code"] = rendering.do_format_code
         self.env.filters["format_signature"] = rendering.do_format_signature
@@ -414,10 +398,7 @@ def get_handler(
     # We therefore increase the limit here, once, before Griffe is used to collect or render stuff.
     sys.setrecursionlimit(max(sys.getrecursionlimit(), 2000))
 
-    base_dir = Path(tool_config.config_file_path or "./mkdocs.yml").parent
-    if "inventories" not in handler_config and "import" in handler_config:
-        warn("The 'import' key is renamed 'inventories' for the Python handler", FutureWarning, stacklevel=1)
-        handler_config["inventories"] = handler_config.pop("import", [])
+    base_dir = Path(getattr(tool_config, "config_file_path", None) or "./mkdocs.yml").parent
     return PythonHandler(
         config=PythonConfig.from_data(**handler_config),
         base_dir=base_dir,

mkdocstrings_handlers/python/_internal/rendering.py

@@ -7,13 +7,11 @@ import re
 import string
 import subprocess
 import sys
-import warnings
 from collections import defaultdict
 from contextlib import suppress
 from dataclasses import replace
 from functools import lru_cache
-from pathlib import Path
-from re import Match, Pattern
+from re import Pattern
 from typing import TYPE_CHECKING, Any, Callable, ClassVar, Literal, TypeVar
 
 from griffe import (
@@ -33,7 +31,7 @@ from griffe import (
     Object,
     TypeAlias,
 )
-from jinja2 import TemplateNotFound, pass_context, pass_environment
+from jinja2 import pass_context
 from markupsafe import Markup
 from mkdocs_autorefs import AutorefsHookInterface, Backlink, BacklinkCrumb
 from mkdocstrings import get_logger
@@ -42,7 +40,6 @@ if TYPE_CHECKING:
     from collections.abc import Iterable, Iterator, Sequence
 
     from griffe import Attribute, Class, Function, Module
-    from jinja2 import Environment
     from jinja2.runtime import Context
     from mkdocstrings import CollectorItem
 
@@ -62,8 +59,15 @@ def _sort_key_source(item: CollectorItem) -> float:
     return item.lineno if item.lineno is not None else float("inf")
 
 
-def _sort__all__(item: CollectorItem) -> float:  # noqa: ARG001
-    raise ValueError("Not implemented in public version of mkdocstrings-python")
+def _sort__all__(item: CollectorItem) -> float:
+    if item.parent.exports is not None:
+        try:
+            return item.parent.exports.index(item.name)
+        except ValueError:
+            # If the item is not in `__all__`, it will go to the end of the list.
+            return float("inf")
+    # No exports declared, refuse to sort (try other methods or return members as they are).
+    raise ValueError(f"Parent object {item.parent.path} doesn't declare exports")
 
 
 Order = Literal["__all__", "alphabetical", "source"]
@@ -163,10 +167,8 @@ def do_format_signature(
         The same code, formatted.
     """
     env = context.environment
-    # YORE: Bump 2: Replace `do_get_template(env, "type_parameters")` with `"type_parameters.html.jinja"` within line.
-    type_params_template = env.get_template(do_get_template(env, "type_parameters"))
-    # YORE: Bump 2: Replace `do_get_template(env, "signature")` with `"signature.html.jinja"` within line.
-    signature_template = env.get_template(do_get_template(env, "signature"))
+    type_params_template = env.get_template("type_parameters.html.jinja")
+    signature_template = env.get_template("signature.html.jinja")
 
     if annotations is None:
         new_context = context.parent
@@ -230,8 +232,7 @@ def do_format_attribute(
         The same code, formatted.
     """
     env = context.environment
-    # YORE: Bump 2: Replace `do_get_template(env, "expression")` with `"expression.html.jinja"` within line.
-    template = env.get_template(do_get_template(env, "expression"))
+    template = env.get_template("expression.html.jinja")
     annotations = context.parent["config"].show_signature_annotations
 
     signature = str(attribute_path).strip()
@@ -288,10 +289,8 @@ def do_format_type_alias(
         The same code, formatted.
     """
     env = context.environment
-    # YORE: Bump 2: Replace `do_get_template(env, "type_parameters")` with `"type_parameters.html.jinja"` within line.
-    type_params_template = env.get_template(do_get_template(env, "type_parameters"))
-    # YORE: Bump 2: Replace `do_get_template(env, "expression")` with `"expression.html.jinja"` within line.
-    expr_template = env.get_template(do_get_template(env, "expression"))
+    type_params_template = env.get_template("type_parameters.html.jinja")
+    expr_template = env.get_template("expression.html.jinja")
 
     signature = str(type_alias_path).strip()
     signature += type_params_template.render(context.parent, obj=type_alias, signature=True)
@@ -357,76 +356,6 @@ def do_order_members(
     return members
 
 
-# YORE: Bump 2: Remove block.
-@lru_cache
-def _warn_crossref() -> None:
-    warnings.warn(
-        "The `crossref` filter is deprecated and will be removed in a future version",
-        DeprecationWarning,
-        stacklevel=1,
-    )
-
-
-# YORE: Bump 2: Remove block.
-def do_crossref(path: str, *, brief: bool = True) -> Markup:
-    """Deprecated. Filter to create cross-references.
-
-    Parameters:
-        path: The path to link to.
-        brief: Show only the last part of the path, add full path as hover.
-
-    Returns:
-        Markup text.
-    """
-    _warn_crossref()
-    full_path = path
-    if brief:
-        path = full_path.split(".")[-1]
-    return Markup("<autoref identifier={full_path} optional hover>{path}</autoref>").format(
-        full_path=full_path,
-        path=path,
-    )
-
-
-# YORE: Bump 2: Remove block.
-@lru_cache
-def _warn_multi_crossref() -> None:
-    warnings.warn(
-        "The `multi_crossref` filter is deprecated and will be removed in a future version",
-        DeprecationWarning,
-        stacklevel=1,
-    )
-
-
-# YORE: Bump 2: Remove block.
-def do_multi_crossref(text: str, *, code: bool = True) -> Markup:
-    """Deprecated. Filter to create cross-references.
-
-    Parameters:
-        text: The text to scan.
-        code: Whether to wrap the result in a code tag.
-
-    Returns:
-        Markup text.
-    """
-    _warn_multi_crossref()
-    group_number = 0
-    variables = {}
-
-    def repl(match: Match) -> str:
-        nonlocal group_number
-        group_number += 1
-        path = match.group()
-        path_var = f"path{group_number}"
-        variables[path_var] = path
-        return f"<autoref identifier={{{path_var}}} optional hover>{{{path_var}}}</autoref>"
-
-    text = re.sub(r"([\w.]+)", repl, text)
-    if code:
-        text = f"<code>{text}</code>"
-    return Markup(text).format(**variables)  # noqa: S704
-
-
 _split_path_re = re.compile(r"([.(]?)([\w]+)(\))?")
 _splitable_re = re.compile(r"[().]")
 
@@ -641,39 +570,20 @@ def _get_black_formatter() -> Callable[[str, int], str] | None:
     return formatter
 
 
-# YORE: Bump 2: Remove line.
-@pass_environment
-# YORE: Bump 2: Replace `env: Environment, ` with `` within line.
-# YORE: Bump 2: Replace `str | ` with `` within line.
-def do_get_template(env: Environment, obj: str | Object) -> str:
+def do_get_template(obj: Object | Alias) -> str:
     """Get the template name used to render an object.
 
     Parameters:
-        env: The Jinja environment, passed automatically.
-        obj: A Griffe object, or a template name.
+        obj: A Griffe object.
 
     Returns:
         A template name.
     """
-    name = obj
-    if isinstance(obj, (Alias, Object)):
-        extra_data = getattr(obj, "extra", {}).get("mkdocstrings", {})
-        if name := extra_data.get("template", ""):
-            return name
-        name = obj.kind.value.replace(" ", "_")
-    # YORE: Bump 2: Replace block with `return f"{name}.html.jinja"`.
-    try:
-        template = env.get_template(f"{name}.html")
-    except TemplateNotFound:
-        return f"{name}.html.jinja"
-    our_template = Path(template.filename).is_relative_to(Path(__file__).parent.parent)  # type: ignore[arg-type]
-    if our_template:
-        return f"{name}.html.jinja"
-    _logger.warning(
-        f"DeprecationWarning: Overriding '{name}.html' is deprecated, override '{name}.html.jinja' instead. ",
-        once=True,
-    )
-    return f"{name}.html"
+    extra_data = getattr(obj, "extra", {}).get("mkdocstrings", {})
+    if name := extra_data.get("template", ""):
+        return name
+    name = obj.kind.value.replace(" ", "_")
+    return f"{name}.html.jinja"
 
 
 @pass_context
@@ -856,6 +766,33 @@ class AutorefsHook(AutorefsHookInterface):
         Returns:
             The expanded identifier.
         """
+        # Handle leading dots in the identifier:
+        # - `.name` is a reference to the current object's `name` member.
+        # - `..name` is a reference to the parent object's `name` member.
+        # - etc.
+        # TODO: We should update the protocol to allow modifying the title too.
+        # In this case it would likely be better to strip dots from the title,
+        # when it's not explicitly specified.
+        if self.config.relative_crossrefs and identifier.startswith("."):  # type: ignore[attr-defined]
+            identifier = identifier[1:]
+            obj = self.current_object
+            while identifier and identifier[0] == ".":
+                identifier = identifier[1:]
+                obj = obj.parent  # type: ignore[assignment]
+            identifier = f"{obj.path}.{identifier}" if identifier else obj.path
+
+        # We resolve the identifier to its full path.
+        # For this we take out the first name, resolve it, and then append the rest.
+        if self.config.scoped_crossrefs:  # type: ignore[attr-defined]
+            if "." in identifier:
+                identifier, remaining = identifier.split(".", 1)
+            else:
+                remaining = ""
+            with suppress(Exception):
+                identifier = self.current_object.resolve(identifier)
+            if remaining:
+                identifier = f"{identifier}.{remaining}"
+
         return identifier
 
     def get_context(self) -> AutorefsHookInterface.Context:

mkdocstrings_handlers/python/templates/material/_base/attribute.html.jinja

@@ -67,8 +67,7 @@ Context:
           This block renders the labels for the attribute.
           -#}
           {% with labels = attribute.labels %}
-            {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-            {% include "labels"|get_template with context %}
+            {% include "labels.html.jinja" with context %}
           {% endwith %}
         {% endblock labels %}
 
@@ -115,8 +114,7 @@ Context:
           This block renders the docstring for the attribute.
           -#}
           {% with docstring_sections = attribute.docstring.parsed %}
-            {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-            {% include "docstring"|get_template with context %}
+            {% include "docstring.html.jinja" with context %}
           {% endwith %}
         {% endblock docstring %}
 

mkdocstrings_handlers/python/templates/material/_base/backlinks.html.jinja

@@ -15,3 +15,52 @@ Context:
   This block can be used to log debug messages, deprecation messages, warnings, etc.
   -#}
 {% endblock logs %}
+
+{% macro render_crumb(crumb, last=false) %}
+  <span class="doc doc-backlink-crumb{{ " last" if last else "" }}">
+    {% if crumb.url and crumb.title %}
+      <a href="{{ crumb.url }}">{{ crumb.title | safe }}</a>
+    {% elif crumb.title %}
+      <span>{{ crumb.title | safe }}</span>
+    {% endif %}
+  </span>
+{% endmacro %}
+
+{% macro render_tree(tree) %}
+  <ul class="doc doc-backlink-list">
+    {% for node, child in tree | dictsort %}
+      <li class="doc doc-backlink">
+        {% for crumb in node %}
+          {{ render_crumb(crumb, last=loop.last and not child) }}
+        {% endfor %}
+        {% if child %}
+          {{ render_tree(child) }}
+        {% endif %}
+      </li>
+    {% endfor %}
+  </ul>
+{% endmacro %}
+
+{% if config.backlinks %}
+  <div class="doc doc-backlinks">
+    {% if config.backlinks == "tree" %}
+      {% for backlink_type, backlink_list in backlinks | dictsort %}
+        <b class="doc doc-backlink-type">{{ verbose_type[backlink_type] }}:</b>
+        {{ render_tree(backlink_list|backlink_tree) }}
+      {% endfor %}
+    {% elif config.backlinks == "flat" %}
+      {% for backlink_type, backlink_list in backlinks | dictsort %}
+        <b class="doc doc-backlink-type">{{ verbose_type[backlink_type] }}:</b>
+        <ul class="doc doc-backlink-list">
+          {% for backlink in backlink_list | sort(attribute="crumbs") %}
+            <li class="doc doc-backlink">
+              {% for crumb in backlink.crumbs %}
+                {{ render_crumb(crumb, last=loop.last) }}
+              {% endfor %}
+            </li>
+          {% endfor %}
+        </ul>
+      {% endfor %}
+    {% endif %}
+  </div>
+{% endif %}