mirror of
https://github.com/Relintai/scons_gd.git
synced 2025-03-12 18:38:59 +01:00
44 lines
1.2 KiB
ReStructuredText
44 lines
1.2 KiB
ReStructuredText
.. SCons documentation master file, originally created by
|
|
sphinx-quickstart on Mon Apr 30 09:36:53 2018.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
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 <https://www.sphinx-doc.org>`_ tool.
|
|
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
|
|
<https://scons.org/doc/production/HTML/scons-man.html>`_.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Contents:
|
|
|
|
SCons
|
|
SCons.compat
|
|
SCons.Node
|
|
SCons.Platform
|
|
SCons.Scanner
|
|
SCons.Script
|
|
SCons.Tool
|
|
SCons.Variables
|
|
|
|
|
|
Indices and Tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|