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

Move env._warn_missing_reference() to ReferenceResolver

Browse Source
This commit is contained in:
Takeshi KOMIYA 2017-03-10 11:21:58 +09:00
parent ff94ba9f89
commit 5a7eb99e46
2 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
sphinx/environment/__init__.py
View File

@ -943,31 +943,6 @@ class BuildEnvironment(object):
# allow custom references to be resolved
self.app.emit('doctree-resolved', doctree, docname)
def _warn_missing_reference(self, refdoc, typ, target, node, domain):
# type: (unicode, unicode, unicode, nodes.Node, Domain) -> None
warn = node.get('refwarn')
if self.config.nitpicky:
warn = True
if self._nitpick_ignore:
dtype = domain and '%s:%s' % (domain.name, typ) or typ
if (dtype, target) in self._nitpick_ignore:
warn = False
# for "std" types also try without domain name
if (not domain or domain.name == 'std') and \
(typ, target) in self._nitpick_ignore:
warn = False
if not warn:
return
if domain and typ in domain.dangling_warnings:
msg = domain.dangling_warnings[typ]
elif node.get('refdomain', 'std') not in ('', 'std'):
msg = '%s:%s reference target not found: %%(target)s' % \
(node['refdomain'], typ)
else:
msg = '%r reference target not found: %%(target)s' % typ
logger.warning(msg % {'target': target},
location=node, type='ref', subtype=typ)
def create_index(self, builder, group_entries=True,
_fixre=re.compile(r'(.*) ([(][^()]*[)])')):
# type: (Builder, bool, Pattern) -> List[Tuple[unicode, List[Tuple[unicode, List[unicode]]]]] # NOQA

27
sphinx/transforms/post_transforms.py
View File

@ -63,7 +63,7 @@ class ReferencesResolver(SphinxTransform):
# still not found? warn if node wishes to be warned about or
# we are in nit-picky mode
if newnode is None:
self.env._warn_missing_reference(refdoc, typ, target, node, domain)
self.warn_missing_reference(refdoc, typ, target, node, domain)
except NoUri:
newnode = contnode
node.replace_self(newnode or contnode)
@ -113,6 +113,31 @@ class ReferencesResolver(SphinxTransform):
newnode[0]['classes'].append(res_role.replace(':', '-'))
return newnode
def warn_missing_reference(self, refdoc, typ, target, node, domain):
# type: (unicode, unicode, unicode, nodes.Node, Domain) -> None
warn = node.get('refwarn')
if self.config.nitpicky:
warn = True
if self._nitpick_ignore:
dtype = domain and '%s:%s' % (domain.name, typ) or typ
if (dtype, target) in self._nitpick_ignore:
warn = False
# for "std" types also try without domain name
if (not domain or domain.name == 'std') and \
(typ, target) in self._nitpick_ignore:
warn = False
if not warn:
return
if domain and typ in domain.dangling_warnings:
msg = domain.dangling_warnings[typ]
elif node.get('refdomain', 'std') not in ('', 'std'):
msg = (_('%s:%s reference target not found: %%(target)s') %
(node['refdomain'], typ))
else:
msg = _('%r reference target not found: %%(target)s') % typ
logger.warning(msg % {'target': target},
location=node, type='ref', subtype=typ)
class OnlyNodeTransform(SphinxTransform):
default_priority = 50