openstackdocstheme/releasenotes/notes/allow-disabling-toc-in-body-d98d3a6e633fa28e.yaml
Major Hayden 59072440ab Allow automatic toc to be disabled
In some cases, a user may want to disable the automatic table of
contents generation in the body of the page. This patch adds
a ``display_toc`` option into the theme options list that will
disable the automatic TOC in the documentation body.

Closes-Bug: 1613761

Change-Id: I508b46c5ba6a022ee4ad2687cb4e44ed449ca4fe
2016-08-16 10:10:37 -05:00

15 lines
336 B
YAML

---
features:
- |
The automatic table of contents that appears in the body of the
documentation can be disabled by setting ``display_toc`` to ``False`` in
the ``html_theme_options`` option in ``conf.py``.
For example:
.. code-block:: python
html_theme_options = {
"display_toc": False,
}