summaryrefslogtreecommitdiffstats
path: root/doc/sphinx/conf.py
diff options
context:
space:
mode:
authorMats Wichmann <mats@linux.com>2020-05-24 14:30:34 (GMT)
committerMats Wichmann <mats@linux.com>2020-05-30 12:27:58 (GMT)
commit19bc1520f0fe52662c9fc49a68652730f4544448 (patch)
treeb45c297c77b37cb06fbba2db7e2953793efb2980 /doc/sphinx/conf.py
parent3494131597b69a355474b348a4b890668e9f30be (diff)
downloadSCons-19bc1520f0fe52662c9fc49a68652730f4544448.zip
SCons-19bc1520f0fe52662c9fc49a68652730f4544448.tar.gz
SCons-19bc1520f0fe52662c9fc49a68652730f4544448.tar.bz2
Update sphinx build, add autoclasstoc [ci skip]
autoclasstoc enabled, but not particularly used yet. Signed-off-by: Mats Wichmann <mats@linux.com>
Diffstat (limited to 'doc/sphinx/conf.py')
-rw-r--r--doc/sphinx/conf.py19
1 files changed, 14 insertions, 5 deletions
diff --git a/doc/sphinx/conf.py b/doc/sphinx/conf.py
index 7761910..474f765 100644
--- a/doc/sphinx/conf.py
+++ b/doc/sphinx/conf.py
@@ -31,18 +31,27 @@ needs_sphinx = '1.3'
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
+ 'autoclasstoc',
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
+ #'sphinx.ext.githubpages'
'sphinx.ext.napoleon',
'sphinx.ext.todo',
'sphinx.ext.viewcode',
- 'sphinx.ext.githubpages'
]
autodoc_default_flags = [":members:", ":undoc-members:", ":show-inheritance:"]
+autodoc_default_options = {
+ "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 = False
-napoleon_include_private_with_doc = False
+napoleon_include_special_with_doc = True
+napoleon_include_private_with_doc = True
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -56,9 +65,9 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
-project = 'SCons API'
+project = 'SCons'
copyright = '2020, SCons Project'
-author = 'SCons Project'
+author = 'SCons Project Team'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the