Skip to content

Commit f031db4

Browse files
committed
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 <luca-frequenz@llucax.com>
1 parent 27f6ff8 commit f031db4

3 files changed

Lines changed: 7 additions & 3 deletions

File tree

RELEASE_NOTES.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,6 @@
2424
arrives exactly at the moment a dispatch window closes. Also fixed a
2525
related issue that could cause incorrect event ordering when multiple
2626
dispatches are updated concurrently.
27+
* Fixed documentation cross-references to dependencies by updating the
28+
mkdocstrings inventories to match the minimum dependency versions and
29+
adding the missing `frequenz-client-base` inventory.

mkdocs.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,8 +116,9 @@ plugins:
116116
inventories:
117117
# See https://mkdocstrings.github.io/python/usage/#import for details
118118
- https://docs.python.org/3/objects.inv
119-
- https://frequenz-floss.github.io/frequenz-channels-python/v1.0/objects.inv
120-
- https://frequenz-floss.github.io/frequenz-client-dispatch-python/v0.6/objects.inv
119+
- https://frequenz-floss.github.io/frequenz-channels-python/v1.6/objects.inv
120+
- https://frequenz-floss.github.io/frequenz-client-base-python/v0.11/objects.inv
121+
- https://frequenz-floss.github.io/frequenz-client-dispatch-python/v0.11/objects.inv
121122
- https://frequenz-floss.github.io/frequenz-sdk-python/v1.0-pre/objects.inv
122123
- https://grpc.github.io/grpc/python/objects.inv
123124
- https://typing-extensions.readthedocs.io/en/stable/objects.inv

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ dependencies = [
3737
"typing-extensions >= 4.13.0, < 5.0.0",
3838
# Make sure to update the version for cross-referencing also in the
3939
# mkdocs.yml file when changing the version here (look for the config key
40-
# plugins.mkdocstrings.handlers.python.import)
40+
# plugins.mkdocstrings.handlers.python.inventories)
4141
"frequenz-sdk >= 1.0.0-rc2100, < 1.0.0-rc2300",
4242
"frequenz-channels >= 1.6.1, < 2.0.0",
4343
"frequenz-client-dispatch >= 0.11.3, < 2.0.0",

0 commit comments

Comments
 (0)