Fix documentation cross-linking inventory versions - #301
Merged
Merged
Conversation
llucax
requested review from
ela-kotulska-frequenz
and removed request for
a team
September 17, 2026 07:48
github-actions
Bot
added
part:docs
Contributor
Author
|
Fixed screenshot: 
|
llucax
enabled auto-merge
September 17, 2026 07:51
llucax
disabled auto-merge
September 17, 2026 08:14
daniel-zullo-frequenz
previously approved these changes
Sep 17, 2026
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 frequenz-floss#300. Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
llucax
force-pushed
the
fix-docs-inventories
branch
from
September 17, 2026 08:46
f031db4 to
7961389
Compare
llucax
enabled auto-merge
September 17, 2026 08:47
Contributor
Author
|
Updated, needs a new approval. |
daniel-zullo-frequenz
approved these changes
Sep 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The mkdocstrings inventories pointed to older versions of the dependencies' documentation than the minimum versions declared in
pyproject.toml, so symbols added later, likeTargetComponentsfromfrequenz-client-dispatch(present since v0.11 but linked to v0.6), could not be resolved. Thefrequenz-client-baseinventory was also missing entirely.This updates the inventories to match the minimum dependency versions (
frequenz-channelsv1.6,frequenz-client-dispatchv0.11), adds thefrequenz-client-basev0.11 inventory, and fixes thepyproject.tomlcomment that still referred to the oldimportconfig key (nowinventories).Fixes #300.