Added a `toctree` variable to the templates, and the ability to

The new ``html_collapse_toctree`` config value can be used to
"collapse" the generated toctree given to the templates.
This commit is contained in:
Georg Brandl
2009-02-07 14:13:13 +01:00
parent 394282223b
commit d60aadc13d
3 changed files with 14 additions and 1 deletions

View File

@@ -462,6 +462,14 @@ that use Sphinx' HTMLWriter class.
.. versionadded:: 0.4
.. confval:: html_collapse_toctree
If true, the toctree given to the templates as ``toctree`` will be collapsed,
i.e. only the subitems that contain the current page are visible. Default is
``False``.
.. versionadded:: 0.6
.. confval:: htmlhelp_basename
Output file base name for HTML help builder. Default is ``'pydoc'``.