Skip to content

Commit 2e0098d

Browse files
committed
Docs: Improve readability of reference page
This uses some (but not all) of the settings recommended at https://mkdocstrings.github.io/python/usage/#recommended-settings. Changes to the "Reference" page: - Replace section heading with function name (instead of function declaration): This should be more readable. - The function declaration is now shown in a code block instead of the heading. - Added "Table of contents" to the right, to quickly navigate to a particular method. - Removed "Source code": It removes clutter from the page and probably wasn't very useful (but it can easily be added back if needed).
1 parent f54d29f commit 2e0098d

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

mkdocs.yml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,14 @@ markdown_extensions:
1313
- mdx_truly_sane_lists
1414

1515
plugins:
16-
- mkdocstrings
16+
- mkdocstrings:
17+
handlers:
18+
python:
19+
options:
20+
separate_signature: true
21+
show_root_heading: true
22+
show_symbol_type_heading: true
23+
show_symbol_type_toc: true
1724
- search
1825
nav:
1926
- Home: index.md

0 commit comments

Comments
 (0)