summaryrefslogtreecommitdiffstats
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
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>
-rwxr-xr-xbin/scons_dev_master.py20
-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.rst894
-rw-r--r--doc/sphinx/SCons.rst17
-rw-r--r--doc/sphinx/conf.py19
-rw-r--r--doc/sphinx/index.rst4
9 files changed, 32 insertions, 1106 deletions
diff --git a/bin/scons_dev_master.py b/bin/scons_dev_master.py
index 5ed7d49..26beb62 100755
--- a/bin/scons_dev_master.py
+++ b/bin/scons_dev_master.py
@@ -33,14 +33,12 @@ PYTHON_PACKAGES = [
]
BUILDING_PACKAGES = [
- 'python-libxml2',
- 'python-libxslt1',
+ 'python3-lxml',
'fop',
- 'python-dev',
- 'python-epydoc',
+ 'python3-dev',
'rpm',
'tar',
- 'lynx'
+ 'lynx',
# additional packages that Bill Deegan's web page suggests
#'docbook-to-man',
@@ -51,15 +49,17 @@ BUILDING_PACKAGES = [
# for ubuntu 9.10
# 'texlive-lang-french'
+ 'python3-sphinx',
+ 'sphinx-rtd-theme-common',
]
DOCUMENTATION_PACKAGES = [
'docbook-doc',
- 'epydoc-doc',
+ 'sphinx-doc',
'gcc-doc',
'pkg-config',
- 'python-doc',
+ 'python3-doc',
'openjdk-8-doc',
'swig-doc',
'texlive-doc',
@@ -79,10 +79,10 @@ TESTING_PACKAGES = [
'm4',
'openssh-client',
'openssh-server',
- 'python-profiler',
- 'python-all-dev',
+ 'python3-profiler',
+ 'python3-line-profiler',
'python3-all-dev',
- 'pypy-dev',
+ 'pypy3-dev',
'rcs',
'rpm',
'openjdk-8-jdk',
diff --git a/doc/sphinx/SCons.Tool.MSCommon.rst b/doc/sphinx/SCons.Tool.MSCommon.rst
deleted file mode 100644
index a9271ae..0000000
--- a/doc/sphinx/SCons.Tool.MSCommon.rst
+++ /dev/null
@@ -1,62 +0,0 @@
-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
deleted file mode 100644
index 33fce97..0000000
--- a/doc/sphinx/SCons.Tool.clangCommon.rst
+++ /dev/null
@@ -1,10 +0,0 @@
-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
deleted file mode 100644
index 3a9e0b6..0000000
--- a/doc/sphinx/SCons.Tool.docbook.rst
+++ /dev/null
@@ -1,10 +0,0 @@
-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
deleted file mode 100644
index 40b2fab..0000000
--- a/doc/sphinx/SCons.Tool.packaging.rst
+++ /dev/null
@@ -1,102 +0,0 @@
-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
index cc5c721..151e6fa 100644
--- a/doc/sphinx/SCons.Tool.rst
+++ b/doc/sphinx/SCons.Tool.rst
@@ -1,900 +1,6 @@
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
---------------
diff --git a/doc/sphinx/SCons.rst b/doc/sphinx/SCons.rst
index 817011b..c92b957 100644
--- a/doc/sphinx/SCons.rst
+++ b/doc/sphinx/SCons.rst
@@ -1,6 +1,14 @@
SCons package
=============
+Module contents
+---------------
+
+.. automodule:: SCons
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
Subpackages
-----------
@@ -200,12 +208,3 @@ SCons.exitfuncs module
: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
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
diff --git a/doc/sphinx/index.rst b/doc/sphinx/index.rst
index 3c3ee0e..eec3750 100644
--- a/doc/sphinx/index.rst
+++ b/doc/sphinx/index.rst
@@ -17,10 +17,6 @@ SCons Project API Documentation
SCons.Scanner
SCons.Script
SCons.Tool
- SCons.Tool.clangCommon
- SCons.Tool.docbook
- SCons.Tool.MSCommon
- SCons.Tool.packaging
SCons.Variables