A bit more sphinx docbuild tweaking [ci skip]

Signed-off-by: Mats Wichmann <[email protected]>

Author: mwichmann

SCons/Environment.py

@@ -1500,7 +1500,7 @@ def Detect(self, progs):
 
 
     def Dictionary(self, *args):
-        """Return construction variables from an environment.
+        r"""Return construction variables from an environment.
 
         :param args: (optional) variable names to look up
         :returns: if args omitted, the dictionary of all constr. vars.

SCons/Platform/__init__.py

@@ -56,9 +56,9 @@
 
 
 def platform_default():
-    """Return the platform string for our execution environment.
+    r"""Return the platform string for our execution environment.
 
-    The returned value should map to one of the SCons/Platform/\*.py
+    The returned value should map to one of the SCons/Platform/*.py
     files.  Since scons is architecture independent, though, we don't
     care about the machine architecture.
     """
@@ -131,29 +131,30 @@ def __str__(self):
 
 
 class TempFileMunge:
-    """A callable class.  You can set an Environment variable to this,
+    """A callable class to enable temp files for long command lines.
+
+    You can set an Environment variable to this,
     then call it with a string argument, then it will perform temporary
     file substitution on it.  This is used to circumvent the long command
-    line limitation.
-
-    Example:
+    line limitation.  Example::
 
         env["TEMPFILE"] = TempFileMunge
         env["LINKCOM"] = "${TEMPFILE('$LINK $TARGET $SOURCES','$LINKCOMSTR')}"
 
     By default, the name of the temporary file used begins with a
     prefix of '@'.  This may be configured for other tool chains by
-    setting '$TEMPFILEPREFIX'. Example:
+    setting '$TEMPFILEPREFIX'. Example::
 
         env["TEMPFILEPREFIX"] = '-@'        # diab compiler
         env["TEMPFILEPREFIX"] = '-via'      # arm tool chain
         env["TEMPFILEPREFIX"] = ''          # (the empty string) PC Lint
 
     You can configure the extension of the temporary file through the
     TEMPFILESUFFIX variable, which defaults to '.lnk' (see comments
-    in the code below). Example:
+    in the code below). Example::
 
         env["TEMPFILESUFFIX"] = '.lnt'   # PC Lint
+
     """
     def __init__(self, cmd, cmdstr = None):
         self.cmd = cmd

SCons/Script/SConsOptions.py

@@ -347,8 +347,8 @@ def reparse_local_options(self):
         below. When called from there, we try to reparse the
         command-line arguments that:
 
-          1. haven't been processed so far (self.largs), but
-          2. are possibly not added to the list of options yet.
+        1. haven't been processed so far (self.largs), but
+        2. are possibly not added to the list of options yet.
 
         So, when we only have a value for "--myargument" yet,
         a command-line argument of "--myarg=test" would set it.

SCons/dblite.py

@@ -37,6 +37,7 @@ class dblite:
 
     See the discussion at:
       http://mail.python.org/pipermail/python-bugs-list/2003-March/016877.html
+
     """
 
     _open = open

doc/sphinx/SCons.rst

@@ -81,22 +81,6 @@ SCons.Environment module
     :undoc-members:
     :show-inheritance:
 
-SCons.EnvironmentValues module
-------------------------------
-
-.. automodule:: SCons.EnvironmentValues
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-SCons.EnvironmentValuesTest module
-----------------------------------
-
-.. automodule:: SCons.EnvironmentValuesTest
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 SCons.Errors module
 -------------------
 

doc/sphinx/conf.py

@@ -40,7 +40,8 @@
     'sphinx.ext.viewcode',
 ]
 
-autodoc_default_flags = [":members:", ":undoc-members:", ":show-inheritance:"]
+autosummary_generate = True
+
 autodoc_default_options = {
     "members": True,
     "special-members": True,