IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #8748 from tk0miya/6550_deprecation_warning_for_html_add_permalinks

Browse Source 
Fix #6550: Emit a deprecation warning for html_add_permalinks
This commit is contained in:
Takeshi KOMIYA 2021-01-25 20:34:09 +09:00 committed by GitHub
commit eaa14bb0b0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
sphinx/builders/html/__init__.py
View File

@ -1234,6 +1234,9 @@ def validate_html_favicon(app: Sphinx, config: Config) -> None:
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