IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Change html_collapse_toctree setting to an argument of the toctree() callable.

Browse Source
This commit is contained in:
Georg Brandl
2009-02-16 00:08:08 +01:00
parent ddeeccd5c2
commit d5ea00899c
5 changed files with 10 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/config.rst
View File

@@ -515,14 +515,6 @@ 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'``.

3
doc/templating.rst
View File

@@ -364,4 +364,5 @@ 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.
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.