diff options
| author | georg.brandl <devnull@localhost> | 2008-05-02 10:32:08 +0000 |
|---|---|---|
| committer | georg.brandl <devnull@localhost> | 2008-05-02 10:32:08 +0000 |
| commit | d69ae10eda6d7ba0c0c60599c7e1fa572261e42c (patch) | |
| tree | f089006f833d80233e4aeb0936394a09087bb3b4 /doc/intro.rst | |
| parent | 98e5861746233890e491f8b87ccb506465544799 (diff) | |
| download | sphinx-d69ae10eda6d7ba0c0c60599c7e1fa572261e42c.tar.gz | |
Allow the configuration directory to be set differently from the source directory.
Also don't import docutils on importing sphinx.
Diffstat (limited to 'doc/intro.rst')
| -rw-r--r-- | doc/intro.rst | 29 |
1 files changed, 21 insertions, 8 deletions
diff --git a/doc/intro.rst b/doc/intro.rst index 4dd080c1..63ff1e07 100644 --- a/doc/intro.rst +++ b/doc/intro.rst @@ -31,16 +31,20 @@ or some (not broken) SVN trunk snapshot. .. _Pygments: http://pygments.org -Setting up a documentation root -------------------------------- +Setting up the documentation sources +------------------------------------ -The root directory of a documentation collection is called the -:dfn:`documentation root`. There's nothing special about it; it just needs to -contain the Sphinx configuration file, :file:`conf.py`. +The root directory of a documentation collection is called the :dfn:`source +directory`. Normally, this directory also contains the Sphinx configuration +file :file:`conf.py`, but that file can also live in another directory, the +:dfn:`configuration directory`. + +.. versionadded:: 0.2.1 + Support for a different configuration directory. Sphinx comes with a script called :program:`sphinx-quickstart` that sets up a -documentation root and creates a default :file:`conf.py` from a few questions -it asks you. Just run :: +source directory and creates a default :file:`conf.py` from a few questions it +asks you. Just run :: $ sphinx-quickstart @@ -55,7 +59,7 @@ like this:: $ sphinx-build -b latex sourcedir builddir -where *sourcedir* is the :term:`documentation root`, and *builddir* is the +where *sourcedir* is the :term:`source directory`, and *builddir* is the directory in which you want to place the built documentation (it must be an existing directory). The :option:`-b` option selects a builder; in this example Sphinx will build LaTeX files. @@ -79,6 +83,15 @@ The :program:`sphinx-build` script has several more options: the build directory; with this option you can select a different cache directory (the doctrees can be shared between all builders). +**-c** *path* + Don't look for the :file:`conf.py` in the source directory, but use the given + configuration directory instead. Note that various other files and paths + given by configuration values are expected to be relative to the + configuration directory, so they will have to be present at this location + too. + + .. versionadded:: 0.2.1 + **-D** *setting=value* Override a configuration value set in the :file:`conf.py` file. (The value must be a string value.) |
