Skip to content

Commit 35c9c8f

Browse files
authored
Merge pull request #641 from idaholab/doc_summary
Added autodocsumm to make TOCs in docs
2 parents cf733bc + 7b28bbf commit 35c9c8f

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

doc/source/conf.py

+10-1
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,10 @@
3737
"sphinx.ext.intersphinx",
3838
"sphinx.ext.extlinks",
3939
"sphinx.ext.doctest",
40+
"sphinx_autodoc_typehints",
4041
"sphinx_favicon",
41-
"sphinx_copybutton"
42+
"sphinx_copybutton",
43+
"autodocsumm",
4244
]
4345

4446
# Add any paths that contain templates here, relative to this directory.
@@ -60,6 +62,13 @@
6062

6163
# Display the version
6264
display_version = True
65+
autosummary_generate = True
66+
autosummary_imported_member = True
67+
autodoc_default_options = {
68+
"autosummary": True,
69+
"show-inheritance": True,
70+
"inherited-members": True,
71+
}
6372

6473
# -- External link configuration ---------------------------------------------
6574
UM63 = (

pyproject.toml

+3-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,9 @@ doc = [
5353
"sphinxcontrib-apidoc",
5454
"pydata_sphinx_theme",
5555
"sphinx-favicon",
56-
"sphinx-copybutton"
56+
"sphinx-copybutton",
57+
"sphinx_autodoc_typehints",
58+
"autodocsumm"
5759
]
5860
format = ["black>=23.3.0"]
5961
build = [

0 commit comments

Comments
 (0)