summaryrefslogtreecommitdiffstats
path: root/doc/sphinx/index.rst
blob: 6828154205c9c6057e3738365beac099360cb6ad (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
.. SCons documentation master file, 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 Project API Documentation
===============================

This is the internal API Documentation for SCons.
The Documentation is generated using the Sphinx tool.
The target audience is developers working on SCons itself,
so it does not clearly delineate what is "Public API" -
interfaces for use in your SCons configuration scripts
which have a consistency guarantee, and what is internal,
so always keep the SCons manual page around for helping
with such determinations.

.. 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`