From 2e0098db4677605e51208bb0ea0a7829fc818a4c Mon Sep 17 00:00:00 2001 From: Bertrand Bonnefoy-Claudet Date: Sun, 11 Jan 2026 15:06:16 +0100 Subject: [PATCH] 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). --- mkdocs.yml | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index ba77fa7f..3d55d899 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -13,7 +13,14 @@ markdown_extensions: - mdx_truly_sane_lists plugins: - - mkdocstrings + - mkdocstrings: + handlers: + python: + options: + separate_signature: true + show_root_heading: true + show_symbol_type_heading: true + show_symbol_type_toc: true - search nav: - Home: index.md