IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

recommend exclude_patterns instead of unused_docs or exclude_trees

Browse Source
This commit is contained in:
Eric Knibbe 2013-12-17 18:12:54 +00:00
parent 2d36d17fd9
commit 9298e15ae0
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/markup/toctree.rst
View File

@ -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