Skip to content

Commit 3b19352

Browse files
committed
Use the show_symbol_type_toc option of mkdocstrings-python
This shows the symbol type in the table of contents of the documentation. Signed-off-by: Leandro Lucarella <[email protected]>
1 parent efbf767 commit 3b19352

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ 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
- https://docs.python.org/3/objects.inv

pyproject.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,8 @@ dev-mkdocs = [
6363
"mkdocs-literate-nav == 0.6.1",
6464
"mkdocs-macros-plugin == 1.0.5",
6565
"mkdocs-material == 9.5.20",
66-
"mkdocstrings[python] == 0.25.0",
66+
"mkdocstrings[python] == 0.25.1",
67+
"mkdocstrings-python == 1.9.2",
6768
"frequenz-repo-config[lib] == 0.9.2",
6869
]
6970
dev-mypy = [

0 commit comments

Comments
 (0)