diff options
| author | Eric Knibbe <eric3knibbe@gmail.com> | 2013-12-17 18:12:54 +0000 |
|---|---|---|
| committer | Eric Knibbe <eric3knibbe@gmail.com> | 2013-12-17 18:12:54 +0000 |
| commit | 50955cc4f6e048b04789a1bd5ba62604b5de5cc6 (patch) | |
| tree | faff122e382003b078a8d54f9e34fa53dafbadb1 /doc/markup | |
| parent | 75833139dac62e11cfc065044824a98d96fd8751 (diff) | |
| download | sphinx-50955cc4f6e048b04789a1bd5ba62604b5de5cc6.tar.gz | |
recommend exclude_patterns instead of unused_docs or exclude_trees
Diffstat (limited to 'doc/markup')
| -rw-r--r-- | doc/markup/toctree.rst | 5 |
1 files changed, 2 insertions, 3 deletions
diff --git a/doc/markup/toctree.rst b/doc/markup/toctree.rst index c17fb9b0..41c265f8 100644 --- a/doc/markup/toctree.rst +++ b/doc/markup/toctree.rst @@ -141,9 +141,8 @@ tables of contents. The ``toctree`` directive is the central element. 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_docs` to - explicitly exclude documents from building, and :confval:`exclude_trees` to - exclude whole directories. + be reachable through standard navigation. Use :confval:`exclude_patterns` to + explicitly exclude documents or directories from building. 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 |
