summaryrefslogtreecommitdiffstats
path: root/doc/sphinx/conf.py
diff options
context:
space:
mode:
authorMats Wichmann <mats@linux.com>2020-05-28 14:49:38 (GMT)
committerMats Wichmann <mats@linux.com>2020-05-30 12:48:15 (GMT)
commitbe613a49ef4e12b5b71b6ba1238e6762f29878cd (patch)
treea3050d5852484468d1e35fd41b6262aa75b718de /doc/sphinx/conf.py
parent7ea666723c18c7fbd13fe282697591a0a2fd26d2 (diff)
downloadSCons-be613a49ef4e12b5b71b6ba1238e6762f29878cd.zip
SCons-be613a49ef4e12b5b71b6ba1238e6762f29878cd.tar.gz
SCons-be613a49ef4e12b5b71b6ba1238e6762f29878cd.tar.bz2
sphinx build: drop special members [ci skip]
Opinion time - when special members are included in the docs, the output isn't really readable, it's too cluttered. Don't seem to be able to get the autoclasstoc stuff working, which was supposed to help with that. Signed-off-by: Mats Wichmann <mats@linux.com>
Diffstat (limited to 'doc/sphinx/conf.py')
-rw-r--r--doc/sphinx/conf.py4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/sphinx/conf.py b/doc/sphinx/conf.py
index 141d089..21a982f 100644
--- a/doc/sphinx/conf.py
+++ b/doc/sphinx/conf.py
@@ -44,14 +44,14 @@ autosummary_generate = True
autodoc_default_options = {
"members": True,
- "special-members": True,
+ #"special-members": True,
"private-members": True,
"inherited-members": True,
"undoc-members": True,
"exclude-members": '__weakref__',
}
autodoc_exclude_members = ['*Tests']
-napoleon_include_special_with_doc = True
+napoleon_include_special_with_doc = False
napoleon_include_private_with_doc = True
# Add any paths that contain templates here, relative to this directory.