SCons API Documentation#
Attention
This is the internal API Documentation for SCons. The documentation is automatically generated for each release from the source code using the Sphinx documentation generator. Missing information is due to shortcomings in the docstrings in the code, which admittedly could use a lot more work (contributions welcomed!).
The target audience is both developers working on SCons itself, and those writing external Tools, Builders, etc. and other related functionality, who need to reach beyond the Public API. Note that what is Public API is not clearly deliniated in the API Docs. The interfaces available for use in SCons configuration scripts (“SConscript files”), which have a consistency guarantee, are those documented in the SCons Reference Manual.
Contents:
- SCons package
- Module contents
- Subpackages
- Submodules
- SCons.Action module
- SCons.Builder module
- SCons.CacheDir module
- SCons.Conftest module
- SCons.Debug module
- SCons.Defaults module
- SCons.Environment module
- SCons.Errors module
- SCons.Executor module
- SCons.Memoize module
- SCons.PathList module
- SCons.SConf module
- SCons.SConsign module
- SCons.Subst module
- SCons.Warnings module
- SCons.cpp module
- SCons.dblite module
- SCons.exitfuncs module
- SCons.compat package
- SCons.Node package
- SCons.Platform package
- Submodules
- SCons.Platform.aix module
- SCons.Platform.cygwin module
- SCons.Platform.darwin module
- SCons.Platform.hpux module
- SCons.Platform.irix module
- SCons.Platform.mingw module
- SCons.Platform.os2 module
- SCons.Platform.posix module
- SCons.Platform.sunos module
- SCons.Platform.virtualenv module
- SCons.Platform.win32 module
- Module contents
- SCons.Scanner package
- SCons.Script package
- SCons.Taskmaster package
- SCons.Tool package
- SCons.Util package
- SCons.Variables package