Skip to content

Commit b2cd33c

Browse files
committed
docs(mkdocs.yml): update mkdocstrings configuration to simplify documentation paths
Disable `show_root_members_full_path` and `show_object_full_path` options to simplify the display of paths in the generated documentation. This change aims to make the documentation more readable by reducing the verbosity of the path information, focusing on clarity and ease of understanding for users.
1 parent 2263c2a commit b2cd33c

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -190,9 +190,9 @@ plugins:
190190
# https://mkdocstrings.github.io/python/usage/configuration/headings/#show_root_full_path
191191
show_root_full_path: true
192192
# https://mkdocstrings.github.io/python/usage/configuration/headings/#show_root_members_full_path
193-
show_root_members_full_path: true
193+
show_root_members_full_path: false
194194
# https://mkdocstrings.github.io/python/usage/configuration/headings/#show_object_full_path
195-
show_object_full_path: true
195+
show_object_full_path: false
196196
# https://mkdocstrings.github.io/python/usage/configuration/headings/#show_category_heading
197197
show_category_heading: false
198198
# https://mkdocstrings.github.io/python/usage/configuration/headings/#show_symbol_type_heading

0 commit comments

Comments
 (0)