using a string value for `html_sidebars` will be removed in 2.0

This commit is contained in:
Takeshi KOMIYA committed 2017-10-30 13:41:57 +09:00
1 parent 67981527a1
commit 83c266aa2e
3 files changed
+12

No files matched your search

+3
View File
@@ -15,6 +15,9 @@ Incompatible changes
Deprecated
----------
* using a string value for :confval:`html_sidebars` is deprecated and only list
values will be accepted at 2.0.
Features added
--------------
+4
View File
@@ -828,6 +828,10 @@ that use Sphinx's HTMLWriter class.
between the ``'sourcelink.html'`` and ``'searchbox.html'`` entries. This
is for compatibility with Sphinx versions before 1.0.
.. deprecated:: 1.7
a single string value for ``html_sidebars`` will be removed in 2.0
Builtin sidebar templates that can be rendered are:
* **localtoc.html** -- a fine-grained table of contents of the current
+5
View File
@@ -888,6 +888,11 @@ class StandaloneHTMLBuilder(Builder):
# 0.x compatible mode: insert custom sidebar before searchbox
customsidebar = sidebars
sidebars = None
warnings.warn('Now html_sidebars only allows list of sidebar '
'templates as a value. Support for a string value '
'will be removed at Sphinx-2.0.',
RemovedInSphinx20Warning)
ctx['sidebars'] = sidebars
ctx['customsidebar'] = customsidebar