Skip to content

Commit

Permalink
Improve generated docs (#31)
Browse files Browse the repository at this point in the history
- **mkdocs: Show symbol type in the TOC**
- **mkdocs: Add missing cross-referencing to channels and protobuf**
  • Loading branch information
llucax authored Mar 5, 2024
2 parents 1ad69f6 + 04ff817 commit d8c8aa6
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -114,10 +114,13 @@ plugins:
show_root_members_full_path: true
show_signature_annotations: true
show_source: true
show_symbol_type_toc: true
signature_crossrefs: true
import:
# 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-pre/objects.inv
- https://googleapis.dev/python/protobuf/latest/objects.inv
- https://grpc.github.io/grpc/python/objects.inv
- https://typing-extensions.readthedocs.io/en/stable/objects.inv
# Note this plugin must be loaded after mkdocstrings to be able to use macros
Expand Down

0 comments on commit d8c8aa6

Please sign in to comment.