Skip to content

Commit 9df7c7c

Browse files
committed
re-add module level docs lost in docs generator refactor
1 parent 0418561 commit 9df7c7c

1 file changed

Lines changed: 7 additions & 2 deletions

File tree

api-docs/source/conf.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ def generaterst():
159159
{underline}
160160
161161
''')
162-
162+
163163
# Add sub-toctree for parent modules that have nested modules
164164
if modulename.count(".") == 0 and modulename in nested_modules and nested_modules[modulename]:
165165
modulefile.write(".. toctree::\n")
@@ -168,7 +168,12 @@ def generaterst():
168168
for nested_name, nested_filename in nested_modules[modulename]:
169169
modulefile.write(f" {nested_name} <{nested_filename}>\n")
170170
modulefile.write("\n")
171-
171+
172+
# Include module-level docstring
173+
modulefile.write(f'''.. automodule:: {module.__name__}
174+
175+
''')
176+
172177
# Generate custom summary table
173178
classes = list(classlist(module))
174179
if classes:

0 commit comments

Comments
 (0)