diff options
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 |