From 9b28c2c090e7a35854c999a7d5ac96ed33d2e971 Mon Sep 17 00:00:00 2001 From: Doug Branton Date: Thu, 28 Mar 2024 16:00:06 -0700 Subject: [PATCH 1/3] try initial change --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 0016d1a9..84533972 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -47,7 +47,7 @@ # Remove 'view source code' from top of page (for html, not python) html_show_sourcelink = False # Remove namespaces from class/method signatures -add_module_names = False +add_module_names = True autoapi_type = "python" autoapi_dirs = ["../src"] From 0a516a6ebe569352c763d46a2fdd35bd3e1775b0 Mon Sep 17 00:00:00 2001 From: Doug Branton Date: Thu, 28 Mar 2024 16:19:06 -0700 Subject: [PATCH 2/3] try a few new options --- docs/conf.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 84533972..7ba69652 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -47,13 +47,15 @@ # Remove 'view source code' from top of page (for html, not python) html_show_sourcelink = False # Remove namespaces from class/method signatures -add_module_names = True +add_module_names = False autoapi_type = "python" autoapi_dirs = ["../src"] autoapi_ignore = ["*/__main__.py", "*/_version.py"] -autoapi_add_toc_tree_entry = False -autoapi_member_order = "bysource" +autoapi_add_toc_tree_entry = True +autoapi_member_order = "groupwise" +autoapi_own_page_level = "class" +autoapi_options = [ 'members', 'show-inheritance', 'show-module-summary', 'imported-members', ] html_theme = "sphinx_book_theme" From 21ae6c30a1178a6ca7b6bbb89e91f5256921265d Mon Sep 17 00:00:00 2001 From: Doug Branton Date: Thu, 28 Mar 2024 16:33:26 -0700 Subject: [PATCH 3/3] flip --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 7ba69652..e75945b2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -52,7 +52,7 @@ autoapi_type = "python" autoapi_dirs = ["../src"] autoapi_ignore = ["*/__main__.py", "*/_version.py"] -autoapi_add_toc_tree_entry = True +autoapi_add_toc_tree_entry = False autoapi_member_order = "groupwise" autoapi_own_page_level = "class" autoapi_options = [ 'members', 'show-inheritance', 'show-module-summary', 'imported-members', ]