diff options
| author | Georg Brandl <georg@python.org> | 2009-12-28 19:49:57 +0100 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2009-12-28 19:49:57 +0100 |
| commit | 6b954328bea16abf763a2d829471d6565747f1a4 (patch) | |
| tree | 17299e304c5608d335c88e2eb26780ba14fafecc /doc/templating.rst | |
| parent | 2637a7b44ad5b68412d14da5ff64b0f8ee88512f (diff) | |
| parent | a3cd1ee676757c69ae30f401b62b7a055f1e3f1a (diff) | |
| download | sphinx-6b954328bea16abf763a2d829471d6565747f1a4.tar.gz | |
merge with trunk
Diffstat (limited to 'doc/templating.rst')
| -rw-r--r-- | doc/templating.rst | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/doc/templating.rst b/doc/templating.rst index 0148ed32..21b9a42e 100644 --- a/doc/templating.rst +++ b/doc/templating.rst @@ -364,5 +364,10 @@ are in HTML form), these variables are also available: .. data:: toctree A callable yielding the global TOC tree containing the current page, rendered - as HTML bullet lists. If the optional keyword argument ``collapse`` is true, - all TOC entries that are not ancestors of the current page are collapsed. + as HTML bullet lists. Optional keyword arguments: + + * ``collapse`` (true by default): if true, all TOC entries that are not + ancestors of the current page are collapsed + + * ``maxdepth`` (defaults to the max depth selected in the toctree directive): + the maximum depth of the tree; set it to ``-1`` to allow unlimited depth |