summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2012-03-10 21:21:43 +0100
committerGeorg Brandl <georg@python.org>2012-03-10 21:21:43 +0100
commita43db198054822fb521f4aac6fcca4cdf7c4e9b5 (patch)
treee6ab1aacc8096b72cc27c98af771d258a66da526 /doc
parentb79510355e1b948cd8398de607a02146adb7d06e (diff)
downloadsphinx-a43db198054822fb521f4aac6fcca4cdf7c4e9b5.tar.gz
Fixes #795: explain that titles on the same level as the document heading cannot be put into only directives.
Diffstat (limited to 'doc')
-rw-r--r--doc/markup/misc.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/markup/misc.rst b/doc/markup/misc.rst
index f5eaac9c..3a2ffa32 100644
--- a/doc/markup/misc.rst
+++ b/doc/markup/misc.rst
@@ -182,6 +182,13 @@ Including content based on tags
The format of the current builder (``html``, ``latex`` or ``text``) is always
set as a tag.
+ .. note::
+
+ Due to docutils' specifics of parsing of directive content, you cannot put
+ a section with the same level as the main document heading inside an
+ ``only`` directive. Such sections will appear to be ignored in the parsed
+ document.
+
.. versionadded:: 0.6