From 7961389067e97b0aaf477086b45883efb1fc5d02 Mon Sep 17 00:00:00 2001 From: Leandro Lucarella Date: Thu, 17 Sep 2026 07:45:21 +0000 Subject: [PATCH] Fix documentation cross-linking inventory versions The mkdocstrings inventories pointed to older versions of the dependencies' documentation than the minimum versions declared in pyproject.toml, so symbols added later, like `TargetComponents` from `frequenz-client-dispatch` (present since v0.11 but linked to v0.6), could not be resolved. The `frequenz-client-base` inventory was also missing entirely. Update the inventories to match the minimum dependency versions, add the `frequenz-client-base` inventory, and fix the pyproject.toml comment that still referred to the old `import` config key, now called `inventories`. Fixes #300. Signed-off-by: Leandro Lucarella --- RELEASE_NOTES.md | 4 ++++ mkdocs.yml | 5 +++-- pyproject.toml | 2 +- 3 files changed, 8 insertions(+), 3 deletions(-) diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index a4e6edd..97a5f43 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -19,3 +19,7 @@ ## Bug Fixes + +* Fixed documentation cross-references to dependencies by updating the + mkdocstrings inventories to match the minimum dependency versions and + adding the missing `frequenz-client-base` inventory. diff --git a/mkdocs.yml b/mkdocs.yml index 8a598f8..d6b8be9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -116,8 +116,9 @@ plugins: inventories: # See https://mkdocstrings.github.io/python/usage/#import for details - https://docs.python.org/3/objects.inv - - https://frequenz-floss.github.io/frequenz-channels-python/v1.0/objects.inv - - https://frequenz-floss.github.io/frequenz-client-dispatch-python/v0.6/objects.inv + - https://frequenz-floss.github.io/frequenz-channels-python/v1.6/objects.inv + - https://frequenz-floss.github.io/frequenz-client-base-python/v0.11/objects.inv + - https://frequenz-floss.github.io/frequenz-client-dispatch-python/v0.11/objects.inv - https://frequenz-floss.github.io/frequenz-sdk-python/v1.0-pre/objects.inv - https://grpc.github.io/grpc/python/objects.inv - https://typing-extensions.readthedocs.io/en/stable/objects.inv diff --git a/pyproject.toml b/pyproject.toml index 8467ab4..3719fc9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -37,7 +37,7 @@ dependencies = [ "typing-extensions >= 4.13.0, < 5.0.0", # Make sure to update the version for cross-referencing also in the # mkdocs.yml file when changing the version here (look for the config key - # plugins.mkdocstrings.handlers.python.import) + # plugins.mkdocstrings.handlers.python.inventories) "frequenz-sdk >= 1.0.0-rc2100, < 1.0.0-rc2300", "frequenz-channels >= 1.6.1, < 2.0.0", "frequenz-client-dispatch >= 0.11.3, < 2.0.0",