diff options
| author | Georg Brandl <georg@python.org> | 2009-01-26 21:57:15 +0100 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2009-01-26 21:57:15 +0100 |
| commit | a1deea1a040a612e262b34717b73674b5bc423ce (patch) | |
| tree | 6e967dbe62704b07714389185f3aaf1de3e8aa98 /doc/templating.rst | |
| parent | 21cccbd98405e026150fe6aa91ff4d397ae7702b (diff) | |
| download | sphinx-a1deea1a040a612e262b34717b73674b5bc423ce.tar.gz | |
Added a toctree variable to the templates, and the ability to
include external links in toctrees.
Patch by Stefan Seefeld.
Diffstat (limited to 'doc/templating.rst')
| -rw-r--r-- | doc/templating.rst | 23 |
1 files changed, 21 insertions, 2 deletions
diff --git a/doc/templating.rst b/doc/templating.rst index ff4bdd51..20c61ce0 100644 --- a/doc/templating.rst +++ b/doc/templating.rst @@ -221,8 +221,12 @@ in the future. .. data:: builder - The name of the builder (for builtin builders, ``html``, ``htmlhelp``, or - ``web``). + The name of the builder (e.g. ``html`` or ``htmlhelp``). + +.. data:: embedded + + True if the built HTML is supposed to be embedded in some application that + handles navigation, e.g. HTML Help or Qt Help. .. data:: next @@ -239,3 +243,18 @@ in the future. .. data:: prev Like :data:`next`, but for the previous page. + + +In documents that are created from source files (as opposed to +automatically-generated files like the module index, or documents that already +are in HTML form), these variables are also available: + +.. data:: toc + + The local table of contents for the current page, rendered as HTML bullet + lists. + +.. data:: toctree + + The global TOC tree containing the current page, rendered as HTML bullet + lists. |