mkdocstrings-python 1.16.8__tar.gz → 1.16.10__tar.gz

{mkdocstrings_python-1.16.8 → mkdocstrings_python-1.16.10}/CHANGELOG.md

@@ -5,6 +5,22 @@ 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.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>
+
+### Bug Fixes
+
+- Use `toc_label` option in a few missing places ([337b46b](https://github.com/mkdocstrings/python/commit/337b46be912ff69e70b398bb252c8217c917db0a) by Timothée Mazzucotelli). [Issue-267](https://github.com/mkdocstrings/python/discussions/267)
+
 ## [1.16.8](https://github.com/mkdocstrings/python/releases/tag/1.16.8) - 2025-03-24
 
 <small>[Compare with 1.16.7](https://github.com/mkdocstrings/python/compare/1.16.7...1.16.8)</small>

{mkdocstrings_python-1.16.8 → mkdocstrings_python-1.16.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-python
-Version: 1.16.8
+Version: 1.16.10
 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.8 → mkdocstrings_python-1.16.10}/pyproject.toml

@@ -42,7 +42,7 @@ dependencies = [
     "griffe>=1.6.2",
     "typing-extensions>=4.0; python_version < '3.11'",
 ]
-version = "1.16.8"
+version = "1.16.10"
 
 [project.urls]
 Homepage = "https://mkdocstrings.github.io/python"
@@ -103,7 +103,7 @@ maintain = [
     "yore>=0.3.3",
 ]
 ci = [
-    "blacK>=25.1",
+    "black>=25.1",
     "duty>=1.6",
     "ruff>=0.4",
     "pytest>=8.2",
@@ -128,5 +128,6 @@ docs = [
     "mkdocs-minify-plugin>=0.8",
     "mkdocs-redirects>=1.2",
     "mkdocs-section-index>=0.3",
+    "mkdocstrings>=0.29",
     "tomli>=2.0; python_version < '3.11'",
 ]

{mkdocstrings_python-1.16.8 → mkdocstrings_python-1.16.10}/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.8 → mkdocstrings_python-1.16.10}/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 '') + 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 %}

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

@@ -38,7 +38,7 @@ Context:
           role="class",
           id=html_id,
           class="doc doc-heading",
-          toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + class.name,
+          toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + (config.toc_label if config.toc_label and root else class.name),
         ) %}
 
         {% block heading scoped %}

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

@@ -45,7 +45,7 @@ Context:
           role="function",
           id=html_id,
           class="doc doc-heading",
-          toc_label=(('<code class="doc-symbol doc-symbol-toc doc-symbol-' + symbol_type + '"></code>&nbsp;')|safe if config.show_symbol_type_toc else '') + function.name,
+          toc_label=(('<code class="doc-symbol doc-symbol-toc doc-symbol-' + symbol_type + '"></code>&nbsp;')|safe if config.show_symbol_type_toc else '') + (config.toc_label if config.toc_label and root else function.name),
         ) %}
 
         {% block heading scoped %}

{mkdocstrings_python-1.16.8 → mkdocstrings_python-1.16.10}/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