Release note for new sidebar feature

Change-Id: Ie2501e0b07b13e524d2525d174e8b37c589ea5e6
2016-06-03 16:10:37 +01:00 · 2016-06-03 16:10:37 +01:00 · 75e8fc6e80
parent 7388b01c15
commit 75e8fc6e80
1 changed files with 16 additions and 0 deletions
--- a/releasenotes/notes/side-bar-config-d7e66388e252cadf.yaml
+++ b/releasenotes/notes/side-bar-config-d7e66388e252cadf.yaml
@ -0,0 +1,16 @@
+---
+features:
+  - |
+    The sidebar Table of Contents can now be set to the full ``toc`` directive,
+    or remain as the ``toctree`` directive.
+
+    This can be set by setting ``"sidebar_mode"`` to ``"toc"`` in the
+    ``html_theme_options`` option in ``conf.py``.
+
+    For example:
+
+    ::
+
+      html_theme_options = {
+           "sidebar_mode": "toc",
+        }