summaryrefslogtreecommitdiff
path: root/doc/sphinx/index.rst
blob: f8d5f471c79276b65d3081943be10b80a9df2f3a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
.. 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.Taskmaster
   SCons.Tool
   SCons.Variables


Indices and Tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`