Skip to content
New issue

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

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

Already on GitHub? # to your account

intersphinx: Resolve implicit self-references #13322

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions sphinx/ext/intersphinx/_resolve.py
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,8 @@ def resolve_reference_detect_inventory(
to form ``inv_name:new_target``. If ``inv_name`` is a named inventory, then resolution
is tried in that inventory with the new target.
"""
resolve_self = env.config.intersphinx_resolve_self

# ordinary direct lookup, use data as is
res = resolve_reference_any_inventory(env, True, node, contnode)
if res is not None:
Expand All @@ -318,6 +320,14 @@ def resolve_reference_detect_inventory(
if ':' not in target:
return None
inv_name, _, new_target = target.partition(':')

# check if the target is self-referential
self_referential = bool(resolve_self) and resolve_self == inv_name
if self_referential:
node['reftarget'] = new_target
node['intersphinx_self_referential'] = True
return None

if not inventory_exists(env, inv_name):
return None
node['reftarget'] = new_target
Expand Down
17 changes: 17 additions & 0 deletions sphinx/transforms/post_transforms/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,23 @@ def _resolve_pending_xref(
if new_node is not None:
return new_node

# Is this a self-referential intersphinx reference?
if 'intersphinx_self_referential' in node:
del node.attributes['intersphinx_self_referential']
try:
new_node = self._resolve_pending_xref_in_domain(
domain=domain,
node=node,
contnode=contnode,
ref_doc=ref_doc,
typ=typ,
target=node['reftarget'],
)
except NoUri:
return None
if new_node is not None:
return new_node

# Still not found? Emit a warning if we are in nitpicky mode
# or if the node wishes to be warned about.
self.warn_missing_reference(ref_doc, typ, target, node, domain)
Expand Down
1 change: 1 addition & 0 deletions tests/test_extensions/test_ext_intersphinx.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ def set_config(app, mapping):
app.config.intersphinx_mapping = mapping.copy()
app.config.intersphinx_cache_limit = 0
app.config.intersphinx_disabled_reftypes = []
app.config.intersphinx_resolve_self = ''
app.config.intersphinx_timeout = None


Expand Down