Skip to content

Commit 3ad23d6

Browse files
committed
[no ci] docs: adaptations for v1.1.6
1 parent 77e76a1 commit 3ad23d6

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

docsrc/source/conf.py

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,16 @@
5656
"sphinx.ext.intersphinx",
5757
"sphinx_design",
5858
"sphinxcontrib.bibtex",
59-
"override_pst_pagetoc", # local, see sphinxext folder
60-
"adapt_autodoc_docstring", # local, see sphinxext folder
6159
]
6260

61+
if not current.startswith("v1."):
62+
extensions.extend(
63+
[
64+
"override_pst_pagetoc", # local, see sphinxext folder
65+
"adapt_autodoc_docstring", # local, see sphinxext folder
66+
]
67+
)
68+
6369
intersphinx_mapping = {
6470
"python": ("https://docs.python.org/3", None),
6571
"numpy": ("https://numpy.org/doc/stable", None),
@@ -99,11 +105,21 @@
99105
# Options for autodoc and autosummary
100106
# do not ignore __all__, use it to determine public members
101107
autosummary_ignore_module_all = False
102-
# include imported members in autosummary
103108
autosummary_imported_members = False
104109
# selects content to insert into the main body of an autoclass directive.
105110
autoclass_content = "both"
106111

112+
if current.startswith("v1."):
113+
autodoc_default_options = {
114+
"members": True,
115+
"undoc-members": True,
116+
"imported-members": False,
117+
"inherited-members": True,
118+
"show-inheritance": True,
119+
"special-members": "__call__",
120+
"memberorder": "bysource",
121+
}
122+
107123
# -- Options for HTML output -------------------------------------------------
108124

109125
# The theme to use for HTML and HTML Help pages. See the documentation for

0 commit comments

Comments
 (0)