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/concepts.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/concepts.rst')
| -rw-r--r-- | doc/concepts.rst | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/doc/concepts.rst b/doc/concepts.rst index 7ea23dbf..91df9752 100644 --- a/doc/concepts.rst +++ b/doc/concepts.rst @@ -11,10 +11,10 @@ Document names Since the reST source files can have different extensions (some people like ``.txt``, some like ``.rst`` -- the extension can be configured with :confval:`source_suffix`) and different OSes have different path separators, -Sphinx abstracts them: all "document names" are relative to the -:term:`documentation root`, the extension is stripped, and path separators are -converted to slashes. All values, parameters and suchlike referring to -"documents" expect such a document name. +Sphinx abstracts them: all "document names" are relative to the :term:`source +directory`, the extension is stripped, and path separators are converted to +slashes. All values, parameters and suchlike referring to "documents" expect +such a document name. The TOC tree @@ -71,11 +71,12 @@ tables of contents. The ``toctree`` directive is the central element. The second line above will link to the ``strings`` document, but will use the title "All about strings" instead of the title of the ``strings`` document. - In the end, all documents under the :term:`documentation root` must occur in - some ``toctree`` directive; Sphinx will emit a warning if it finds a file - that is not included, because that means that this file will not be reachable - through standard navigation. Use :confval:`unused_documents` to explicitly - exclude documents from this check. + In the end, all documents in the :term:`source directory` (or subdirectories) + must occur in some ``toctree`` directive; Sphinx will emit a warning if it + finds a file that is not included, because that means that this file will not + be reachable through standard navigation. Use :confval:`unused_documents` to + explicitly exclude documents from this check, and :confval:`exclude_dirs` to + exclude whole directories. The "master document" (selected by :confval:`master_doc`) is the "root" of the TOC tree hierarchy. It can be used as the documentation's main page, or |
