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

apply review suggestions

Browse Source 
Signed-off-by: Oleg Hoefling <oleg.hoefling@gmail.com>
This commit is contained in:
Oleg Hoefling 2021-11-12 09:56:16 +01:00
parent bc5dd0e6f3
commit 7b318d8acb
No known key found for this signature in database
GPG Key ID: 0F2974E780119EEA
1 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
sphinx/ext/extlinks.py
View File

@ -42,6 +42,8 @@ from sphinx.util import logging
from sphinx.util.nodes import split_explicit_title
from sphinx.util.typing import RoleFunction
logger = logging.getLogger(__name__)
class ExternalLinksChecker(SphinxPostTransform):
"""
@ -50,7 +52,7 @@ class ExternalLinksChecker(SphinxPostTransform):
We treat each ``reference`` node without ``internal`` attribute as an external link.
"""
default_priority = 900
default_priority = 100
def run(self, **kwargs: Any) -> None:
for refnode in self.document.traverse(nodes.reference):
@ -65,21 +67,18 @@ class ExternalLinksChecker(SphinxPostTransform):
return
uri = refnode['refuri']
lineno = sphinx.util.nodes.get_node_line(refnode)
extlinks_config = getattr(self.app.config, 'extlinks', dict())
for alias, (base_uri, caption) in extlinks_config.items():
for alias, (base_uri, caption) in self.app.config.extlinks.items():
uri_pattern = re.compile(base_uri.replace('%s', '(?P<value>.+)'))
match = uri_pattern.match(uri)
if match and match.groupdict().get('value'):
# build a replacement suggestion
replacement = f":{alias}:`{match.groupdict().get('value')}`"
location = (self.env.docname, lineno)
logger.warning(
'hardcoded link %r could be replaced by an extlink (try using %r instead)',
__('hardcoded link %r could be replaced by an extlink (try using %r instead)'),
uri,
replacement,
location=location,
location=refnode,
)