Skip to content

Commit 07ba471

Browse files
bdbaddogbdbaddog
authored
Merge pull request #3641 from mwichmann/wip-sphinx-apidocs
Initial logic for Sphinx build of API docs - replacing epydoc
2 parents ce32ce7 + 261f1d1 commit 07ba471

File tree

12 files changed

+806
-10
lines changed

12 files changed

+806
-10
lines changed

‎bin/scons_dev_master.py‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,12 @@
3333
]
3434

3535
BUILDING_PACKAGES = [
36-
'python-libxml2',
37-
'python-libxslt1',
36+
'python3-lxml',
3837
'fop',
39-
'python-dev',
40-
'python-epydoc',
38+
'python3-dev',
4139
'rpm',
4240
'tar',
43-
'lynx'
41+
'lynx',
4442

4543
# additional packages that Bill Deegan's web page suggests
4644
#'docbook-to-man',
@@ -51,15 +49,17 @@
5149

5250
# for ubuntu 9.10
5351
# 'texlive-lang-french'
52+
'python3-sphinx',
53+
'sphinx-rtd-theme-common',
5454

5555
]
5656

5757
DOCUMENTATION_PACKAGES = [
5858
'docbook-doc',
59-
'epydoc-doc',
59+
'sphinx-doc',
6060
'gcc-doc',
6161
'pkg-config',
62-
'python-doc',
62+
'python3-doc',
6363
'openjdk-8-doc',
6464
'swig-doc',
6565
'texlive-doc',
@@ -79,10 +79,10 @@
7979
'm4',
8080
'openssh-client',
8181
'openssh-server',
82-
'python-profiler',
83-
'python-all-dev',
82+
'python3-profiler',
83+
'python3-line-profiler',
8484
'python3-all-dev',
85-
'pypy-dev',
85+
'pypy3-dev',
8686
'rcs',
8787
'rpm',
8888
'openjdk-8-jdk',

‎doc/Makefile‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
SPHINXPROJ = SCons
8+
SOURCEDIR = sphinx
9+
BUILDDIR = ../build/doc/api
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎doc/sphinx/SCons.Node.rst‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
SCons.Node package
2+
==================
3+
4+
Submodules
5+
----------
6+
7+
SCons.Node.Alias module
8+
-----------------------
9+
10+
.. automodule:: SCons.Node.Alias
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
SCons.Node.FS module
16+
--------------------
17+
18+
.. automodule:: SCons.Node.FS
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
SCons.Node.Python module
24+
------------------------
25+
26+
.. automodule:: SCons.Node.Python
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
32+
Module contents
33+
---------------
34+
35+
.. automodule:: SCons.Node
36+
:members:
37+
:undoc-members:
38+
:show-inheritance:

‎doc/sphinx/SCons.Platform.rst‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
SCons.Platform package
2+
======================
3+
4+
Submodules
5+
----------
6+
7+
SCons.Platform.aix module
8+
-------------------------
9+
10+
.. automodule:: SCons.Platform.aix
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
SCons.Platform.cygwin module
16+
----------------------------
17+
18+
.. automodule:: SCons.Platform.cygwin
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
SCons.Platform.darwin module
24+
----------------------------
25+
26+
.. automodule:: SCons.Platform.darwin
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
SCons.Platform.hpux module
32+
--------------------------
33+
34+
.. automodule:: SCons.Platform.hpux
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
SCons.Platform.irix module
40+
--------------------------
41+
42+
.. automodule:: SCons.Platform.irix
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
SCons.Platform.mingw module
48+
---------------------------
49+
50+
.. automodule:: SCons.Platform.mingw
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
55+
SCons.Platform.os2 module
56+
-------------------------
57+
58+
.. automodule:: SCons.Platform.os2
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:
62+
63+
SCons.Platform.posix module
64+
---------------------------
65+
66+
.. automodule:: SCons.Platform.posix
67+
:members:
68+
:undoc-members:
69+
:show-inheritance:
70+
71+
SCons.Platform.sunos module
72+
---------------------------
73+
74+
.. automodule:: SCons.Platform.sunos
75+
:members:
76+
:undoc-members:
77+
:show-inheritance:
78+
79+
SCons.Platform.virtualenv module
80+
--------------------------------
81+
82+
.. automodule:: SCons.Platform.virtualenv
83+
:members:
84+
:undoc-members:
85+
:show-inheritance:
86+
87+
SCons.Platform.win32 module
88+
---------------------------
89+
90+
.. automodule:: SCons.Platform.win32
91+
:members:
92+
:undoc-members:
93+
:show-inheritance:
94+
95+
96+
Module contents
97+
---------------
98+
99+
.. automodule:: SCons.Platform
100+
:members:
101+
:undoc-members:
102+
:show-inheritance:

‎doc/sphinx/SCons.Scanner.rst‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
SCons.Scanner package
2+
=====================
3+
4+
Submodules
5+
----------
6+
7+
SCons.Scanner.C module
8+
----------------------
9+
10+
.. automodule:: SCons.Scanner.C
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
SCons.Scanner.D module
16+
----------------------
17+
18+
.. automodule:: SCons.Scanner.D
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
SCons.Scanner.Dir module
24+
------------------------
25+
26+
.. automodule:: SCons.Scanner.Dir
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
SCons.Scanner.Fortran module
32+
----------------------------
33+
34+
.. automodule:: SCons.Scanner.Fortran
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
SCons.Scanner.IDL module
40+
------------------------
41+
42+
.. automodule:: SCons.Scanner.IDL
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
SCons.Scanner.LaTeX module
48+
--------------------------
49+
50+
.. automodule:: SCons.Scanner.LaTeX
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
55+
SCons.Scanner.Prog module
56+
-------------------------
57+
58+
.. automodule:: SCons.Scanner.Prog
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:
62+
63+
SCons.Scanner.RC module
64+
-----------------------
65+
66+
.. automodule:: SCons.Scanner.RC
67+
:members:
68+
:undoc-members:
69+
:show-inheritance:
70+
71+
SCons.Scanner.SWIG module
72+
-------------------------
73+
74+
.. automodule:: SCons.Scanner.SWIG
75+
:members:
76+
:undoc-members:
77+
:show-inheritance:
78+
79+
80+
Module contents
81+
---------------
82+
83+
.. automodule:: SCons.Scanner
84+
:members:
85+
:undoc-members:
86+
:show-inheritance:

‎doc/sphinx/SCons.Script.rst‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
SCons.Script package
2+
====================
3+
4+
Submodules
5+
----------
6+
7+
SCons.Script.Interactive module
8+
-------------------------------
9+
10+
.. automodule:: SCons.Script.Interactive
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
SCons.Script.Main module
16+
------------------------
17+
18+
.. automodule:: SCons.Script.Main
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
SCons.Script.SConsOptions module
24+
--------------------------------
25+
26+
.. automodule:: SCons.Script.SConsOptions
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
SCons.Script.SConscript module
32+
------------------------------
33+
34+
.. automodule:: SCons.Script.SConscript
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
40+
Module contents
41+
---------------
42+
43+
.. automodule:: SCons.Script
44+
:members:
45+
:undoc-members:
46+
:show-inheritance:

‎doc/sphinx/SCons.Tool.rst‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
SCons.Tool package
2+
==================
3+
4+
Module contents
5+
---------------
6+
7+
.. automodule:: SCons.Tool
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:

0 commit comments

Comments
 (0)