mkdocstrings-python 1.16.9__tar.gz → 1.16.11__tar.gz

{mkdocstrings_python-1.16.9 → mkdocstrings_python-1.16.11}/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.16.11](https://github.com/mkdocstrings/python/releases/tag/1.16.11) - 2025-05-24
+
+<small>[Compare with 1.16.10](https://github.com/mkdocstrings/python/compare/1.16.10...1.16.11)</small>
+
+### Bug Fixes
+
+- Fix highlighting for signature with known special names like `__init__` ([7f95686](https://github.com/mkdocstrings/python/commit/7f956868f93a766346455fedb296c26787894d5c) by Timothée Mazzucotelli). [Issue-mkdocstrings-757](https://github.com/mkdocstrings/mkdocstrings/issues/757)
+- Use default font-size for parameter headings ([0a35b20](https://github.com/mkdocstrings/python/commit/0a35b20a6050a28ba8492d93e5f9940a69462ce3) by Timothée Mazzucotelli). [Issue-mkdocstrings-697](https://github.com/mkdocstrings/mkdocstrings/issues/697)
+- Prevent uppercasing H5 titles (by Material for MkDocs) ([ba66969](https://github.com/mkdocstrings/python/commit/ba669697daad5067ea5db3fdf8a2d5ba2f966b25) by Timothée Mazzucotelli). [Issue-mkdocstrings-697](https://github.com/mkdocstrings/mkdocstrings/issues/697), [Issue-276](https://github.com/mkdocstrings/python/issues/276)
+- Use configured heading even when signature is not separated ([096960a](https://github.com/mkdocstrings/python/commit/096960abd79831d6fd45e2a7962dfd2bd49e4edd) by Timothée Mazzucotelli). [Issue-mkdocstrings-767](https://github.com/mkdocstrings/mkdocstrings/issues/767), [PR-278](https://github.com/mkdocstrings/python/pull/278)
+- Render attribute names without full path in ToC ([d4e618a](https://github.com/mkdocstrings/python/commit/d4e618ab794747b84dced848b1be824639fea2b8) by David Lee). [Issue-271](https://github.com/mkdocstrings/python/issues/271), [PR-272](https://github.com/mkdocstrings/python/pull/272)
+
+## [1.16.10](https://github.com/mkdocstrings/python/releases/tag/1.16.10) - 2025-04-03
+
+<small>[Compare with 1.16.9](https://github.com/mkdocstrings/python/compare/1.16.9...1.16.10)</small>
+
+### Bug Fixes
+
+- Fix inventory `base_url` being ignored ([8870eb9](https://github.com/mkdocstrings/python/commit/8870eb9af837666f59f96149c67c849e02f7ee25) by Stefan Mejlgaard). [Issue-268](https://github.com/mkdocstrings/python/issues/268), [PR-269](https://github.com/mkdocstrings/python/pull/269)
+
 ## [1.16.9](https://github.com/mkdocstrings/python/releases/tag/1.16.9) - 2025-04-03
 
 <small>[Compare with 1.16.8](https://github.com/mkdocstrings/python/compare/1.16.8...1.16.9)</small>

{mkdocstrings_python-1.16.9 → mkdocstrings_python-1.16.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-python
-Version: 1.16.9
+Version: 1.16.11
 Summary: A Python handler for mkdocstrings.
 Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
 License-Expression: ISC

{mkdocstrings_python-1.16.9 → mkdocstrings_python-1.16.11}/docs/css/material.css

@@ -23,4 +23,4 @@
   background-color: rgb(220, 139, 240);
   -webkit-mask-image: var(--md-admonition-icon--preview);
   mask-image: var(--md-admonition-icon--preview);
-}
+}

{mkdocstrings_python-1.16.9 → mkdocstrings_python-1.16.11}/mkdocs.yml

@@ -182,11 +182,12 @@ plugins:
           summary: true
           unwrap_annotated: true
 - llmstxt:
-    files:
-    - output: llms-full.txt
-      inputs:
+    full_output: llms-full.txt
+    sections:
+      Usage:
       - index.md
-      - reference/**.md
+      API:
+      - reference/api.md
 - git-revision-date-localized:
     enabled: !ENV [DEPLOY, false]
     enable_creation_date: true

{mkdocstrings_python-1.16.9 → mkdocstrings_python-1.16.11}/pyproject.toml

@@ -42,7 +42,7 @@ dependencies = [
     "griffe>=1.6.2",
     "typing-extensions>=4.0; python_version < '3.11'",
 ]
-version = "1.16.9"
+version = "1.16.11"
 
 [project.urls]
 Homepage = "https://mkdocstrings.github.io/python"
@@ -66,6 +66,7 @@ includes = [
 editable-backend = "editables"
 excludes = [
     "**/.pytest_cache",
+    "**/.mypy_cache",
 ]
 source-includes = [
     "config",
@@ -103,7 +104,7 @@ maintain = [
     "yore>=0.3.3",
 ]
 ci = [
-    "blacK>=25.1",
+    "black>=25.1",
     "duty>=1.6",
     "ruff>=0.4",
     "pytest>=8.2",
@@ -122,11 +123,12 @@ docs = [
     "mkdocs>=1.6",
     "mkdocs-coverage>=1.0",
     "mkdocs-git-revision-date-localized-plugin>=1.2",
-    "mkdocs-llmstxt>=0.1",
+    "mkdocs-llmstxt>=0.2",
     "mkdocs-material>=9.5",
-    "pydantic>=2.10",
     "mkdocs-minify-plugin>=0.8",
     "mkdocs-redirects>=1.2",
     "mkdocs-section-index>=0.3",
+    "mkdocstrings>=0.29",
+    "pydantic>=2.10",
     "tomli>=2.0; python_version < '3.11'",
 ]

{mkdocstrings_python-1.16.9 → mkdocstrings_python-1.16.11}/src/mkdocstrings_handlers/python/_internal/config.py

@@ -971,7 +971,7 @@ class Inventory:
         ),
     ]
 
-    base: Annotated[
+    base_url: Annotated[
         str | None,
         _Field(
             parent="inventories",
@@ -989,7 +989,7 @@ class Inventory:
 
     @property
     def _config(self) -> dict[str, Any]:
-        return {"base": self.base, "domains": self.domains}
+        return {"base_url": self.base_url, "domains": self.domains}
 
 
 # YORE: EOL 3.9: Replace `**_dataclass_options` with `frozen=True, kw_only=True` within line.

{mkdocstrings_python-1.16.9 → mkdocstrings_python-1.16.11}/src/mkdocstrings_handlers/python/_internal/rendering.py

@@ -185,10 +185,12 @@ def do_format_signature(
     # Pygments sees it as a function call and not a function definition.
     # The result is that the function name is not parsed as such,
     # but instead as a regular name: `n` CSS class instead of `nf`.
-    # To fix it, we replace the first occurrence of an `n` CSS class
-    # with an `nf` one, unless we found `nf` already.
-    if signature.find('class="nf"') == -1:
-        signature = signature.replace('class="n"', 'class="nf"', 1)
+    # When the function name is a known special name like `__exit__`,
+    # Pygments will set an `fm` (function -> magic) CSS class.
+    # To fix this, we replace the CSS class in the first span with `nf`,
+    # unless we already found an `nf` span.
+    if not re.search(r'<span class="nf">', signature):
+        signature = re.sub(r'<span class="[a-z]+">', '<span class="nf">', signature, count=1)
 
     if stash := env.filters["stash_crossref"].stash:
         for key, value in stash.items():

{mkdocstrings_python-1.16.9 → mkdocstrings_python-1.16.11}/src/mkdocstrings_handlers/python/templates/material/_base/attribute.html.jinja

@@ -39,7 +39,7 @@ Context:
           role="data" if attribute.parent.kind.value == "module" else "attr",
           id=html_id,
           class="doc doc-heading",
-          toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + (config.toc_label if config.toc_label and root else attribute_name),
+          toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + (config.toc_label if config.toc_label and root else attribute.name),
         ) %}
 
         {% block heading scoped %}
@@ -48,8 +48,10 @@ Context:
           This block renders the heading for the attribute.
           -#}
           {% if config.show_symbol_type_heading %}<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code>{% endif %}
-          {% if config.separate_signature %}
-            <span class="doc doc-object-name doc-attribute-name">{{ config.heading if config.heading and root else attribute_name }}</span>
+          {% if config.heading and root %}
+            {{ config.heading }}
+          {% elif config.separate_signature %}
+            <span class="doc doc-object-name doc-attribute-name">{{ attribute_name }}</span>
           {% else %}
             {%+ filter highlight(language="python", inline=True) %}
               {{ attribute_name }}{% if attribute.annotation and config.show_signature_annotations %}: {{ attribute.annotation }}{% endif %}

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

@@ -47,8 +47,10 @@ Context:
           This block renders the heading for the class.
           -#}
           {% if config.show_symbol_type_heading %}<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code>{% endif %}
-          {% if config.separate_signature %}
-            <span class="doc doc-object-name doc-class-name">{{ config.heading if config.heading and root else class_name }}</span>
+          {% if config.heading and root %}
+            {{ config.heading }}
+          {% elif config.separate_signature %}
+            <span class="doc doc-object-name doc-class-name">{{ class_name }}</span>
           {% elif config.merge_init_into_class and "__init__" in all_members %}
             {% with function = all_members["__init__"] %}
               {%+ filter highlight(language="python", inline=True) -%}

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

@@ -54,8 +54,10 @@ Context:
           This block renders the heading for the function.
           -#}
           {% if config.show_symbol_type_heading %}<code class="doc-symbol doc-symbol-heading doc-symbol-{{ symbol_type }}"></code>{% endif %}
-          {% if config.separate_signature %}
-            <span class="doc doc-object-name doc-function-name">{{ config.heading if config.heading and root else function_name }}</span>
+          {% if config.heading and root %}
+            {{ config.heading }}
+          {% elif config.separate_signature %}
+            <span class="doc doc-object-name doc-function-name">{{ function_name }}</span>
           {% else %}
             {%+ filter highlight(language="python", inline=True) -%}
               {#- YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. -#}

{mkdocstrings_python-1.16.9 → mkdocstrings_python-1.16.11}/src/mkdocstrings_handlers/python/templates/material/_base/module.html.jinja

@@ -47,8 +47,10 @@ Context:
           This block renders the heading for the module.
           -#}
           {% if config.show_symbol_type_heading %}<code class="doc-symbol doc-symbol-heading doc-symbol-module"></code>{% endif %}
-          {% if config.separate_signature %}
-            <span class="doc doc-object-name doc-module-name">{{ config.heading if config.heading and root else module_name }}</span>
+          {% if config.heading and root %}
+            {{ config.heading }}
+          {% elif config.separate_signature %}
+            <span class="doc doc-object-name doc-module-name">{{ module_name }}</span>
           {% else %}
             <code>{{ module_name }}</code>
           {% endif %}

{mkdocstrings_python-1.16.9 → mkdocstrings_python-1.16.11}/src/mkdocstrings_handlers/python/templates/material/style.css

@@ -9,6 +9,11 @@
   display: inline;
 }
 
+/* No text transformation from Material for MkDocs for H5 headings. */
+.md-typeset h5 .doc-object-name {
+  text-transform: none;
+}
+
 /* Max width for docstring sections tables. */
 .doc .md-typeset__table,
 .doc .md-typeset__table table {
@@ -30,6 +35,11 @@
   display: inline;
 }
 
+/* Default font size for parameter headings. */
+.md-typeset .doc-heading-parameter {
+  font-size: inherit;
+}
+
 /* Prefer space on the right, not the left of parameter permalinks. */
 .doc-heading-parameter .headerlink {
   margin-left: 0 !important;

{mkdocstrings_python-1.16.9 → mkdocstrings_python-1.16.11}/tests/snapshots/__init__.py

@@ -8,12 +8,12 @@ snapshots_signatures = snapshot(
             ("separate_signature", True),
             ("show_signature_annotations", False),
             ("signature_crossrefs", False),
-        ): external("4370d843cc76*.html"),
+        ): external("d03d16d1919a*.html"),
         (
             ("separate_signature", True),
             ("show_signature_annotations", True),
             ("signature_crossrefs", True),
-        ): external("261a38d7a86b*.html"),
+        ): external("e412376be64f*.html"),
         (
             ("separate_signature", False),
             ("show_signature_annotations", True),
@@ -33,12 +33,12 @@ snapshots_signatures = snapshot(
             ("separate_signature", True),
             ("show_signature_annotations", True),
             ("signature_crossrefs", False),
-        ): external("f5ce06acbb7a*.html"),
+        ): external("74ee37cd1e94*.html"),
         (
             ("separate_signature", True),
             ("show_signature_annotations", False),
             ("signature_crossrefs", True),
-        ): external("9c0bfc0ee407*.html"),
+        ): external("4041a38e355f*.html"),
         (
             ("separate_signature", False),
             ("show_signature_annotations", True),
@@ -383,5 +383,23 @@ snapshots_members = snapshot(
         (("filters", "public"), ("inherited_members", False), ("members", ("module_attribute",))): external(
             "80399c502938*.html",
         ),
+        (("heading", ""), ("members", False), ("separate_signature", False), ("show_if_no_docstring", True)): external(
+            "d1dd339f9260*.html",
+        ),
+        (
+            ("heading", "Some heading"),
+            ("members", False),
+            ("separate_signature", True),
+            ("show_if_no_docstring", True),
+        ): external("480324b25439*.html"),
+        (("heading", ""), ("members", False), ("separate_signature", True), ("show_if_no_docstring", True)): external(
+            "2eef87791b97*.html",
+        ),
+        (
+            ("heading", "Some heading"),
+            ("members", False),
+            ("separate_signature", False),
+            ("show_if_no_docstring", True),
+        ): external("51deee0f00f3*.html"),
     },
 )

mkdocstrings_python-1.16.11/tests/snapshots/external/2eef87791b974c724d2cd98e40bb25994087bc836868f63da18557a6094a00ee.html

@@ -0,0 +1,20 @@
+<!--
+{
+  "heading": "",
+  "members": false,
+  "separate_signature": true,
+  "show_if_no_docstring": true
+}
+-->
+
+<div class="doc doc-object doc-module">
+ <h1 class="doc doc-heading" id="headings_package">
+  <span class="doc doc-object-name doc-module-name">
+   headings_package
+  </span>
+ </h1>
+ <div class="doc doc-contents first">
+  <div class="doc doc-children">
+  </div>
+ </div>
+</div>

mkdocstrings_python-1.16.9/tests/snapshots/external/9c0bfc0ee40732505dc3dab8c95ad4ed6582d10df2449c7d92f1e43a91610666.html → mkdocstrings_python-1.16.11/tests/snapshots/external/4041a38e355f6585a7e1265509d7c5b499fe3776aeeeb298db7589bb385ca019.html

@@ -36,7 +36,7 @@
         </span>
        </h3>
        <div class="doc-signature highlight">
-        <pre><span></span><code><span class="fm">__init__</span><span class="p">(</span><span class="nf">a</span><span class="p">,</span> <span class="n">b</span><span class="p">)</span>
+        <pre><span></span><code><span class="nf">__init__</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">)</span>
 </code></pre>
        </div>
        <div class="doc doc-contents">

mkdocstrings_python-1.16.11/tests/snapshots/external/480324b25439ea41507fdda100045132d578af0e1df1219c08bc9ea0bea1f39c.html

@@ -0,0 +1,18 @@
+<!--
+{
+  "heading": "Some heading",
+  "members": false,
+  "separate_signature": true,
+  "show_if_no_docstring": true
+}
+-->
+
+<div class="doc doc-object doc-module">
+ <h1 class="doc doc-heading" id="headings_package">
+  Some heading
+ </h1>
+ <div class="doc doc-contents first">
+  <div class="doc doc-children">
+  </div>
+ </div>
+</div>

mkdocstrings_python-1.16.11/tests/snapshots/external/51deee0f00f35b0902f82fb96a36d547a80dfbb41a311dabd94b96fd968b83bc.html

@@ -0,0 +1,18 @@
+<!--
+{
+  "heading": "Some heading",
+  "members": false,
+  "separate_signature": false,
+  "show_if_no_docstring": true
+}
+-->
+
+<div class="doc doc-object doc-module">
+ <h1 class="doc doc-heading" id="headings_package">
+  Some heading
+ </h1>
+ <div class="doc doc-contents first">
+  <div class="doc doc-children">
+  </div>
+ </div>
+</div>

mkdocstrings_python-1.16.9/tests/snapshots/external/f5ce06acbb7a31658cc6367db31caaf7a210c0a31e71de950e791c5eb33a6258.html → mkdocstrings_python-1.16.11/tests/snapshots/external/74ee37cd1e94250baa33050af088e7341495708d879ab45ee9e8ab1dcac26f2a.html

@@ -36,7 +36,7 @@
         </span>
        </h3>
        <div class="doc-signature highlight">
-        <pre><span></span><code><span class="fm">__init__</span><span class="p">(</span><span class="nf">a</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">b</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
+        <pre><span></span><code><span class="nf">__init__</span><span class="p">(</span><span class="n">a</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">b</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
 </code></pre>
        </div>
        <div class="doc doc-contents">

mkdocstrings_python-1.16.9/tests/snapshots/external/4370d843cc76138927502402ac39c80414c8441a962f6466afdb280dc022af26.html → mkdocstrings_python-1.16.11/tests/snapshots/external/d03d16d1919af01db9b8d4e5bf36b007810eb3730a7283624a4d68c6fe2ce652.html

@@ -36,7 +36,7 @@
         </span>
        </h3>
        <div class="doc-signature highlight">
-        <pre><span></span><code><span class="fm">__init__</span><span class="p">(</span><span class="nf">a</span><span class="p">,</span> <span class="n">b</span><span class="p">)</span>
+        <pre><span></span><code><span class="nf">__init__</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">)</span>
 </code></pre>
        </div>
        <div class="doc doc-contents">

mkdocstrings_python-1.16.11/tests/snapshots/external/d1dd339f926026210ea46cc75922a8236f43cade477f95e4ce4c9a60248f0a10.html

@@ -0,0 +1,20 @@
+<!--
+{
+  "heading": "",
+  "members": false,
+  "separate_signature": false,
+  "show_if_no_docstring": true
+}
+-->
+
+<div class="doc doc-object doc-module">
+ <h1 class="doc doc-heading" id="headings_package">
+  <code>
+   headings_package
+  </code>
+ </h1>
+ <div class="doc doc-contents first">
+  <div class="doc doc-children">
+  </div>
+ </div>
+</div>

mkdocstrings_python-1.16.9/tests/snapshots/external/261a38d7a86b5e959b6d1c165108301963d0170c2189d5aa18bb7c7eade84ea4.html → mkdocstrings_python-1.16.11/tests/snapshots/external/e412376be64f25f3f5d2264400a83a1e693c146feec7c359855c676c4a586392.html

@@ -36,7 +36,7 @@
         </span>
        </h3>
        <div class="doc-signature highlight">
-        <pre><span></span><code><span class="fm">__init__</span><span class="p">(</span><span class="nf">a</span><span class="p">:</span> <span class="n"><autoref backlink-anchor="signature_package.Class.__init__" backlink-type="used-by" identifier="int" optional="">int</autoref></span><span class="p">,</span> <span class="n">b</span><span class="p">:</span> <span class="n"><autoref backlink-anchor="signature_package.Class.__init__" backlink-type="used-by" identifier="str" optional="">str</autoref></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
+        <pre><span></span><code><span class="nf">__init__</span><span class="p">(</span><span class="n">a</span><span class="p">:</span> <span class="n"><autoref backlink-anchor="signature_package.Class.__init__" backlink-type="used-by" identifier="int" optional="">int</autoref></span><span class="p">,</span> <span class="n">b</span><span class="p">:</span> <span class="n"><autoref backlink-anchor="signature_package.Class.__init__" backlink-type="used-by" identifier="str" optional="">str</autoref></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
 </code></pre>
        </div>
        <div class="doc doc-contents">

{mkdocstrings_python-1.16.9 → mkdocstrings_python-1.16.11}/tests/test_api.py

@@ -145,7 +145,7 @@ def test_api_matches_inventory(inventory: Inventory, public_objects: list[griffe
 
 
 def _module_or_child(parent: str, name: str) -> bool:
-    parents = [parent[: i + 1] for i, char in enumerate(parent) if char == "."]
+    parents = [parent[:i] for i, char in enumerate(parent) if char == "."]
     parents.append(parent)
     return name in parents or name.startswith(parent + ".")
 

{mkdocstrings_python-1.16.9 → mkdocstrings_python-1.16.11}/tests/test_end_to_end.py

@@ -59,7 +59,7 @@ def _render_options(options: dict[str, Any]) -> str:
     return f"<!--\n{json.dumps(options, indent=2, sort_keys=True)}\n-->\n\n"
 
 
-# Signature options
+# Signature tests.
 @pytest.fixture(name="signature_package", scope="session")
 def _signature_package() -> Iterator[TmpPackage]:
     code = """
@@ -108,7 +108,7 @@ def test_end_to_end_for_signatures(
     assert outsource(html, suffix=".html") == snapshots_signatures[snapshot_key]
 
 
-# Members options.
+# Member tests.
 @pytest.fixture(name="members_package", scope="session")
 def _members_package() -> Iterator[TmpPackage]:
     code = """
@@ -171,3 +171,50 @@ def test_end_to_end_for_members(
     html = _render_options(final_options) + _render(session_handler, members_package, final_options)
     snapshot_key = tuple(sorted(final_options.items()))
     assert outsource(html, suffix=".html") == snapshots_members[snapshot_key]
+
+
+# Heading tests.
+@pytest.fixture(name="headings_package", scope="session")
+def _headings_package() -> Iterator[TmpPackage]:
+    code = """
+        def module_function(a: int, b: str) -> None:
+            pass
+
+        class Class:
+            class_attribute: int = 42
+
+            def __init__(self, a: int, b: str) -> None:
+                self.instance_attribute = a + b
+
+            def method1(self, a: int, b: str) -> None:
+                pass
+
+        module_attribute: int = 42
+    """
+    with temporary_pypackage("headings_package", {"__init__.py": code}) as tmppkg:
+        yield tmppkg
+
+
+@pytest.mark.parametrize("separate_signature", [True, False])
+@pytest.mark.parametrize("heading", ["", "Some heading"])
+def test_end_to_end_for_headings(
+    session_handler: PythonHandler,
+    headings_package: TmpPackage,
+    separate_signature: bool,
+    heading: str,
+) -> None:
+    """Test rendering of a given theme's templates.
+
+    Parameters:
+        identifier: Parametrized identifier.
+        session_handler: Python handler (fixture).
+    """
+    final_options = {
+        "separate_signature": separate_signature,
+        "heading": heading,
+        "show_if_no_docstring": True,
+        "members": False,
+    }
+    html = _render_options(final_options) + _render(session_handler, headings_package, final_options)
+    snapshot_key = tuple(sorted(final_options.items()))
+    assert outsource(html, suffix=".html") == snapshots_members[snapshot_key]

{mkdocstrings_python-1.16.9 → mkdocstrings_python-1.16.11}/tests/test_handler.py

@@ -4,11 +4,14 @@ from __future__ import annotations
 
 import os
 import sys
+from dataclasses import replace
 from glob import glob
+from io import BytesIO
 from pathlib import Path
 from textwrap import dedent
 from typing import TYPE_CHECKING
 
+import mkdocstrings
 import pytest
 from griffe import (
     Docstring,
@@ -20,7 +23,7 @@ from griffe import (
 )
 from mkdocstrings import CollectionError
 
-from mkdocstrings_handlers.python import PythonConfig, PythonHandler, PythonOptions
+from mkdocstrings_handlers.python import Inventory, PythonConfig, PythonHandler, PythonOptions
 
 if TYPE_CHECKING:
     from mkdocstrings import MkdocstringsPlugin
@@ -298,3 +301,33 @@ def test_inheriting_self_from_parent_class(handler: PythonHandler) -> None:
             module,
             handler.get_options({"inherited_members": True}),
         )
+
+
+def test_specifying_inventory_base_url(handler: PythonHandler) -> None:
+    """Assert that the handler renders inventory URLs using the specified base_url."""
+    # Update handler config to include an inventory with a base URL
+    base_url = "https://docs.com/my_library"
+    inventory = Inventory(url="https://example.com/objects.inv", base_url=base_url)
+    handler.config = replace(handler.config, inventories=[inventory])
+
+    # Mock inventory bytes
+    item_name = "my_library.my_module.MyClass"
+    mocked_inventory = mkdocstrings.Inventory()
+    mocked_inventory.register(
+        name=item_name,
+        domain="py",
+        role="class",
+        uri=f"api-reference/#{item_name}",
+        dispname=item_name,
+    )
+    mocked_bytes = BytesIO(mocked_inventory.format_sphinx())
+
+    # Get inventory URL and config
+    url, config = handler.get_inventory_urls()[0]
+
+    # Load the mocked inventory
+    _, item_url = next(handler.load_inventory(mocked_bytes, url, **config))
+
+    # Assert the URL is based on the provided base URL
+    msg = "Expected inventory URL to start with base_url"
+    assert item_url.startswith(base_url), msg