From d1e3109d24cdc28c9cd788ded6ff54f11692ce03 Mon Sep 17 00:00:00 2001 From: Mats Wichmann Date: Fri, 8 Mar 2024 12:33:25 -0700 Subject: Expand API docs intro [skip appveyor] Notes that tool writers might be part of the audience for API docs. Signed-off-by: Mats Wichmann --- doc/sphinx/index.rst | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/doc/sphinx/index.rst b/doc/sphinx/index.rst index 04bfdc2..a21b9db 100644 --- a/doc/sphinx/index.rst +++ b/doc/sphinx/index.rst @@ -10,15 +10,17 @@ SCons API Documentation This is the **internal** API Documentation for SCons. The documentation is automatically generated for each release from the source code using the - `Sphinx `_ tool. + `Sphinx `_ documentation generator. Missing information is due to shortcomings in the docstrings in the code, - which are by no means complete (contributions welcomed!). - - The target audience is developers working on SCons itself: - what is "Public API" is not clearly deliniated here. - The interfaces available for use in SCons configuration scripts, - which have a consistency guarantee, are those documented in the - `SCons Reference Manual + 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 `_. .. toctree:: -- cgit v0.12