Commit 6d28eee
authored
Docs: Improve readability of reference page (#605)
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 9f3b8b5 commit 6d28eee
1 file changed
+8
-1
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
13 | 13 | | |
14 | 14 | | |
15 | 15 | | |
16 | | - | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
17 | 24 | | |
18 | 25 | | |
19 | 26 | | |
| |||
0 commit comments