diff options
| author | Georg Brandl <georg@python.org> | 2014-01-19 19:13:17 +0100 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2014-01-19 19:13:17 +0100 |
| commit | cd7658dde7f32714f4e6013cd221a9ea6e88bb82 (patch) | |
| tree | 329d1f0abf16c75666013bc877f7532a21663398 /doc | |
| parent | 2a8cf7c7781a4554adbcb4bae6bec2a40bfc156d (diff) | |
| parent | 468198f91b0a41056c46c25f8cedf5c528c97564 (diff) | |
| download | sphinx-cd7658dde7f32714f4e6013cd221a9ea6e88bb82.tar.gz | |
merge with stable
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile | 2 | ||||
| -rw-r--r-- | doc/markup/toctree.rst | 9 |
2 files changed, 7 insertions, 4 deletions
diff --git a/doc/Makefile b/doc/Makefile index 8bc59724..55909649 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -15,4 +15,4 @@ help: # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: - $(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/doc/markup/toctree.rst b/doc/markup/toctree.rst index fdecc37d..1d5d667a 100644 --- a/doc/markup/toctree.rst +++ b/doc/markup/toctree.rst @@ -141,9 +141,12 @@ 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 :ref:`metadata` to remove the - warning, and :confval:`exclude_patterns` to explicitly exclude documents or - directories from building. + be reachable through standard navigation. + + Use :confval:`exclude_patterns` to explicitly exclude documents or + directories from building completely. Use :ref:`the "orphan" metadata + <metadata>` to let a document be built, but notify Sphinx that it is not + reachable via a toctree. 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 |
