diff options
| author | Georg Brandl <georg@python.org> | 2014-01-10 21:26:12 +0100 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2014-01-10 21:26:12 +0100 |
| commit | 61760219a619244293b7f05a8a7036dae917f689 (patch) | |
| tree | 8e54ee54a23a04b04527309c43a59d0f3c10e6d8 /doc | |
| parent | 429b63e4126865d72bcf4e1f9909a1b74ebefedf (diff) | |
| parent | 8e3d984fb60b4dae60124f150b10313cbcff8121 (diff) | |
| download | sphinx-61760219a619244293b7f05a8a7036dae917f689.tar.gz | |
merge stable into default
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/config.rst | 2 | ||||
| -rw-r--r-- | doc/markup/toctree.rst | 5 |
2 files changed, 4 insertions, 3 deletions
diff --git a/doc/config.rst b/doc/config.rst index 70ccd26e..f57e9eff 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -118,7 +118,7 @@ General configuration in that case. .. deprecated:: 1.0 - Use :confval:`exclude_patterns` instead. + Use :confval:`exclude_patterns` or :ref:`metadata` instead. .. confval:: exclude_trees diff --git a/doc/markup/toctree.rst b/doc/markup/toctree.rst index 41c265f8..90666b72 100644 --- a/doc/markup/toctree.rst +++ b/doc/markup/toctree.rst @@ -141,8 +141,9 @@ 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:`exclude_patterns` to - explicitly exclude documents or directories from building. + be reachable through standard navigation. Use :ref:`metadata` to remove the + warning, and :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 |
