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 <[email protected]>

Author: mwichmann

SCons/Environment.py

@@ -1527,7 +1527,7 @@ def Dump(self, key=None, format='pretty'):
 
         Args:
           key: if None, format the whole dict of variables.
-            Else format just the value for key (Default value = None)       
+            Else format just the value for key (Default value = None)
           format: specify the format of the variables to be serialized:
             - pretty: pretty-printed string.
             - json: JSON-formatted string.

doc/sphinx/conf.py

@@ -44,14 +44,14 @@
 
 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.

doc/sphinx/index.rst

@@ -6,6 +6,15 @@
 SCons Project API Documentation
 ===============================
 
+This is the internal API Documentation for SCons.
+The Documentation is generated using the Sphinx tool.
+The target audience is developers working on SCons itself,
+so it does not clearly delineate what is "Public API" -
+interfaces for use in your SCons configuration scripts
+which have a consistency guarantee, and what is internal,
+so always keep the SCons manual page around for helping
+with such determinations.
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents: