Skip to content

Commit d8c8aa6

Browse files
authored
Improve generated docs (#31)
- **mkdocs: Show symbol type in the TOC** - **mkdocs: Add missing cross-referencing to channels and protobuf**
2 parents 1ad69f6 + 04ff817 commit d8c8aa6

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

mkdocs.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,10 +114,13 @@ plugins:
114114
show_root_members_full_path: true
115115
show_signature_annotations: true
116116
show_source: true
117+
show_symbol_type_toc: true
117118
signature_crossrefs: true
118119
import:
119120
# See https://mkdocstrings.github.io/python/usage/#import for details
120121
- https://docs.python.org/3/objects.inv
122+
- https://frequenz-floss.github.io/frequenz-channels-python/v1.0-pre/objects.inv
123+
- https://googleapis.dev/python/protobuf/latest/objects.inv
121124
- https://grpc.github.io/grpc/python/objects.inv
122125
- https://typing-extensions.readthedocs.io/en/stable/objects.inv
123126
# Note this plugin must be loaded after mkdocstrings to be able to use macros

0 commit comments

Comments
 (0)