Repository: SCons/scons

Issue:
Switch SCons APIDOCS from epydoc to Sphinx
See Issue #3121 for history

epydoc is no longer maintained.
Switch to sphinx




Discussion:

Resolving patch:
diff --git a/bin/scons_dev_master.py b/bin/scons_dev_master.py
--- a/bin/scons_dev_master.py
+++ b/bin/scons_dev_master.py
@@ -33,14 +33,12 @@
 ]
 
 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 @@
 
     # 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 @@
     '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/conf.py b/doc/sphinx/conf.py
new file mode 100644
--- /dev/null
+++ b/doc/sphinx/conf.py
@@ -0,0 +1,199 @@
+#!/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('../../'))
+
+# -- 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 = [
+    'autoclasstoc',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    #'sphinx.ext.githubpages'
+    'sphinx.ext.napoleon',
+    'sphinx.ext.todo',
+    'sphinx.ext.viewcode',
+]
+
+autosummary_generate = True
+
+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 = True
+
+# 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'
+copyright = '2020, 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
+# 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 -------------------------------------------------
+


Test patch: