mkdocstrings-python 2.0.9__tar.gz → 2.0.11__tar.gz

{mkdocstrings_python-2.0.9 → mkdocstrings_python-2.0.11}/CHANGELOG.md

@@ -5,6 +5,27 @@ 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 -->
+## [2.0.11](https://github.com/mkdocstrings/python/releases/tag/2.0.11) - 2026-11-12
+
+<small>[Compare with 2.0.10](https://github.com/mkdocstrings/python/compare/2.0.10...2.0.11)</small>
+
+### Bug Fixes
+
+- Add missing closing parenthesis around type parameter type ([ecfd54d](https://github.com/mkdocstrings/python/commit/ecfd54d4a7530fbed1f53ac023c37ae7d247b9db) by Timothée Mazzucotelli). [Issue-349](https://github.com/mkdocstrings/python/issues/349)
+- Use Griffe's `reference_path` to avoid cross-referencing irrelevant headings ([1f0fa78](https://github.com/mkdocstrings/python/commit/1f0fa78282c03cbbf10d170cc6bd96979bc29c9e) by Timothée Mazzucotelli). [Issue-347](https://github.com/mkdocstrings/python/issues/347)
+
+## [2.0.10](https://github.com/mkdocstrings/python/releases/tag/2.0.10) - 2026-10-19
+
+<small>[Compare with 2.0.9](https://github.com/mkdocstrings/python/compare/2.0.9...2.0.10)</small>
+
+### Build
+
+- Drop support for Python 3.10 ([aad7fc6](https://github.com/mkdocstrings/python/commit/aad7fc6efd12f096807b466e5e3175e27fa7852d) by Timothée Mazzucotelli).
+
+### Bug Fixes
+
+- Prefix code anchor/span IDs in signatures to avoid collisions ([35cde4c](https://github.com/mkdocstrings/python/commit/35cde4c1163d2d8a8fd79b34ab574888bfd30ddf) by Timothée Mazzucotelli). [Issue-200](https://github.com/mkdocstrings/python/issues/200)
+
 ## [2.0.9](https://github.com/mkdocstrings/python/releases/tag/2.0.9) - 2026-09-22
 
 <small>[Compare with 2.0.8](https://github.com/mkdocstrings/python/compare/2.0.8...2.0.9)</small>

{mkdocstrings_python-2.0.9 → mkdocstrings_python-2.0.11}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-python
-Version: 2.0.9
+Version: 2.0.11
 Summary: A Python handler for mkdocstrings.
-Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
+Author-Email: Timothée Mazzucotelli <dev@pawamoy.fr>
 License-Expression: ISC
 License-File: LICENSE
 Classifier: Development Status :: 4 - Beta
@@ -10,7 +10,6 @@ Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
@@ -28,10 +27,10 @@ Project-URL: Issues, https://github.com/mkdocstrings/python/issues
 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.10
-Requires-Dist: mkdocstrings>=0.30
+Requires-Python: >=3.11
+Requires-Dist: mkdocstrings>=1.0.8
 Requires-Dist: mkdocs-autorefs>=1.4
-Requires-Dist: griffelib>=2.0
+Requires-Dist: griffelib>=2.4
 Requires-Dist: typing-extensions>=4.0; python_version < "3.11"
 Description-Content-Type: text/markdown
 
@@ -121,10 +120,6 @@ dependencies = [
 
 <div id="premium-sponsors" style="text-align: center;">
 
-<div id="silver-sponsors"><b>Silver sponsors</b><p>
-<a href="https://fastapi.tiangolo.com/"><img alt="FastAPI" src="https://raw.githubusercontent.com/tiangolo/fastapi/master/docs/en/docs/img/logo-margin/logo-teal.png" style="height: 200px; "></a><br>
-</p></div>
-
 <div id="bronze-sponsors"><b>Bronze sponsors</b><p>
 <a href="https://www.nixtla.io/"><picture><source media="(prefers-color-scheme: light)" srcset="https://www.nixtla.io/img/logo/full-black.svg"><source media="(prefers-color-scheme: dark)" srcset="https://www.nixtla.io/img/logo/full-white.svg"><img alt="Nixtla" src="https://www.nixtla.io/img/logo/full-black.svg" style="height: 60px; "></picture></a><br>
 </p></div>
@@ -138,6 +133,7 @@ dependencies = [
 <a href="https://github.com/tlambert03"><img alt="tlambert03" src="https://avatars.githubusercontent.com/u/1609449?u=922abf0524b47739b37095e553c99488814b05db&v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/ssbarnea"><img alt="ssbarnea" src="https://avatars.githubusercontent.com/u/102495?u=c7bd9ddf127785286fc939dd18cb02db0a453bce&v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/femtomc"><img alt="femtomc" src="https://avatars.githubusercontent.com/u/34410036?u=f13a71daf2a9f0d2da189beaa94250daa629e2d8&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://fastapi.tiangolo.com/"><img alt="FastAPI" src="https://raw.githubusercontent.com/tiangolo/fastapi/master/docs/en/docs/img/logo-margin/logo-teal.png" style="height: 200px; "></a>
 <a href="https://github.com/cmarqu"><img alt="cmarqu" src="https://avatars.githubusercontent.com/u/360986?v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/kolenaIO"><img alt="kolenaIO" src="https://avatars.githubusercontent.com/u/77010818?v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/ramnes"><img alt="ramnes" src="https://avatars.githubusercontent.com/u/835072?u=3fca03c3ba0051e2eb652b1def2188a94d1e1dc2&v=4" style="height: 32px; border-radius: 100%;"></a>
@@ -156,7 +152,6 @@ dependencies = [
 <a href="https://github.com/15r10nk"><img alt="15r10nk" src="https://avatars.githubusercontent.com/u/44680962?u=f04826446ff165742efa81e314bd03bf1724d50e&v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/activeloopai"><img alt="activeloopai" src="https://avatars.githubusercontent.com/u/34816118?v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/roboflow"><img alt="roboflow" src="https://avatars.githubusercontent.com/u/53104118?v=4" style="height: 32px; border-radius: 100%;"></a>
-<a href="https://github.com/cmclaughlin"><img alt="cmclaughlin" src="https://avatars.githubusercontent.com/u/1061109?u=ddf6eec0edd2d11c980f8c3aa96e3d044d4e0468&v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/RapidataAI"><img alt="RapidataAI" src="https://avatars.githubusercontent.com/u/104209891?v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/rodolphebarbanneau"><img alt="rodolphebarbanneau" src="https://avatars.githubusercontent.com/u/46493454?u=6c405452a40c231cdf0b68e97544e07ee956a733&v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/theSymbolSyndicate"><img alt="theSymbolSyndicate" src="https://avatars.githubusercontent.com/u/111542255?v=4" style="height: 32px; border-radius: 100%;"></a>

{mkdocstrings_python-2.0.9 → mkdocstrings_python-2.0.11}/README.md

@@ -84,10 +84,6 @@ dependencies = [
 
 <div id="premium-sponsors" style="text-align: center;">
 
-<div id="silver-sponsors"><b>Silver sponsors</b><p>
-<a href="https://fastapi.tiangolo.com/"><img alt="FastAPI" src="https://raw.githubusercontent.com/tiangolo/fastapi/master/docs/en/docs/img/logo-margin/logo-teal.png" style="height: 200px; "></a><br>
-</p></div>
-
 <div id="bronze-sponsors"><b>Bronze sponsors</b><p>
 <a href="https://www.nixtla.io/"><picture><source media="(prefers-color-scheme: light)" srcset="https://www.nixtla.io/img/logo/full-black.svg"><source media="(prefers-color-scheme: dark)" srcset="https://www.nixtla.io/img/logo/full-white.svg"><img alt="Nixtla" src="https://www.nixtla.io/img/logo/full-black.svg" style="height: 60px; "></picture></a><br>
 </p></div>
@@ -101,6 +97,7 @@ dependencies = [
 <a href="https://github.com/tlambert03"><img alt="tlambert03" src="https://avatars.githubusercontent.com/u/1609449?u=922abf0524b47739b37095e553c99488814b05db&v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/ssbarnea"><img alt="ssbarnea" src="https://avatars.githubusercontent.com/u/102495?u=c7bd9ddf127785286fc939dd18cb02db0a453bce&v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/femtomc"><img alt="femtomc" src="https://avatars.githubusercontent.com/u/34410036?u=f13a71daf2a9f0d2da189beaa94250daa629e2d8&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://fastapi.tiangolo.com/"><img alt="FastAPI" src="https://raw.githubusercontent.com/tiangolo/fastapi/master/docs/en/docs/img/logo-margin/logo-teal.png" style="height: 200px; "></a>
 <a href="https://github.com/cmarqu"><img alt="cmarqu" src="https://avatars.githubusercontent.com/u/360986?v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/kolenaIO"><img alt="kolenaIO" src="https://avatars.githubusercontent.com/u/77010818?v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/ramnes"><img alt="ramnes" src="https://avatars.githubusercontent.com/u/835072?u=3fca03c3ba0051e2eb652b1def2188a94d1e1dc2&v=4" style="height: 32px; border-radius: 100%;"></a>
@@ -119,7 +116,6 @@ dependencies = [
 <a href="https://github.com/15r10nk"><img alt="15r10nk" src="https://avatars.githubusercontent.com/u/44680962?u=f04826446ff165742efa81e314bd03bf1724d50e&v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/activeloopai"><img alt="activeloopai" src="https://avatars.githubusercontent.com/u/34816118?v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/roboflow"><img alt="roboflow" src="https://avatars.githubusercontent.com/u/53104118?v=4" style="height: 32px; border-radius: 100%;"></a>
-<a href="https://github.com/cmclaughlin"><img alt="cmclaughlin" src="https://avatars.githubusercontent.com/u/1061109?u=ddf6eec0edd2d11c980f8c3aa96e3d044d4e0468&v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/RapidataAI"><img alt="RapidataAI" src="https://avatars.githubusercontent.com/u/104209891?v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/rodolphebarbanneau"><img alt="rodolphebarbanneau" src="https://avatars.githubusercontent.com/u/46493454?u=6c405452a40c231cdf0b68e97544e07ee956a733&v=4" style="height: 32px; border-radius: 100%;"></a>
 <a href="https://github.com/theSymbolSyndicate"><img alt="theSymbolSyndicate" src="https://avatars.githubusercontent.com/u/111542255?v=4" style="height: 32px; border-radius: 100%;"></a>

{mkdocstrings_python-2.0.9 → mkdocstrings_python-2.0.11}/docs/usage/configuration/general.md

@@ -247,6 +247,8 @@ Whether to force inspecting modules (importing them) even if their source code i
 
 This option is useful when you know that dynamic analysis (inspection) yields better results than static analysis. Do not use this blindly: the recommended approach is to write a Griffe extension that will improve extracted API data. See [How to selectively inspect objects](https://mkdocstrings.github.io/griffe/guide/users/how-to/selectively-inspect/).
 
+To document lazy module members, set `force_inspection: true` and ensure the module exposes their names through `__dir__` and their values through `__getattr__`. See [Lazy module members](https://mkdocstrings.github.io/griffe/guide/users/loading/#lazy-module-members) for an example.
+
 See also [`allow_inspection`](#allow_inspection).
 
 ```yaml title="in mkdocs.yml (global configuration)"

{mkdocstrings_python-2.0.9 → mkdocstrings_python-2.0.11}/pyproject.toml

@@ -15,7 +15,7 @@ license-files = [
     "LICENSE",
 ]
 readme = "README.md"
-requires-python = ">=3.10"
+requires-python = ">=3.11"
 keywords = []
 dynamic = []
 classifiers = [
@@ -24,7 +24,6 @@ classifiers = [
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3 :: Only",
-    "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
@@ -36,12 +35,12 @@ classifiers = [
     "Typing :: Typed",
 ]
 dependencies = [
-    "mkdocstrings>=0.30",
+    "mkdocstrings>=1.0.8",
     "mkdocs-autorefs>=1.4",
-    "griffelib>=2.0",
+    "griffelib>=2.4",
     "typing-extensions>=4.0; python_version < '3.11'",
 ]
-version = "2.0.9"
+version = "2.0.11"
 
 [project.urls]
 Homepage = "https://mkdocstrings.github.io/python"
@@ -130,5 +129,4 @@ docs = [
     "mkdocs-section-index>=0.3",
     "mkdocstrings>=0.29",
     "pydantic>=2.10",
-    "tomli>=2.0; python_version < '3.11'",
 ]

{mkdocstrings_python-2.0.9 → mkdocstrings_python-2.0.11}/scripts/gen_credits.py

@@ -3,7 +3,6 @@
 from __future__ import annotations
 
 import os
-import sys
 from collections import defaultdict
 from collections.abc import Iterable
 from importlib.metadata import distributions
@@ -12,16 +11,11 @@ from pathlib import Path
 from textwrap import dedent
 from typing import Union
 
+import tomllib
 from jinja2 import StrictUndefined
 from jinja2.sandbox import SandboxedEnvironment
 from packaging.requirements import Requirement
 
-# YORE: EOL 3.10: Replace block with line 2.
-if sys.version_info >= (3, 11):
-    import tomllib
-else:
-    import tomli as tomllib
-
 project_dir = Path(os.getenv("MKDOCS_CONFIG_DIR", "."))
 with project_dir.joinpath("pyproject.toml").open("rb") as pyproject_file:
     pyproject = tomllib.load(pyproject_file)

{mkdocstrings_python-2.0.9 → mkdocstrings_python-2.0.11}/scripts/make.py

@@ -14,7 +14,7 @@ if TYPE_CHECKING:
     from collections.abc import Iterator
 
 
-PYTHON_VERSIONS = os.getenv("PYTHON_VERSIONS", "3.10 3.11 3.12 3.13 3.14 3.15").split()
+PYTHON_VERSIONS = os.getenv("PYTHON_VERSIONS", "3.11 3.12 3.13 3.14 3.15").split()
 PYTHON_DEV = "3.15"
 
 

{mkdocstrings_python-2.0.9 → mkdocstrings_python-2.0.11}/src/mkdocstrings_handlers/python/_internal/config.py

@@ -3,21 +3,13 @@
 from __future__ import annotations
 
 import re
-import sys
 from dataclasses import field, fields
-from typing import TYPE_CHECKING, Annotated, Any, Literal
+from typing import TYPE_CHECKING, Annotated, Any, Literal, Self
 
 from mkdocstrings import get_logger
 
 from mkdocstrings_handlers.python._internal.rendering import Order  # noqa: TC001
 
-# YORE: EOL 3.10: Replace block with line 2.
-if sys.version_info >= (3, 11):
-    from typing import Self
-else:
-    from typing_extensions import Self
-
-
 _logger = get_logger(__name__)
 
 _DEFAULT_FILTERS = ["!^_[^_]"]

{mkdocstrings_python-2.0.9 → mkdocstrings_python-2.0.11}/src/mkdocstrings_handlers/python/_internal/handler.py

@@ -39,21 +39,7 @@ if TYPE_CHECKING:
     from mkdocs_autorefs import Backlink
 
 
-# YORE: EOL 3.10: Replace block with line 2.
-if sys.version_info >= (3, 11):
-    from contextlib import chdir
-else:
-    from contextlib import contextmanager
-
-    @contextmanager
-    def chdir(path: str) -> Iterator[None]:
-        old_wd = os.getcwd()
-        os.chdir(path)
-        try:
-            yield
-        finally:
-            os.chdir(old_wd)
-
+from contextlib import chdir
 
 _logger = get_logger(__name__)
 

{mkdocstrings_python-2.0.9 → mkdocstrings_python-2.0.11}/src/mkdocstrings_handlers/python/templates/material/_base/class.html.jinja

@@ -250,14 +250,14 @@ Context:
                 {% with init = all_members["__init__"] %}
                   <details class="mkdocstrings-source">
                     <summary>{{ lang.t("Source code in") }} <code>{{ init|source_location }}</code></summary>
-                    {{ init.source|highlight(language="python", linestart=init.lineno or 0, linenums=True) }}
+                    {{ init.source|highlight(language="python", linestart=init.lineno or 0, linenums=True, id_prefix=html_id ~ "--source--") }}
                   </details>
                 {% endwith %}
               {% endif %}
             {% elif class.source %}
               <details class="mkdocstrings-source">
                 <summary>{{ lang.t("Source code in") }} <code>{{ class|source_location }}</code></summary>
-                {{ class.source|highlight(language="python", linestart=class.lineno or 0, linenums=True) }}
+                {{ class.source|highlight(language="python", linestart=class.lineno or 0, linenums=True, id_prefix=html_id ~ "--source--") }}
               </details>
             {% endif %}
           {% endif %}

{mkdocstrings_python-2.0.9 → mkdocstrings_python-2.0.11}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/type_parameters.html.jinja

@@ -124,7 +124,7 @@ Context:
               <code>{% include "expression.html.jinja" with context %}</code>
             {%- endwith -%}
           {%- endif -%}
-          {%- if type_parameter.constraints or type_parameter.default -%}
+          {%- if type_parameter.bound or type_parameter.constraints or type_parameter.default -%}
             )
           {% endif -%}
           –

{mkdocstrings_python-2.0.9 → mkdocstrings_python-2.0.11}/src/mkdocstrings_handlers/python/templates/material/_base/expression.html.jinja

@@ -54,22 +54,27 @@ Context:
     {%- elif annotation_path == "full" -%}
       {%- set annotation = full -%}
     {%- endif -%}
-    {%- for prefix, title, path, suffix in annotation|split_path(full) -%}
-      {{ prefix }}
-      {%- if not signature -%}
-        {#- Always render cross-references outside of signatures. We don't need to stash them. -#}
-        <autoref identifier="{{ path }}"{% if backlink_type %} backlink-type="{{ backlink_type }}" backlink-anchor="{{ html_id }}"{% endif %} optional{% if title != path %} hover{% endif %}>{{ title }}</autoref>
-      {%- elif config.signature_crossrefs -%}
-        {#- We're in a signature and cross-references are enabled, we must render one and stash it. -#}
-        {%- filter stash_crossref(length=title|length) -%}
+    {%- if name.reference_path is none -%}
+      {#- Unresolved names can match unrelated headings, so render them as plain text. -#}
+      {{ annotation }}
+    {%- else -%}
+      {%- for prefix, title, path, suffix in annotation|split_path(name.reference_path) -%}
+        {{ prefix }}
+        {%- if not signature -%}
+          {#- Always render cross-references outside of signatures. We don't need to stash them. -#}
           <autoref identifier="{{ path }}"{% if backlink_type %} backlink-type="{{ backlink_type }}" backlink-anchor="{{ html_id }}"{% endif %} optional{% if title != path %} hover{% endif %}>{{ title }}</autoref>
-        {%- endfilter -%}
-      {%- else -%}
-        {#- We're in a signature but cross-references are disabled, we just render the title. -#}
-        {{ title }}
-      {%- endif -%}
-      {{ suffix }}
-    {%- endfor -%}
+        {%- elif config.signature_crossrefs -%}
+          {#- We're in a signature and cross-references are enabled, we must render one and stash it. -#}
+          {%- filter stash_crossref(length=title|length) -%}
+            <autoref identifier="{{ path }}"{% if backlink_type %} backlink-type="{{ backlink_type }}" backlink-anchor="{{ html_id }}"{% endif %} optional{% if title != path %} hover{% endif %}>{{ title }}</autoref>
+          {%- endfilter -%}
+        {%- else -%}
+          {#- We're in a signature but cross-references are disabled, we just render the title. -#}
+          {{ title }}
+        {%- endif -%}
+        {{ suffix }}
+      {%- endfor -%}
+    {%- endif -%}
   {%- endwith -%}
 {%- endmacro -%}
 
@@ -82,11 +87,13 @@ Context:
   Returns:
       The autorefs cross-reference, or the type parameter name.
   -#}
-  {%- if not signature -%}
-    <autoref identifier="{{ name.canonical_path }}" optional{% if name.name not in obj.type_parameters %} hover{% endif %}>{{ name.name }}</autoref>
+  {%- if name.reference_path is none -%}
+    {{ name.name }}
+  {%- elif not signature -%}
+    <autoref identifier="{{ name.reference_path }}" optional{% if name.name not in obj.type_parameters %} hover{% endif %}>{{ name.name }}</autoref>
   {%- elif config.signature_crossrefs -%}
     {%- filter stash_crossref(length=name.name|length) -%}
-      <autoref identifier="{{ name.canonical_path }}" optional{% if name.name not in obj.type_parameters %} hover{% endif %}>{{ name.name }}</autoref>
+      <autoref identifier="{{ name.reference_path }}" optional{% if name.name not in obj.type_parameters %} hover{% endif %}>{{ name.name }}</autoref>
     {%- endfilter -%}
   {%- else -%}
     {{ name.name }}
@@ -102,13 +109,13 @@ Context:
   Returns:
       The autorefs cross-reference, or the parameter name.
   -#}
-  {%- if config.signature_crossrefs -%}
+  {%- if config.signature_crossrefs and expression.reference_path is not none -%}
     {%- if signature -%}
       {%- filter stash_crossref(length=expression.name|length) -%}
-        <autoref identifier="{{ expression.canonical_path }}" optional hover>{{ expression.name }}</autoref>
+        <autoref identifier="{{ expression.reference_path }}" optional hover>{{ expression.name }}</autoref>
       {%- endfilter -%}
     {%- else -%}
-      <autoref identifier="{{ expression.canonical_path }}" optional hover>{{ expression.name }}</autoref>
+      <autoref identifier="{{ expression.reference_path }}" optional hover>{{ expression.name }}</autoref>
     {%- endif -%}
   {%- else -%}
     {{ expression.name }}

{mkdocstrings_python-2.0.9 → mkdocstrings_python-2.0.11}/src/mkdocstrings_handlers/python/templates/material/_base/function.html.jinja

@@ -149,7 +149,7 @@ Context:
           {% if config.show_source and function.source %}
             <details class="mkdocstrings-source">
               <summary>{{ lang.t("Source code in") }} <code>{{ function|source_location }}</code></summary>
-              {{ function.source|highlight(language="python", linestart=function.lineno or 0, linenums=True) }}
+              {{ function.source|highlight(language="python", linestart=function.lineno or 0, linenums=True, id_prefix=html_id ~ "--source--") }}
             </details>
           {% endif %}
         {% endblock source %}

{mkdocstrings_python-2.0.9 → mkdocstrings_python-2.0.11}/src/mkdocstrings_handlers/python/templates/readthedocs/_base/class.html.jinja

@@ -209,14 +209,14 @@ Context:
                 {% with init = class.all_members["__init__"] %}
                   <details class="quote">
                     <summary>Source code in <code>{{ init|source_location }}</code></summary>
-                    {{ init.source|highlight(language="python", linestart=init.lineno or 0, linenums=True) }}
+                    {{ init.source|highlight(language="python", linestart=init.lineno or 0, linenums=True, id_prefix=html_id ~ "--source--") }}
                   </details>
                 {% endwith %}
               {% endif %}
             {% elif class.source %}
               <details class="quote">
                 <summary>Source code in <code>{{ class|source_location }}</code></summary>
-                {{ class.source|highlight(language="python", linestart=class.lineno or 0, linenums=True) }}
+                {{ class.source|highlight(language="python", linestart=class.lineno or 0, linenums=True, id_prefix=html_id ~ "--source--") }}
               </details>
             {% endif %}
           {% endif %}

{mkdocstrings_python-2.0.9 → mkdocstrings_python-2.0.11}/tests/test_handler.py

@@ -21,6 +21,7 @@ from griffe import (
     DocstringSectionKind,
     Module,
     temporary_inspected_module,
+    temporary_pypackage,
     temporary_visited_module,
 )
 from mkdocstrings import CollectionError
@@ -28,6 +29,7 @@ from mkdocstrings import CollectionError
 from mkdocstrings_handlers.python import Inventory, PythonConfig, PythonHandler, PythonOptions
 
 if TYPE_CHECKING:
+    from markdown import Markdown
     from mkdocstrings import MkdocstringsPlugin
 
 
@@ -204,6 +206,203 @@ def test_rendering_object_source_without_lineno(handler: PythonHandler) -> None:
         assert handler.render(module, PythonOptions(show_source=True))
 
 
+@pytest.mark.parametrize("annotations_path", ["brief", "source", "full"])
+@pytest.mark.parametrize(
+    ("code", "expected_text", "expected_targets"),
+    [
+        ("value = intro", "intro", []),
+        ("value = intro.attr", "intro.attr", []),
+        ("value = intro(keyword=1)", "intro(keyword=1)", []),
+        ("value = int", "int", ["int"]),
+        ("from pathlib import Path\nvalue = Path", None, ["pathlib.Path"]),
+        ("def factory(keyword): ...\nvalue = factory(keyword=1)", None, ["module.factory", "module.factory(keyword)"]),
+    ],
+)
+def test_expression_crossrefs(
+    handler: PythonHandler,
+    annotations_path: str,
+    code: str,
+    expected_text: str | None,
+    expected_targets: list[str],
+) -> None:
+    """Cross-reference resolved names and builtins while leaving unknown names as text."""
+    with temporary_visited_module(code) as module:
+        template = handler.env.get_template("expression.html.jinja")
+
+        html = template.render(
+            expression=module["value"].value,
+            config=handler.get_options({"annotations_path": annotations_path, "signature_crossrefs": True}),
+        )
+
+    soup = bs4.BeautifulSoup(html, "html.parser")
+    targets = [ref["identifier"] for ref in soup.find_all("autoref")]
+
+    # Full paths can also link their prefixes, but unknown names must have no targets.
+    assert all(target in targets for target in expected_targets)
+    if not expected_targets:
+        assert not targets
+    if expected_text is not None:
+        if annotations_path == "brief":
+            expected_text = expected_text.rsplit(".", 1)[-1]
+        assert soup.get_text() == expected_text
+
+
+@pytest.mark.parametrize("signature_crossrefs", [True, False])
+def test_instance_attribute_local_value_crossref(handler: PythonHandler, signature_crossrefs: bool) -> None:
+    """Keep a local variable's name visible without linking it to an unrelated heading."""
+    code = """
+        class Class:
+            def __init__(self):
+                intro = "Some text"
+                self.attr: str = intro
+    """
+    with temporary_visited_module(code) as module:
+        options = handler.get_options(
+            {
+                "separate_signature": True,
+                "signature_crossrefs": signature_crossrefs,
+                "show_signature_annotations": True,
+                "show_root_heading": True,
+                "show_source": False,
+            },
+        )
+
+        html = handler.render(module["Class.attr"], options)
+
+    soup = bs4.BeautifulSoup(html, "html.parser")
+    signature = soup.select_one(".doc-signature")
+    assert signature is not None
+    assert signature.get_text(strip=True) == "attr:str=intro"
+
+    # The builtin annotation can link; the unresolved local value cannot.
+    targets = [ref["identifier"] for ref in signature.find_all("autoref")]
+    assert targets == (["str"] if signature_crossrefs else [])
+
+
+@pytest.mark.parametrize(
+    ("handler", "merge_init_into_class"),
+    [
+        (
+            {
+                "theme": theme,
+                "markdown_extensions": [
+                    {
+                        "pymdownx.highlight": {
+                            "anchor_linenums": True,
+                            "line_spans": "custom-span",
+                            "line_anchors": "custom-line",
+                            "linenums_style": linenums_style,
+                        },
+                    },
+                    {"pymdownx.superfences": {}},
+                ],
+            },
+            merge_init_into_class,
+        )
+        for theme in ("material", "readthedocs", "mkdocs")
+        for linenums_style in ("table", "inline")
+        for merge_init_into_class in (True, False)
+    ],
+    indirect=["handler"],
+)
+def test_source_code_ids_are_unique(
+    handler: PythonHandler,
+    ext_markdown: Markdown,
+    merge_init_into_class: bool,
+) -> None:
+    """Keep source line IDs unique across modules, overlapping sources, and inherited methods."""
+    # Both modules put their source at the same line numbers. Class source also overlaps method source.
+    code = '''
+        class Base:
+            """Base class."""
+
+            def __init__(self):
+                """Initialize the base class."""
+                self.value = 1
+
+            def method(self):
+                """Return a value."""
+                return self.value
+
+        class Derived(Base):
+            """Derived class."""
+    '''
+    markdown = f"""
+::: source_ids.first
+    options:
+      show_source: true
+      inherited_members: true
+      merge_init_into_class: {str(merge_init_into_class).lower()}
+
+::: source_ids.second
+    options:
+      show_source: true
+      inherited_members: true
+      merge_init_into_class: {str(merge_init_into_class).lower()}
+"""
+    with temporary_pypackage("source_ids", {"first.py": code, "second.py": code}) as package:
+        handler._paths = [str(package.tmpdir)]
+
+        html = ext_markdown.convert(markdown)
+
+    soup = bs4.BeautifulSoup(html, "html.parser")
+    source_blocks = soup.select("details.mkdocstrings-source, details.quote")
+    assert len(source_blocks) == (8 if merge_init_into_class else 12)
+
+    # Every source ID is unique, including methods repeated under Derived.
+    ids = [element["id"] for block in source_blocks for element in block.select("[id]")]
+    assert ids
+    assert len(ids) == len(set(ids))
+    assert all(
+        str(identifier).startswith("source_ids.") and "--source--custom-" in str(identifier) for identifier in ids
+    )
+
+    # Line-number links and legacy anchor names still point to IDs in their own source block.
+    for block in source_blocks:
+        block_ids = {element["id"] for element in block.select("[id]")}
+        links = block.select('a[href^="#"]')
+        assert links
+        assert all(str(link["href"])[1:] in block_ids for link in links)
+        assert all(anchor["name"] == anchor["id"] for anchor in block.select("a[name]"))
+
+
+@pytest.mark.parametrize(
+    "handler",
+    [
+        {
+            "markdown_extensions": [
+                {"pymdownx.highlight": {"anchor_linenums": True, "line_spans": "__span"}},
+                {"pymdownx.superfences": {}},
+            ],
+        },
+    ],
+    indirect=True,
+)
+def test_source_and_docstring_code_ids_do_not_collide(handler: PythonHandler) -> None:
+    """Keep source and docstring code IDs distinct."""
+    # Both the function's source and the fenced example start at line 1.
+    code = '''def function():
+    """An example.
+
+    ```python linenums="1"
+    print("example")
+    ```
+    """
+    return 1
+'''
+    with temporary_visited_module(code, module_name="code_ids") as module:
+        html = handler.render(module["function"], handler.get_options({"show_source": True}))
+
+    soup = bs4.BeautifulSoup(html, "html.parser")
+    ids = [element["id"] for element in soup.select("[id]")]
+
+    assert len(ids) == len(set(ids))
+    assert "code_ids.function--__span-0-1" in ids
+    assert "code_ids.function--source--__span-0-1" in ids
+    assert "code_ids.function--__codelineno-0-1" in ids
+    assert "code_ids.function--source--__codelineno-0-1" in ids
+
+
 def test_give_precedence_to_user_paths() -> None:
     """Assert user paths take precedence over default paths."""
     last_sys_path = sys.path[-1]