summaryrefslogtreecommitdiff
path: root/docutils/docs/ref
diff options
context:
space:
mode:
authormilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2009-05-12 13:22:20 +0000
committermilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2009-05-12 13:22:20 +0000
commit3c539bd92a93047da535dac37324abf0bcd70f10 (patch)
tree24c67bd5a03418a50d84e6323ccff6e5a96ec80e /docutils/docs/ref
parent12f56052ce03f3629073bc47ea51ab517c3db1df (diff)
downloaddocutils-3c539bd92a93047da535dac37324abf0bcd70f10.tar.gz
Note that local tables of content are ignored if not in a top-level section.
git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@5943 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/docs/ref')
-rw-r--r--docutils/docs/ref/rst/directives.txt3
1 files changed, 3 insertions, 0 deletions
diff --git a/docutils/docs/ref/rst/directives.txt b/docutils/docs/ref/rst/directives.txt
index 69f3beac5..d82160958 100644
--- a/docutils/docs/ref/rst/directives.txt
+++ b/docutils/docs/ref/rst/directives.txt
@@ -946,6 +946,9 @@ The following options are recognized:
subsections of the section in which the directive is given. If no
explicit title is given, the table of contents will not be titled.
+ .. note::
+ Local tables of content are ignored if not in a top-level section.
+
``backlinks`` : "entry" or "top" or "none"
Generate links from section headers back to the table of contents
entries, the table of contents itself, or generate no backlinks.