diff options
| author | Jordan Wiens <github@psifertex.com> | 2025-11-06 15:35:46 -0500 |
|---|---|---|
| committer | Jordan Wiens <github@psifertex.com> | 2025-11-10 23:22:35 -0500 |
| commit | 9df7c7cc82f3909c372c1588da5226f98fe5e650 (patch) | |
| tree | 2315df54a222ac2a3c25471294fdb36ca083d605 /api-docs | |
| parent | 0418561000622602146864421599964744262557 (diff) | |
re-add module level docs lost in docs generator refactor
Diffstat (limited to 'api-docs')
| -rw-r--r-- | api-docs/source/conf.py | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/api-docs/source/conf.py b/api-docs/source/conf.py index 960164bb..a71b23fc 100644 --- a/api-docs/source/conf.py +++ b/api-docs/source/conf.py @@ -159,7 +159,7 @@ Full Class List {underline} ''') - + # Add sub-toctree for parent modules that have nested modules if modulename.count(".") == 0 and modulename in nested_modules and nested_modules[modulename]: modulefile.write(".. toctree::\n") @@ -168,7 +168,12 @@ Full Class List for nested_name, nested_filename in nested_modules[modulename]: modulefile.write(f" {nested_name} <{nested_filename}>\n") modulefile.write("\n") - + + # Include module-level docstring + modulefile.write(f'''.. automodule:: {module.__name__} + +''') + # Generate custom summary table classes = list(classlist(module)) if classes: |