Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

migrate html_add_permalinks=None and html_add_permalinks="" #8905

Merged
merged 4 commits into from
Feb 28, 2021
Merged

migrate html_add_permalinks=None and html_add_permalinks="" #8905

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7dacbd9
migrate html_add_permalinks=None and html_add_permalinks=""
graingert Feb 17, 2021
4f01fe0
Merge branch 'master' into patch-1
graingert Feb 28, 2021
ae5986f
Update sphinx/builders/html/__init__.py
graingert Feb 28, 2021
878c116
Update sphinx/builders/html/__init__.py
graingert Feb 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
31 changes: 21 additions & 10 deletions sphinx/builders/html/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1248,18 +1248,29 @@ def validate_html_favicon(app: Sphinx, config: Config) -> None:
config.html_favicon = None # type: ignore


UNSET = object()


def migrate_html_add_permalinks(app: Sphinx, config: Config) -> None:
"""Migrate html_add_permalinks to html_permalinks*."""
if config.html_add_permalinks:
# RemovedInSphinx60Warning
logger.warning(__('html_add_permalinks has been deprecated since v3.5.0. '
'Please use html_permalinks and html_permalinks_icon instead.'))
if (isinstance(config.html_add_permalinks, bool) and
config.html_add_permalinks is False):
config.html_permalinks = False # type: ignore
else:
config.html_permalinks_icon = html.escape(config.html_add_permalinks) # type: ignore # NOQA
html_add_permalinks = config.html_add_permalinks
if html_add_permalinks is UNSET:
return

# RemovedInSphinx60Warning
logger.warning(__('html_add_permalinks has been deprecated since v3.5.0. '
'Please use html_permalinks and html_permalinks_icon instead.'))
if (
html_add_permalinks is None or
html_add_permalinks is False or
html_add_permalinks == ""
graingert marked this conversation as resolved.
Show resolved Hide resolved
):
graingert marked this conversation as resolved.
Show resolved Hide resolved
config.html_permalinks = False # type: ignore[attr-defined]
return

config.html_permalinks_icon = html.escape( # type: ignore[attr-defined]
config.html_add_permalinks
graingert marked this conversation as resolved.
Show resolved Hide resolved
)

# for compatibility
import sphinxcontrib.serializinghtml # NOQA
Expand Down Expand Up @@ -1291,7 +1302,7 @@ def setup(app: Sphinx) -> Dict[str, Any]:
app.add_config_value('html_sidebars', {}, 'html')
app.add_config_value('html_additional_pages', {}, 'html')
app.add_config_value('html_domain_indices', True, 'html', [list])
app.add_config_value('html_add_permalinks', None, 'html')
app.add_config_value('html_add_permalinks', UNSET, 'html')
app.add_config_value('html_permalinks', True, 'html')
app.add_config_value('html_permalinks_icon', '¶', 'html')
app.add_config_value('html_use_index', True, 'html')
Expand Down