a single string value for html_sidebars will be deprecated in 2.0
#4178
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jfbu
requested changes
Oct 24, 2017
CHANGES
Outdated
| @@ -15,6 +15,8 @@ Incompatible changes | |||
| Deprecated | |||
| ---------- | |||
|
|
|||
| * a single string value for :confval:`html_sidebars` will be deprecated in 2.0. | |||
|
|
|||
There was a problem hiding this comment.
Do you mean something like:
* using a string value for :confval:`html_sidebars` is deprecated and only list
values will be accepted at 2.0.
doc/config.rst
Outdated
| .. deprecated:: 2.0 | ||
|
|
||
| a single string value for ``html_sidebars`` will be deprecated in 2.0 | ||
|
|
There was a problem hiding this comment.
It is not clear to me if you mean it is deprecated at 1.7 and removed at 2.0 or simply deprecated at 2.0.
sphinx/builders/html.py
Outdated
| warnings.warn('Now html_sidebars allows list of sidebar templates ' | ||
| 'as a value. The string value will be deprecated in ' | ||
| 'Sphinx-2.0.', RemovedInSphinx20Warning) | ||
|
|
There was a problem hiding this comment.
It seems you mean it is deprecated at 1.7 and will be removed at 2.0 ?
tk0miya
force-pushed
the
deprecate_string_for_html_sidebars
branch
from
6771acf
to
83c266a
Compare
|
Thank you for reviewing! I just updated.
|
|
Thank you for reviewing! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Feature or Bugfix
Purpose
html_sidebarsaccepts a string as a value to keep compatible with 0.x