Skip to content

Commit 2215f8b

Browse files
committed
Add more cross-linking to generated docs
We add inventories for all the dependencies we can find an inventory for. Signed-off-by: Leandro Lucarella <[email protected]>
1 parent e11d192 commit 2215f8b

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

mkdocs.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,13 @@ plugins:
9898
show_source: true
9999
import:
100100
- https://docs.python.org/3/objects.inv
101+
- https://frequenz-floss.github.io/frequenz-channels-python/v0.14/objects.inv
102+
- https://grpc.github.io/grpc/python/objects.inv
103+
- https://networkx.org/documentation/stable/objects.inv
104+
- https://numpy.org/doc/stable/objects.inv
105+
- https://protobuf.readthedocs.io/en/latest/objects.inv
106+
- https://typing-extensions.readthedocs.io/en/stable/objects.inv
107+
- https://watchfiles.helpmanual.io/objects.inv
101108
- search
102109
- section-index
103110

pyproject.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ classifiers = [
2727
requires-python = ">= 3.11, < 4"
2828
dependencies = [
2929
"frequenz-api-microgrid >= 0.11.0, < 0.12.0",
30+
# Make sure to update the mkdocs.yml file when
31+
# changing the version
32+
# (plugins.mkdocstrings.handlers.python.import)
3033
"frequenz-channels >= 0.14.0, < 0.15.0",
3134
"google-api-python-client >= 2.71, < 3",
3235
"grpcio >= 1.54.2, < 2",

0 commit comments

Comments
 (0)