Skip to content

Fix documentation cross-linking inventory versions #301

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
llucax merged 1 commit into from
Sep 17, 2026
Merged

Fix documentation cross-linking inventory versions #301

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,7 @@
## Bug Fixes

<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

* 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.
5 changes: 3 additions & 2 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down