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

Merged in plaindocs/sphinx (pull request #185)

Browse Source
This commit is contained in:
Georg Brandl 2014-01-10 09:24:23 +01:00
commit fcee847ae0
2 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/config.rst
View File

@ -118,7 +118,7 @@ General configuration
in that case. in that case.
.. deprecated:: 1.0 .. deprecated:: 1.0
Use :confval:`exclude_patterns` instead. Use :confval:`exclude_patterns` or :ref:`metadata` instead.
.. confval:: exclude_trees .. confval:: exclude_trees

5
doc/markup/toctree.rst
View File

@ -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) 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 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 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 be reachable through standard navigation. Use :ref:`metadata` to remove the
explicitly exclude documents or directories from building. 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 "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 the TOC tree hierarchy. It can be used as the documentation's main page, or