summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2011-09-23 11:22:35 +0200
committerGeorg Brandl <georg@python.org>2011-09-23 11:22:35 +0200
commit6e02a1299860c1ced84333b6386e7713590428f1 (patch)
tree336050cc438805328cf74f2eae36a586f77efe3b /doc
parent5531677de52cf53044fbccb51a8c4ea0437d5135 (diff)
downloadsphinx-6e02a1299860c1ced84333b6386e7713590428f1.tar.gz
Add note about inclusion with the "include" directive.
Diffstat (limited to 'doc')
-rw-r--r--doc/markup/toctree.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/markup/toctree.rst b/doc/markup/toctree.rst
index 2c0a418a..b9eb0ebf 100644
--- a/doc/markup/toctree.rst
+++ b/doc/markup/toctree.rst
@@ -11,6 +11,11 @@ documents into multiple output files, Sphinx uses a custom directive to add
relations between the single files the documentation is made of, as well as
tables of contents. The ``toctree`` directive is the central element.
+.. note::
+
+ Simple "inclusion" of one file in another can be done with the
+ :dudir:`include` directive.
+
.. rst:directive:: toctree
This directive inserts a "TOC tree" at the current location, using the