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

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

Browse Source 
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
CHANGES
View File

@ -49,7 +49,7 @@ New features added
- #23: Added a ``classmethod`` directive along with ``method`` - #23: Added a ``classmethod`` directive along with ``method``
and ``staticmethod``. 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. include external links in toctrees.
* Configuration: * Configuration:
@ -61,6 +61,9 @@ New features added
- The new ``html_show_sourcelink`` config value can be used to - The new ``html_show_sourcelink`` config value can be used to
switch off the links to the reST sources in the sidebar. 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 - The default value for ``htmlhelp_basename`` is now the project
title, cleaned up as a filename. title, cleaned up as a filename.

2
doc/conf.py
View File

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

8
doc/config.rst
View File

@ -462,6 +462,14 @@ that use Sphinx' HTMLWriter class.
.. versionadded:: 0.4 .. 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 .. confval:: htmlhelp_basename
Output file base name for HTML help builder. Default is ``'pydoc'``. Output file base name for HTML help builder. Default is ``'pydoc'``.