WIP sphinx for scons API docs

README.txt

# adjust to your path
sphinx-apidoc -f -o source/ ../../git/as_scons/src/engine/ "/Users/bdbaddog/devel/scons/git/as_scons/src/engine/SCons/*Tests.py"

# do this then answer the questions
sphinx-quickstart

# Then replace source/conf.py with below, but adjust the paths which are /Users/bdbaddog... 

# replace source/index.rst with below

conf.py

# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
# full list see the documentation:
# http://www.sphinx-doc.org/en/master/config

# -- Path setup --------------------------------------------------------------

# 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('/Users/bdbaddog/devel/scons/git/as_scons/src/engine/'))
sys.path.insert(1, os.path.abspath('/Users/bdbaddog/devel/scons/git/as_scons/testing/framework'))
sys.path.insert(1, os.path.abspath('/Users/bdbaddog/devel/scons/git/as_scons/QMtest'))



# -- Project information -----------------------------------------------------

project = u'SCons API Docs'
copyright = u'2018, SCons Project'
author = u'SCons Project'

# The short X.Y version
version = u''
# The full version, including alpha/beta/rc tags
release = u'devel'


# -- General configuration ---------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'

# 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.viewcode',
]

# 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', '.md']
source_suffix = '.rst'

# The master toctree document.
master_doc = 'index'

# 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'


# -- 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'

# 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 = 'SConsAPIDocsdoc'


# -- 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', u'SCons API Docs Documentation',
     u'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', u'SCons API Docs 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', u'SCons API Docs Documentation',
     author, 'SConsAPIDocs', 'One line description of project.',
     'Miscellaneous'),
]


# -- Options for Epub output -------------------------------------------------

# Bibliographic Dublin Core info.
epub_title = project
epub_author = author
epub_publisher = author
epub_copyright = copyright

# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#
# epub_identifier = ''

# A unique identification for the text.
#
# epub_uid = ''

# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']



# autodoc_default_flags = ['members', 'undoc-members', 'special-members',
#                          'show-inheritance']
autodoc_member_order = 'bysource'

autodoc_exclude_members = ['*Tests']


# -- Extension configuration -------------------------------------------------

index.rst

Welcome to SCons API Docs's documentation!

.. toctree::
   :maxdepth: 2
   :caption: Contents:

Indices and tables

• :ref:`genindex`
• :ref:`modindex`
• :ref:`search`

logfile.txt

$ make html
Running Sphinx v1.7.4
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 0 source files that are out of date
updating environment: 0 added, 3 changed, 0 removed
reading sources... [100%] SCons.Tool.MSCommon
/Users/bdbaddog/devel/scons/git/as_scons/src/engine/SCons/Platform/__init__.py:docstring of SCons.Platform.platform_default:3: WARNING: Inline emphasis start-string without end-string.
WARNING: invalid signature for automodule (u'SCons.Tool.aixc++')
WARNING: don't know which module to import for autodocumenting u'SCons.Tool.aixc++' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name)
WARNING: invalid signature for automodule (u'SCons.Tool.c++')
WARNING: don't know which module to import for autodocumenting u'SCons.Tool.c++' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name)
WARNING: invalid signature for automodule (u'SCons.Tool.g++')
WARNING: don't know which module to import for autodocumenting u'SCons.Tool.g++' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name)
WARNING: invalid signature for automodule (u'SCons.Tool.hpc++')
WARNING: don't know which module to import for autodocumenting u'SCons.Tool.hpc++' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name)
/Users/bdbaddog/devel/scons/git/as_scons/src/engine/SCons/Tool/intelc.py:docstring of SCons.Tool.intelc.generate:4: WARNING: Unexpected indentation.
/Users/bdbaddog/devel/scons/git/as_scons/src/engine/SCons/Tool/intelc.py:docstring of SCons.Tool.intelc.generate:7: WARNING: Unexpected indentation.
/Users/bdbaddog/devel/scons/git/as_scons/src/engine/SCons/Tool/intelc.py:docstring of SCons.Tool.intelc.generate:8: WARNING: Block quote ends without a blank line; unexpected unindent.
/Users/bdbaddog/devel/scons/git/as_scons/src/engine/SCons/Tool/intelc.py:docstring of SCons.Tool.intelc.generate:9: WARNING: Block quote ends without a blank line; unexpected unindent.
WARNING: invalid signature for automodule (u'SCons.Tool.sgic++')
WARNING: don't know which module to import for autodocumenting u'SCons.Tool.sgic++' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name)
WARNING: invalid signature for automodule (u'SCons.Tool.sunc++')
WARNING: don't know which module to import for autodocumenting u'SCons.Tool.sunc++' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name)
WARNING: autodoc: failed to import module u'SCons.Tool.MSCommon.arch'; the following exception was raised:
Traceback (most recent call last):
  File "/Users/bdbaddog/.virtualenvs/scons/lib/python2.7/site-packages/sphinx/ext/autodoc/importer.py", line 140, in import_module
    __import__(modname)
  File "/Users/bdbaddog/devel/scons/git/as_scons/src/engine/SCons/Tool/MSCommon/arch.py", line 40, in <module>
    ArchitectureDefinition(
NameError: name 'ArchitectureDefinition' is not defined

/Users/bdbaddog/devel/scons/git/as_scons/src/engine/SCons/Tool/MSCommon/vc.py:docstring of SCons.Tool.MSCommon.vc.is_host_target_supported:5: WARNING: Unexpected section title.

Parameters
----------
/Users/bdbaddog/devel/scons/git/as_scons/src/engine/SCons/Tool/MSCommon/vc.py:docstring of SCons.Tool.MSCommon.vc.is_host_target_supported:13: WARNING: Unexpected section title.

Note
----
/Users/bdbaddog/devel/scons/git/as_scons/src/engine/SCons/Tool/MSCommon/vc.py:docstring of SCons.Tool.MSCommon.vc.find_vc_pdir:5: WARNING: Unexpected section title.

Note
----
/Users/bdbaddog/devel/scons/git/as_scons/src/engine/SCons/Tool/MSCommon/vs.py:docstring of SCons.Tool.MSCommon.vs.get_default_version:8: WARNING: Unexpected section title.

Return
------
/Users/bdbaddog/devel/scons/git/as_scons/src/engine/SCons/Tool/MSCommon/vs.py:docstring of SCons.Tool.MSCommon.vs.get_default_arch:7: WARNING: Unexpected section title.

Return
------
looking for now-outdated files... none found
pickling environment... done
checking consistency... /Users/bdbaddog/devel/scons/tmp/sphinx/source/SCons.compat.rst: WARNING: document isn't included in any toctree
done
preparing documents... done
writing output... [100%] index
generating indices... genindex py-modindex
highlighting module code... [100%] SCons.exitfuncs
writing additional pages... search
copying static files... done
copying extra files... done
dumping search index in English (code: en) ... done
dumping object inventory... done
build succeeded, 24 warnings.

The HTML pages are in build/html.