From 30d4ba23e4402a63ee27a37135c38918bdcbeca5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Mazzucotelli?= Date: Thu, 28 Aug 2025 15:48:11 +0200 Subject: [PATCH 1/3] docs: Fix docs for type parameter headings --- docs/usage/configuration/headings.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/usage/configuration/headings.md b/docs/usage/configuration/headings.md index ee10e381..8e904e5f 100644 --- a/docs/usage/configuration/headings.md +++ b/docs/usage/configuration/headings.md @@ -744,6 +744,7 @@ plugins: summary: false separate_signature: true show_signature_type_parameters: true + show_inheritance_diagram: false type_parameter_headings: true ``` @@ -765,6 +766,7 @@ plugins: show_docstring_description: false show_docstring_parameters: false show_docstring_returns: false + show_inheritance_diagram: false ``` //// @@ -781,6 +783,7 @@ plugins: show_docstring_description: false show_docstring_parameters: false show_docstring_returns: false + show_inheritance_diagram: false ``` //// @@ -797,6 +800,7 @@ plugins: show_docstring_description: false show_docstring_parameters: false show_docstring_returns: false + show_inheritance_diagram: false ``` //// /// From 6f79be0ea83522021e16e5d401209e58576ef93a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Mazzucotelli?= Date: Thu, 28 Aug 2025 18:10:49 +0200 Subject: [PATCH 2/3] fix: Normalize spaces to underscores when passing object to rendering context using its kind as key Issue-mkdocstrings-791: https://github.com/mkdocstrings/mkdocstrings/issues/791 --- src/mkdocstrings_handlers/python/_internal/handler.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/mkdocstrings_handlers/python/_internal/handler.py b/src/mkdocstrings_handlers/python/_internal/handler.py index c62088b3..fbed2b8e 100644 --- a/src/mkdocstrings_handlers/python/_internal/handler.py +++ b/src/mkdocstrings_handlers/python/_internal/handler.py @@ -295,7 +295,7 @@ def render(self, data: CollectorItem, options: PythonOptions, locale: str | None return template.render( **{ "config": options, - data.kind.value: data, + data.kind.value.replace(" ", "_"): data, # Heading level is a "state" variable, that will change at each step # of the rendering recursion. Therefore, it's easier to use it as a plain value # than as an item in a dictionary. From 754b481471ebc032e6dafe7efe4193b73ef2d8bb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Mazzucotelli?= Date: Thu, 28 Aug 2025 18:11:08 +0200 Subject: [PATCH 3/3] chore: Prepare release 1.18.2 --- CHANGELOG.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4faea5fa..1ac6e8ec 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,14 @@ 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). +## [1.18.2](https://github.com/mkdocstrings/python/releases/tag/1.18.2) - 2025-08-28 + +[Compare with 1.18.1](https://github.com/mkdocstrings/python/compare/1.18.1...1.18.2) + +### Bug Fixes + +- Normalize spaces to underscores when passing object to rendering context using its kind as key ([6f79be0](https://github.com/mkdocstrings/python/commit/6f79be0ea83522021e16e5d401209e58576ef93a) by Timothée Mazzucotelli). [Issue-mkdocstrings-791](https://github.com/mkdocstrings/mkdocstrings/issues/791) + ## [1.18.1](https://github.com/mkdocstrings/python/releases/tag/1.18.1) - 2025-08-28 [Compare with 1.18.0](https://github.com/mkdocstrings/python/compare/1.18.0...1.18.1)