summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMats Wichmann <mats@linux.com>2020-05-06 14:29:03 (GMT)
committerMats Wichmann <mats@linux.com>2020-05-30 12:27:58 (GMT)
commit71ea183f614037fab50a24432363e1833e2809e5 (patch)
tree254520d665ab1d7a99c065e8f21848fbb2b7b1d6
parent19f6d2c0d64928e87383a76146981dbfee1fee1c (diff)
downloadSCons-71ea183f614037fab50a24432363e1833e2809e5.zip
SCons-71ea183f614037fab50a24432363e1833e2809e5.tar.gz
SCons-71ea183f614037fab50a24432363e1833e2809e5.tar.bz2
[WIP] Add Sphinx build of API docs [ci skip]
First cut includes a Makefile as generated by Sphinx plumbling, needs to be wired into sconscripts instead. A few regular scons files are updated to address build errors/warnings. Signed-off-by: Mats Wichmann <mats@linux.com>
-rw-r--r--doc/Makefile20
-rw-r--r--doc/sphinx/SCons.Node.rst38
-rw-r--r--doc/sphinx/SCons.Platform.rst102
-rw-r--r--doc/sphinx/SCons.Scanner.rst86
-rw-r--r--doc/sphinx/SCons.Script.rst46
-rw-r--r--doc/sphinx/SCons.Tool.MSCommon.rst62
-rw-r--r--doc/sphinx/SCons.Tool.clangCommon.rst10
-rw-r--r--doc/sphinx/SCons.Tool.docbook.rst10
-rw-r--r--doc/sphinx/SCons.Tool.packaging.rst102
-rw-r--r--doc/sphinx/SCons.Tool.rst904
-rw-r--r--doc/sphinx/SCons.Variables.rst54
-rw-r--r--doc/sphinx/SCons.compat.rst10
-rw-r--r--doc/sphinx/SCons.rst211
-rw-r--r--doc/sphinx/conf.py189
-rw-r--r--doc/sphinx/index.rst32
15 files changed, 1876 insertions, 0 deletions
diff --git a/doc/Makefile b/doc/Makefile
new file mode 100644
index 0000000..4da19e3
--- /dev/null
+++ b/doc/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+SPHINXPROJ = SCons
+SOURCEDIR = sphinx
+BUILDDIR = ../build/doc/api
+
+# Put it first so that "make" without argument is like "make help".
+help:
+ @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+ @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/doc/sphinx/SCons.Node.rst b/doc/sphinx/SCons.Node.rst
new file mode 100644
index 0000000..b6d5c8f
--- /dev/null
+++ b/doc/sphinx/SCons.Node.rst
@@ -0,0 +1,38 @@
+SCons.Node package
+==================
+
+Submodules
+----------
+
+SCons.Node.Alias module
+-----------------------
+
+.. automodule:: SCons.Node.Alias
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Node.FS module
+--------------------
+
+.. automodule:: SCons.Node.FS
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Node.Python module
+------------------------
+
+.. automodule:: SCons.Node.Python
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: SCons.Node
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/sphinx/SCons.Platform.rst b/doc/sphinx/SCons.Platform.rst
new file mode 100644
index 0000000..8a55744
--- /dev/null
+++ b/doc/sphinx/SCons.Platform.rst
@@ -0,0 +1,102 @@
+SCons.Platform package
+======================
+
+Submodules
+----------
+
+SCons.Platform.aix module
+-------------------------
+
+.. automodule:: SCons.Platform.aix
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Platform.cygwin module
+----------------------------
+
+.. automodule:: SCons.Platform.cygwin
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Platform.darwin module
+----------------------------
+
+.. automodule:: SCons.Platform.darwin
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Platform.hpux module
+--------------------------
+
+.. automodule:: SCons.Platform.hpux
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Platform.irix module
+--------------------------
+
+.. automodule:: SCons.Platform.irix
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Platform.mingw module
+---------------------------
+
+.. automodule:: SCons.Platform.mingw
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Platform.os2 module
+-------------------------
+
+.. automodule:: SCons.Platform.os2
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Platform.posix module
+---------------------------
+
+.. automodule:: SCons.Platform.posix
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Platform.sunos module
+---------------------------
+
+.. automodule:: SCons.Platform.sunos
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Platform.virtualenv module
+--------------------------------
+
+.. automodule:: SCons.Platform.virtualenv
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Platform.win32 module
+---------------------------
+
+.. automodule:: SCons.Platform.win32
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: SCons.Platform
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/sphinx/SCons.Scanner.rst b/doc/sphinx/SCons.Scanner.rst
new file mode 100644
index 0000000..181dbde
--- /dev/null
+++ b/doc/sphinx/SCons.Scanner.rst
@@ -0,0 +1,86 @@
+SCons.Scanner package
+=====================
+
+Submodules
+----------
+
+SCons.Scanner.C module
+----------------------
+
+.. automodule:: SCons.Scanner.C
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Scanner.D module
+----------------------
+
+.. automodule:: SCons.Scanner.D
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Scanner.Dir module
+------------------------
+
+.. automodule:: SCons.Scanner.Dir
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Scanner.Fortran module
+----------------------------
+
+.. automodule:: SCons.Scanner.Fortran
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Scanner.IDL module
+------------------------
+
+.. automodule:: SCons.Scanner.IDL
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Scanner.LaTeX module
+--------------------------
+
+.. automodule:: SCons.Scanner.LaTeX
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Scanner.Prog module
+-------------------------
+
+.. automodule:: SCons.Scanner.Prog
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Scanner.RC module
+-----------------------
+
+.. automodule:: SCons.Scanner.RC
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Scanner.SWIG module
+-------------------------
+
+.. automodule:: SCons.Scanner.SWIG
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: SCons.Scanner
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/sphinx/SCons.Script.rst b/doc/sphinx/SCons.Script.rst
new file mode 100644
index 0000000..704b8fa
--- /dev/null
+++ b/doc/sphinx/SCons.Script.rst
@@ -0,0 +1,46 @@
+SCons.Script package
+====================
+
+Submodules
+----------
+
+SCons.Script.Interactive module
+-------------------------------
+
+.. automodule:: SCons.Script.Interactive
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Script.Main module
+------------------------
+
+.. automodule:: SCons.Script.Main
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Script.SConsOptions module
+--------------------------------
+
+.. automodule:: SCons.Script.SConsOptions
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Script.SConscript module
+------------------------------
+
+.. automodule:: SCons.Script.SConscript
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: SCons.Script
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/sphinx/SCons.Tool.MSCommon.rst b/doc/sphinx/SCons.Tool.MSCommon.rst
new file mode 100644
index 0000000..a9271ae
--- /dev/null
+++ b/doc/sphinx/SCons.Tool.MSCommon.rst
@@ -0,0 +1,62 @@
+SCons.Tool.MSCommon package
+===========================
+
+Submodules
+----------
+
+SCons.Tool.MSCommon.arch module
+-------------------------------
+
+.. automodule:: SCons.Tool.MSCommon.arch
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.MSCommon.common module
+---------------------------------
+
+.. automodule:: SCons.Tool.MSCommon.common
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.MSCommon.netframework module
+---------------------------------------
+
+.. automodule:: SCons.Tool.MSCommon.netframework
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.MSCommon.sdk module
+------------------------------
+
+.. automodule:: SCons.Tool.MSCommon.sdk
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.MSCommon.vc module
+-----------------------------
+
+.. automodule:: SCons.Tool.MSCommon.vc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.MSCommon.vs module
+-----------------------------
+
+.. automodule:: SCons.Tool.MSCommon.vs
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: SCons.Tool.MSCommon
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/sphinx/SCons.Tool.clangCommon.rst b/doc/sphinx/SCons.Tool.clangCommon.rst
new file mode 100644
index 0000000..33fce97
--- /dev/null
+++ b/doc/sphinx/SCons.Tool.clangCommon.rst
@@ -0,0 +1,10 @@
+SCons.Tool.clangCommon package
+==============================
+
+Module contents
+---------------
+
+.. automodule:: SCons.Tool.clangCommon
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/sphinx/SCons.Tool.docbook.rst b/doc/sphinx/SCons.Tool.docbook.rst
new file mode 100644
index 0000000..3a9e0b6
--- /dev/null
+++ b/doc/sphinx/SCons.Tool.docbook.rst
@@ -0,0 +1,10 @@
+SCons.Tool.docbook package
+==========================
+
+Module contents
+---------------
+
+.. automodule:: SCons.Tool.docbook
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/sphinx/SCons.Tool.packaging.rst b/doc/sphinx/SCons.Tool.packaging.rst
new file mode 100644
index 0000000..40b2fab
--- /dev/null
+++ b/doc/sphinx/SCons.Tool.packaging.rst
@@ -0,0 +1,102 @@
+SCons.Tool.packaging package
+============================
+
+Submodules
+----------
+
+SCons.Tool.packaging.ipk module
+-------------------------------
+
+.. automodule:: SCons.Tool.packaging.ipk
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.packaging.msi module
+-------------------------------
+
+.. automodule:: SCons.Tool.packaging.msi
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.packaging.rpm module
+-------------------------------
+
+.. automodule:: SCons.Tool.packaging.rpm
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.packaging.src\_tarbz2 module
+---------------------------------------
+
+.. automodule:: SCons.Tool.packaging.src_tarbz2
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.packaging.src\_targz module
+--------------------------------------
+
+.. automodule:: SCons.Tool.packaging.src_targz
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.packaging.src\_tarxz module
+--------------------------------------
+
+.. automodule:: SCons.Tool.packaging.src_tarxz
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.packaging.src\_zip module
+------------------------------------
+
+.. automodule:: SCons.Tool.packaging.src_zip
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.packaging.tarbz2 module
+----------------------------------
+
+.. automodule:: SCons.Tool.packaging.tarbz2
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.packaging.targz module
+---------------------------------
+
+.. automodule:: SCons.Tool.packaging.targz
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.packaging.tarxz module
+---------------------------------
+
+.. automodule:: SCons.Tool.packaging.tarxz
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.packaging.zip module
+-------------------------------
+
+.. automodule:: SCons.Tool.packaging.zip
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: SCons.Tool.packaging
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/sphinx/SCons.Tool.rst b/doc/sphinx/SCons.Tool.rst
new file mode 100644
index 0000000..cc5c721
--- /dev/null
+++ b/doc/sphinx/SCons.Tool.rst
@@ -0,0 +1,904 @@
+SCons.Tool package
+==================
+
+Subpackages
+-----------
+
+.. toctree::
+
+ SCons.Tool.MSCommon
+ SCons.Tool.clangCommon
+ SCons.Tool.docbook
+ SCons.Tool.packaging
+
+Submodules
+----------
+
+SCons.Tool.386asm module
+------------------------
+
+.. automodule:: SCons.Tool.386asm
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.DCommon module
+-------------------------
+
+.. automodule:: SCons.Tool.DCommon
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.FortranCommon module
+-------------------------------
+
+.. automodule:: SCons.Tool.FortranCommon
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.GettextCommon module
+-------------------------------
+
+.. automodule:: SCons.Tool.GettextCommon
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.JavaCommon module
+----------------------------
+
+.. automodule:: SCons.Tool.JavaCommon
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.PharLapCommon module
+-------------------------------
+
+.. automodule:: SCons.Tool.PharLapCommon
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.aixc\+\+ module
+--------------------------
+
+.. automodule:: SCons.Tool.aixc++
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.aixcc module
+-----------------------
+
+.. automodule:: SCons.Tool.aixcc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.aixcxx module
+------------------------
+
+.. automodule:: SCons.Tool.aixcxx
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.aixf77 module
+------------------------
+
+.. automodule:: SCons.Tool.aixf77
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.aixlink module
+-------------------------
+
+.. automodule:: SCons.Tool.aixlink
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.applelink module
+---------------------------
+
+.. automodule:: SCons.Tool.applelink
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.ar module
+--------------------
+
+.. automodule:: SCons.Tool.ar
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.as module
+--------------------
+
+.. automodule:: SCons.Tool.as
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.bcc32 module
+-----------------------
+
+.. automodule:: SCons.Tool.bcc32
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.c\+\+ module
+-----------------------
+
+.. automodule:: SCons.Tool.c++
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.cc module
+--------------------
+
+.. automodule:: SCons.Tool.cc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.clang module
+-----------------------
+
+.. automodule:: SCons.Tool.clang
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.clangxx module
+-------------------------
+
+.. automodule:: SCons.Tool.clangxx
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.cvf module
+---------------------
+
+.. automodule:: SCons.Tool.cvf
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.cxx module
+---------------------
+
+.. automodule:: SCons.Tool.cxx
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.cyglink module
+-------------------------
+
+.. automodule:: SCons.Tool.cyglink
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.default module
+-------------------------
+
+.. automodule:: SCons.Tool.default
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.dmd module
+---------------------
+
+.. automodule:: SCons.Tool.dmd
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.dvi module
+---------------------
+
+.. automodule:: SCons.Tool.dvi
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.dvipdf module
+------------------------
+
+.. automodule:: SCons.Tool.dvipdf
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.dvips module
+-----------------------
+
+.. automodule:: SCons.Tool.dvips
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.f03 module
+---------------------
+
+.. automodule:: SCons.Tool.f03
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.f08 module
+---------------------
+
+.. automodule:: SCons.Tool.f08
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.f77 module
+---------------------
+
+.. automodule:: SCons.Tool.f77
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.f90 module
+---------------------
+
+.. automodule:: SCons.Tool.f90
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.f95 module
+---------------------
+
+.. automodule:: SCons.Tool.f95
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.filesystem module
+----------------------------
+
+.. automodule:: SCons.Tool.filesystem
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.fortran module
+-------------------------
+
+.. automodule:: SCons.Tool.fortran
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.g\+\+ module
+-----------------------
+
+.. automodule:: SCons.Tool.g++
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.g77 module
+---------------------
+
+.. automodule:: SCons.Tool.g77
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.gas module
+---------------------
+
+.. automodule:: SCons.Tool.gas
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.gcc module
+---------------------
+
+.. automodule:: SCons.Tool.gcc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.gdc module
+---------------------
+
+.. automodule:: SCons.Tool.gdc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.gettext\_tool module
+-------------------------------
+
+.. automodule:: SCons.Tool.gettext_tool
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.gfortran module
+--------------------------
+
+.. automodule:: SCons.Tool.gfortran
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.gnulink module
+-------------------------
+
+.. automodule:: SCons.Tool.gnulink
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.gs module
+--------------------
+
+.. automodule:: SCons.Tool.gs
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.gxx module
+---------------------
+
+.. automodule:: SCons.Tool.gxx
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.hpc\+\+ module
+-------------------------
+
+.. automodule:: SCons.Tool.hpc++
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.hpcc module
+----------------------
+
+.. automodule:: SCons.Tool.hpcc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.hpcxx module
+-----------------------
+
+.. automodule:: SCons.Tool.hpcxx
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.hplink module
+------------------------
+
+.. automodule:: SCons.Tool.hplink
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.icc module
+---------------------
+
+.. automodule:: SCons.Tool.icc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.icl module
+---------------------
+
+.. automodule:: SCons.Tool.icl
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.ifl module
+---------------------
+
+.. automodule:: SCons.Tool.ifl
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.ifort module
+-----------------------
+
+.. automodule:: SCons.Tool.ifort
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.ilink module
+-----------------------
+
+.. automodule:: SCons.Tool.ilink
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.ilink32 module
+-------------------------
+
+.. automodule:: SCons.Tool.ilink32
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.install module
+-------------------------
+
+.. automodule:: SCons.Tool.install
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.intelc module
+------------------------
+
+.. automodule:: SCons.Tool.intelc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.ipkg module
+----------------------
+
+.. automodule:: SCons.Tool.ipkg
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.jar module
+---------------------
+
+.. automodule:: SCons.Tool.jar
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.javac module
+-----------------------
+
+.. automodule:: SCons.Tool.javac
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.javah module
+-----------------------
+
+.. automodule:: SCons.Tool.javah
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.latex module
+-----------------------
+
+.. automodule:: SCons.Tool.latex
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.ldc module
+---------------------
+
+.. automodule:: SCons.Tool.ldc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.lex module
+---------------------
+
+.. automodule:: SCons.Tool.lex
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.link module
+----------------------
+
+.. automodule:: SCons.Tool.link
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.linkloc module
+-------------------------
+
+.. automodule:: SCons.Tool.linkloc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.m4 module
+--------------------
+
+.. automodule:: SCons.Tool.m4
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.masm module
+----------------------
+
+.. automodule:: SCons.Tool.masm
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.midl module
+----------------------
+
+.. automodule:: SCons.Tool.midl
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.mingw module
+-----------------------
+
+.. automodule:: SCons.Tool.mingw
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.msgfmt module
+------------------------
+
+.. automodule:: SCons.Tool.msgfmt
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.msginit module
+-------------------------
+
+.. automodule:: SCons.Tool.msginit
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.msgmerge module
+--------------------------
+
+.. automodule:: SCons.Tool.msgmerge
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.mslib module
+-----------------------
+
+.. automodule:: SCons.Tool.mslib
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.mslink module
+------------------------
+
+.. automodule:: SCons.Tool.mslink
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.mssdk module
+-----------------------
+
+.. automodule:: SCons.Tool.mssdk
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.msvc module
+----------------------
+
+.. automodule:: SCons.Tool.msvc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.msvs module
+----------------------
+
+.. automodule:: SCons.Tool.msvs
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.mwcc module
+----------------------
+
+.. automodule:: SCons.Tool.mwcc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.mwld module
+----------------------
+
+.. automodule:: SCons.Tool.mwld
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.nasm module
+----------------------
+
+.. automodule:: SCons.Tool.nasm
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.pdf module
+---------------------
+
+.. automodule:: SCons.Tool.pdf
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.pdflatex module
+--------------------------
+
+.. automodule:: SCons.Tool.pdflatex
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.pdftex module
+------------------------
+
+.. automodule:: SCons.Tool.pdftex
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.qt module
+--------------------
+
+.. automodule:: SCons.Tool.qt
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.rmic module
+----------------------
+
+.. automodule:: SCons.Tool.rmic
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.rpcgen module
+------------------------
+
+.. automodule:: SCons.Tool.rpcgen
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.rpm module
+---------------------
+
+.. automodule:: SCons.Tool.rpm
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.rpmutils module
+--------------------------
+
+.. automodule:: SCons.Tool.rpmutils
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.sgiar module
+-----------------------
+
+.. automodule:: SCons.Tool.sgiar
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.sgic\+\+ module
+--------------------------
+
+.. automodule:: SCons.Tool.sgic++
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.sgicc module
+-----------------------
+
+.. automodule:: SCons.Tool.sgicc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.sgicxx module
+------------------------
+
+.. automodule:: SCons.Tool.sgicxx
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.sgilink module
+-------------------------
+
+.. automodule:: SCons.Tool.sgilink
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.sunar module
+-----------------------
+
+.. automodule:: SCons.Tool.sunar
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.sunc\+\+ module
+--------------------------
+
+.. automodule:: SCons.Tool.sunc++
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.suncc module
+-----------------------
+
+.. automodule:: SCons.Tool.suncc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.suncxx module
+------------------------
+
+.. automodule:: SCons.Tool.suncxx
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.sunf77 module
+------------------------
+
+.. automodule:: SCons.Tool.sunf77
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.sunf90 module
+------------------------
+
+.. automodule:: SCons.Tool.sunf90
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.sunf95 module
+------------------------
+
+.. automodule:: SCons.Tool.sunf95
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.sunlink module
+-------------------------
+
+.. automodule:: SCons.Tool.sunlink
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.swig module
+----------------------
+
+.. automodule:: SCons.Tool.swig
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.tar module
+---------------------
+
+.. automodule:: SCons.Tool.tar
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.tex module
+---------------------
+
+.. automodule:: SCons.Tool.tex
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.textfile module
+--------------------------
+
+.. automodule:: SCons.Tool.textfile
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.tlib module
+----------------------
+
+.. automodule:: SCons.Tool.tlib
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.wix module
+---------------------
+
+.. automodule:: SCons.Tool.wix
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.xgettext module
+--------------------------
+
+.. automodule:: SCons.Tool.xgettext
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.yacc module
+----------------------
+
+.. automodule:: SCons.Tool.yacc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Tool.zip module
+---------------------
+
+.. automodule:: SCons.Tool.zip
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: SCons.Tool
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/sphinx/SCons.Variables.rst b/doc/sphinx/SCons.Variables.rst
new file mode 100644
index 0000000..dc2388a
--- /dev/null
+++ b/doc/sphinx/SCons.Variables.rst
@@ -0,0 +1,54 @@
+SCons.Variables package
+=======================
+
+Submodules
+----------
+
+SCons.Variables.BoolVariable module
+-----------------------------------
+
+.. automodule:: SCons.Variables.BoolVariable
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Variables.EnumVariable module
+-----------------------------------
+
+.. automodule:: SCons.Variables.EnumVariable
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Variables.ListVariable module
+-----------------------------------
+
+.. automodule:: SCons.Variables.ListVariable
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Variables.PackageVariable module
+--------------------------------------
+
+.. automodule:: SCons.Variables.PackageVariable
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Variables.PathVariable module
+-----------------------------------
+
+.. automodule:: SCons.Variables.PathVariable
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: SCons.Variables
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/sphinx/SCons.compat.rst b/doc/sphinx/SCons.compat.rst
new file mode 100644
index 0000000..d80b555
--- /dev/null
+++ b/doc/sphinx/SCons.compat.rst
@@ -0,0 +1,10 @@
+SCons.compat package
+====================
+
+Module contents
+---------------
+
+.. automodule:: SCons.compat
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/sphinx/SCons.rst b/doc/sphinx/SCons.rst
new file mode 100644
index 0000000..817011b
--- /dev/null
+++ b/doc/sphinx/SCons.rst
@@ -0,0 +1,211 @@
+SCons package
+=============
+
+Subpackages
+-----------
+
+.. toctree::
+
+ SCons.Node
+ SCons.Platform
+ SCons.Scanner
+ SCons.Script
+ SCons.Tool
+ SCons.Variables
+ SCons.compat
+
+Submodules
+----------
+
+SCons.Action module
+-------------------
+
+.. automodule:: SCons.Action
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Builder module
+--------------------
+
+.. automodule:: SCons.Builder
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.CacheDir module
+---------------------
+
+.. automodule:: SCons.CacheDir
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Conftest module
+---------------------
+
+.. automodule:: SCons.Conftest
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Debug module
+------------------
+
+.. automodule:: SCons.Debug
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Defaults module
+---------------------
+
+.. automodule:: SCons.Defaults
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Environment module
+------------------------
+
+.. automodule:: SCons.Environment
+ :members:
+ :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
+-------------------
+
+.. automodule:: SCons.Errors
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Executor module
+---------------------
+
+.. automodule:: SCons.Executor
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Job module
+----------------
+
+.. automodule:: SCons.Job
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Memoize module
+--------------------
+
+.. automodule:: SCons.Memoize
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.PathList module
+---------------------
+
+.. automodule:: SCons.PathList
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.SConf module
+------------------
+
+.. automodule:: SCons.SConf
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.SConsign module
+---------------------
+
+.. automodule:: SCons.SConsign
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Subst module
+------------------
+
+.. automodule:: SCons.Subst
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Taskmaster module
+-----------------------
+
+.. automodule:: SCons.Taskmaster
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Util module
+-----------------
+
+.. automodule:: SCons.Util
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.Warnings module
+---------------------
+
+.. automodule:: SCons.Warnings
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.cpp module
+----------------
+
+.. automodule:: SCons.cpp
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.dblite module
+-------------------
+
+.. automodule:: SCons.dblite
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SCons.exitfuncs module
+----------------------
+
+.. automodule:: SCons.exitfuncs
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: SCons
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/sphinx/conf.py b/doc/sphinx/conf.py
new file mode 100644
index 0000000..7761910
--- /dev/null
+++ b/doc/sphinx/conf.py
@@ -0,0 +1,189 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# SCons documentation build configuration file, created by
+# sphinx-quickstart on Mon Apr 30 09:36:53 2018.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../../src/engine/'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+needs_sphinx = '1.3'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+ 'sphinx.ext.autodoc',
+ 'sphinx.ext.autosummary',
+ 'sphinx.ext.napoleon',
+ 'sphinx.ext.todo',
+ 'sphinx.ext.viewcode',
+ 'sphinx.ext.githubpages'
+]
+
+autodoc_default_flags = [":members:", ":undoc-members:", ":show-inheritance:"]
+autodoc_exclude_members = ['*Tests']
+napoleon_include_special_with_doc = False
+napoleon_include_private_with_doc = False
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'SCons API'
+copyright = '2020, SCons Project'
+author = 'SCons Project'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '4.0'
+# The full version, including alpha/beta/rc tags.
+release = '4.0.0a1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path .
+exclude_patterns = ["*Tests.py"]
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+#
+#html_theme = 'alabaster'
+html_theme = 'classic'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself. Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'SConsAPIDocs'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+ # The paper size ('letterpaper' or 'a4paper').
+ #
+ # 'papersize': 'letterpaper',
+
+ # The font size ('10pt', '11pt' or '12pt').
+ #
+ # 'pointsize': '10pt',
+
+ # Additional stuff for the LaTeX preamble.
+ #
+ # 'preamble': '',
+
+ # Latex figure (float) alignment
+ #
+ # 'figure_align': 'htbp',
+}
+
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+# author, documentclass [howto, manual, or own class]).
+latex_documents = [
+ (
+ master_doc,
+ "SConsAPIDocs.tex",
+ "SCons API Documentation",
+ "SCons Project",
+ "manual",
+ )
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ (master_doc, 'sconsapidocs', 'SCons API Documentation', [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ (
+ master_doc,
+ "SConsAPIDocs",
+ "SCons API Documentation",
+ author,
+ "SConsAPIDocs",
+ "One line description of project.",
+ "Miscellaneous",
+ )
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
diff --git a/doc/sphinx/index.rst b/doc/sphinx/index.rst
new file mode 100644
index 0000000..996d258
--- /dev/null
+++ b/doc/sphinx/index.rst
@@ -0,0 +1,32 @@
+.. SCons documentation master file, created by
+ sphinx-quickstart on Mon Apr 30 09:36:53 2018.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+SCons Project API Documentation
+===============================
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+
+ SCons
+ SCons.compat
+ SCons.Node
+ SCons.Platform
+ SCons.Scanner
+ SCons.Script
+ SCons.Tool
+ SCons.Tool.clangCommon
+ SCons.Tool.docbook
+ SCons.Tool.MSCommon
+ SCons.Tool.packaging.
+ SCons.Variables
+
+
+Indices and Tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`