Source

sphinx-scons /

Filename Size Date modified Message
53 B
184 B
91 B
1.3 KB
9.2 KB
6.7 KB
124 B
==================================================
 Sphinx-Scons -- an SCons build script for Sphinx
==================================================

Introduction
============

This package contains ``SConstruct``, a generic SCons_ build script for
invoking Sphinx_ to build documentation.

The ``sphinx-quickstart`` program can automatically create two build
scripts: a ``Makefile`` for Unix systems, and a ``make.bat`` equivalent for
Windows.  This script has the advantage that it works the same way on both
systems (once you have installed SCons).

Usage
=====

Basically, just copy the ``SConstruct`` file to the top-level directory of
your Sphinx docs, and then use **scons** at a command prompt to build
things.  Typing ``scons -h`` will give a help message describing all the
things you can do.

As an example, if you just type ``scons`` in this package's directory, you
can read this ``README`` in style, á la Sphinx.

Reimplementation
================

This package is in the process of being reimplemented from scratch as
SCons_Sphinx_.  This will be a standard SCons "tool"---i.e., one that you
can use as part of a larger project.

.. _SCons: http://www.scons.org
.. _Sphinx: http://sphinx.pocoo.org
.. _SCons_Sphinx: https://bitbucket.org/russel/scons_sphinx

.. Local Variables:
.. mode: rst
.. End:
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.