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

extlinks: Disable hardcoded links detector by default (refs: #10126)

Browse Source 
The hardcoded links detector added since 4.4.0 causes troubles in many
projects.  Therefore, this disables it by default, and adds a new
configuration `extlinks_detect_hardcoded_links` to enable it explicitly.
This commit is contained in:
Takeshi KOMIYA
2022-01-22 11:59:09 +09:00
parent a0679463a1
commit c6230dc4db
6 changed files with 26 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/usage/extensions/extlinks.rst
View File

@@ -59,3 +59,11 @@ The extension adds a config value:
Since links are generated from the role in the reading stage, they appear as
ordinary links to e.g. the ``linkcheck`` builder.
.. confval:: extlinks_detect_hardcoded_links
If enabled, extlinks emits a warning if a hardcoded link is replaceable
by an extlink, and suggests a replacement via warning. It defaults to
``False``.
.. versionadded:: 4.5