Skip to content

Commit 5455566

Browse files
committed
fix(docs): show constructor arguments and remove unused autodoc settings
1 parent 9573e0c commit 5455566

1 file changed

Lines changed: 2 additions & 5 deletions

File tree

‎docs/source/conf.py‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,6 @@
3434

3535
# -- General configuration ---------------------------------------------------
3636
extensions = [
37-
"sphinx.ext.autosummary",
38-
"sphinx.ext.autodoc",
3937
"sphinx.ext.mathjax",
4038
"sphinx.ext.viewcode",
4139
"sphinx.ext.napoleon",
@@ -44,9 +42,6 @@
4442
"autoapi.extension",
4543
]
4644

47-
# Autosummary (API stubs)
48-
autosummary_generate = True
49-
5045
# Napoleon: Google-style docstrings
5146
napoleon_google_docstring = True
5247
napoleon_numpy_docstring = False
@@ -61,6 +56,8 @@
6156
autoapi_root = "reference"
6257
autoapi_add_toctree_entry = False
6358
autoapi_member_order = "groupwise"
59+
# Include the __init__ docstring, where the constructor arguments are documented
60+
autoapi_python_class_content = "both"
6461
autoapi_options = [
6562
"members",
6663
"undoc-members",

0 commit comments

Comments
 (0)