From fa66fa9739f4479bf97bc28dcb864ced7aa16ec1 Mon Sep 17 00:00:00 2001 From: Eric Knibbe Date: Tue, 17 Dec 2013 18:12:54 +0000 Subject: recommend exclude_patterns instead of unused_docs or exclude_trees --- doc/markup/toctree.rst | 5 ++--- 1 file 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 -- cgit v1.2.1