From 2f5c759c90ae05b3416bede2f976662a8ac75f1a Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 4 May 2026 13:10:32 +0000 Subject: [PATCH 1/2] Bump mkdocstrings-python from 1.18.2 to 2.0.3 Bumps [mkdocstrings-python](https://github.com/mkdocstrings/python) from 1.18.2 to 2.0.3. - [Release notes](https://github.com/mkdocstrings/python/releases) - [Changelog](https://github.com/mkdocstrings/python/blob/main/CHANGELOG.md) - [Commits](https://github.com/mkdocstrings/python/compare/1.18.2...2.0.3) --- updated-dependencies: - dependency-name: mkdocstrings-python dependency-version: 2.0.3 dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 122c5187..98afa782 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -58,7 +58,7 @@ dev-mkdocs = [ "mkdocs-macros-plugin == 1.5.0", "mkdocs-material == 9.7.6", "mkdocstrings[python] == 1.0.4", - "mkdocstrings-python == 1.18.2", + "mkdocstrings-python == 2.0.3", "pymdownx-superfence-filter-lines == 0.1.0", "griffe==2.0.2", ] From 81195854654eab673af85c35bbf04ef16d9de6a4 Mon Sep 17 00:00:00 2001 From: Leandro Lucarella Date: Fri, 8 May 2026 13:34:14 +0200 Subject: [PATCH 2/2] Fix removed import in the new mkdocstrings-python 2.0.0 Signed-off-by: Leandro Lucarella --- docs/_scripts/macros.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/_scripts/macros.py b/docs/_scripts/macros.py index fbf09f7d..b4fea6e2 100644 --- a/docs/_scripts/macros.py +++ b/docs/_scripts/macros.py @@ -6,7 +6,7 @@ from frequenz.repo.config.mkdocs.mkdocstrings_macros import hook_env_with_everything from griffe import ModulesCollection, Object from mkdocs_macros.plugin import MacrosPlugin -from mkdocstrings_handlers.python.handler import PythonHandler +from mkdocstrings_handlers.python import PythonHandler def define_env(env: MacrosPlugin) -> None: @@ -47,8 +47,7 @@ def docstring_summary(symbol: str) -> str: """ docstring = _get_docstring(symbol) summary = docstring.splitlines(keepends=False)[0] - # The python_handler is untyped here, so ignore the type - return python_handler.do_convert_markdown( # type: ignore[no-any-return] + return python_handler.do_convert_markdown( summary, heading_level=1, strip_paragraph=True )