summaryrefslogtreecommitdiff
path: root/doc/markup/misc.rst
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2010-02-25 22:49:54 +0100
committerGeorg Brandl <georg@python.org>2010-02-25 22:49:54 +0100
commitcef7879fa4dc1dc2c379216a42741db28712e6c3 (patch)
tree9eb483d86919cc3c43470a60b7a04e450255ba40 /doc/markup/misc.rst
parent3c74907fed821ce9d33dda88d43d8aa3587c79d6 (diff)
downloadsphinx-cef7879fa4dc1dc2c379216a42741db28712e6c3.tar.gz
Add "orphan" metadata entry to suppress non-toctree-inclusion warnings.
Diffstat (limited to 'doc/markup/misc.rst')
-rw-r--r--doc/markup/misc.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/markup/misc.rst b/doc/markup/misc.rst
index 01e5a3f1..7db403ab 100644
--- a/doc/markup/misc.rst
+++ b/doc/markup/misc.rst
@@ -29,6 +29,12 @@ At the moment, these metadata fields are recognized:
If set, the web application won't display a comment form for a page generated
from this source file.
+``orphan``
+ If set, warnings about this file not being included in any toctree will be
+ suppressed.
+
+ .. versionadded:: 1.0
+
Meta-information markup
-----------------------