Merge pull request #108 from lincc-frameworks/fix_autoapi_hits

Improve Sphinx AutoAPI Readability
lincc-frameworks · Jun 11, 2024 · c44bfe1 · c44bfe1
2 parents 5cf1fa5 + 1f958fb
commit c44bfe1
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 14 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -54,6 +54,13 @@
 autoapi_ignore = ["*/__main__.py", "*/_version.py"]
 autoapi_add_toc_tree_entry = False
 autoapi_member_order = "bysource"
+autoapi_options = [
+    "members",
+    "undoc-members",
+    "show-inheritance",
+    "show-module-summary",
+    "special-members",
+]
 
 html_theme = "sphinx_book_theme"
 

diff --git a/src/nested_pandas/example_benchmarks.py b/src/nested_pandas/example_benchmarks.py