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.

CHANGES

@@ -49,7 +49,7 @@ New features added
   - #23: Added a ``classmethod`` directive along with ``method``
     and ``staticmethod``.
 
-  - Added a toctree variable to the templates, and the ability to
+  - Added a ``toctree`` variable to the templates, and the ability to
     include external links in toctrees.
 
 * Configuration:
@@ -61,6 +61,9 @@ New features added
   - The new ``html_show_sourcelink`` config value can be used to
     switch off the links to the reST sources in the sidebar.
 
+  - The new ``html_collapse_toctree`` config value can be used to
+    "collapse" the generated toctree given to the templates.
+
   - The default value for ``htmlhelp_basename`` is now the project
     title, cleaned up as a filename.
 

doc/conf.py

@@ -82,6 +82,8 @@ html_style = 'sphinxdoc.css'
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
+html_collapse_toctree = True
+
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
 html_last_updated_fmt = '%b %d, %Y'

doc/config.rst

@@ -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'``.