@@ -10,15 +10,17 @@ SCons API Documentation
10
10
This is the **internal ** API Documentation for SCons.
11
11
The documentation is automatically generated for each release
12
12
from the source code using the
13
- `Sphinx <https://www.sphinx-doc.org >`_ tool .
13
+ `Sphinx <https://www.sphinx-doc.org >`_ documentation generator .
14
14
Missing information is due to shortcomings in the docstrings in the code,
15
- which are by no means complete (contributions welcomed!).
16
-
17
- The target audience is developers working on SCons itself:
18
- what is "Public API" is not clearly deliniated here.
19
- The interfaces available for use in SCons configuration scripts,
20
- which have a consistency guarantee, are those documented in the
21
- `SCons Reference Manual
15
+ which admittedly could use a lot more work (contributions welcomed!).
16
+
17
+ The target audience is both developers working on SCons itself,
18
+ and those writing external Tools, Builders, etc. and other
19
+ related functionality, who need to reach beyond the Public API.
20
+ Note that what is Public API is not clearly deliniated in the API Docs.
21
+ The interfaces available for use in SCons configuration scripts
22
+ ("SConscript files"), which have a consistency guarantee,
23
+ are those documented in the `SCons Reference Manual
22
24
<https://scons.org/doc/production/HTML/scons-man.html> `_.
23
25
24
26
.. toctree ::
0 commit comments