mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Fix #4209: intersphinx: In link title, "v" should be optional if target has no version
This commit is contained in:
parent
84551aa9c2
commit
aa47e9decc
2
CHANGES
2
CHANGES
@ -30,6 +30,8 @@ Bugs fixed
|
|||||||
* #3952: apidoc: module header is too escaped
|
* #3952: apidoc: module header is too escaped
|
||||||
* #4275: Formats accepted by sphinx.util.i18n.format_date are limited
|
* #4275: Formats accepted by sphinx.util.i18n.format_date are limited
|
||||||
* #4493: recommonmark raises AttributeError if AutoStructify enabled
|
* #4493: recommonmark raises AttributeError if AutoStructify enabled
|
||||||
|
* #4209: intersphinx: In link title, "v" should be optional if target has no
|
||||||
|
version
|
||||||
|
|
||||||
Testing
|
Testing
|
||||||
--------
|
--------
|
||||||
|
@ -315,8 +315,11 @@ def missing_reference(app, env, node, contnode):
|
|||||||
if '://' not in uri and node.get('refdoc'):
|
if '://' not in uri and node.get('refdoc'):
|
||||||
# get correct path in case of subdirectories
|
# get correct path in case of subdirectories
|
||||||
uri = path.join(relative_path(node['refdoc'], '.'), uri)
|
uri = path.join(relative_path(node['refdoc'], '.'), uri)
|
||||||
newnode = nodes.reference('', '', internal=False, refuri=uri,
|
if version:
|
||||||
reftitle=_('(in %s v%s)') % (proj, version))
|
reftitle = _('(in %s v%s)') % (proj, version)
|
||||||
|
else:
|
||||||
|
reftitle = _('(in %s)') % (proj,)
|
||||||
|
newnode = nodes.reference('', '', internal=False, refuri=uri, reftitle=reftitle)
|
||||||
if node.get('refexplicit'):
|
if node.get('refexplicit'):
|
||||||
# use whatever title was given
|
# use whatever title was given
|
||||||
newnode.append(contnode)
|
newnode.append(contnode)
|
||||||
|
@ -24,7 +24,7 @@ from sphinx.ext.intersphinx import (
|
|||||||
load_mappings, missing_reference, _strip_basic_auth,
|
load_mappings, missing_reference, _strip_basic_auth,
|
||||||
_get_safe_url, fetch_inventory, INVENTORY_FILENAME, debug
|
_get_safe_url, fetch_inventory, INVENTORY_FILENAME, debug
|
||||||
)
|
)
|
||||||
from test_util_inventory import inventory_v2
|
from test_util_inventory import inventory_v2, inventory_v2_not_having_version
|
||||||
|
|
||||||
|
|
||||||
def fake_node(domain, type, target, content, **attrs):
|
def fake_node(domain, type, target, content, **attrs):
|
||||||
@ -271,6 +271,25 @@ def test_missing_reference_jsdomain(tempdir, app, status, warning):
|
|||||||
assert rn.astext() == 'baz()'
|
assert rn.astext() == 'baz()'
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.xfail(os.name != 'posix', reason="Path separator mismatch issue")
|
||||||
|
def test_inventory_not_having_version(tempdir, app, status, warning):
|
||||||
|
inv_file = tempdir / 'inventory'
|
||||||
|
inv_file.write_bytes(inventory_v2_not_having_version)
|
||||||
|
app.config.intersphinx_mapping = {
|
||||||
|
'https://docs.python.org/': inv_file,
|
||||||
|
}
|
||||||
|
app.config.intersphinx_cache_limit = 0
|
||||||
|
|
||||||
|
# load the inventory and check if it's done correctly
|
||||||
|
load_mappings(app)
|
||||||
|
|
||||||
|
rn = reference_check(app, 'py', 'mod', 'module1', 'foo')
|
||||||
|
assert isinstance(rn, nodes.reference)
|
||||||
|
assert rn['refuri'] == 'https://docs.python.org/foo.html#module-module1'
|
||||||
|
assert rn['reftitle'] == '(in foo)'
|
||||||
|
assert rn[0].astext() == 'Long Module desc'
|
||||||
|
|
||||||
|
|
||||||
def test_load_mappings_warnings(tempdir, app, status, warning):
|
def test_load_mappings_warnings(tempdir, app, status, warning):
|
||||||
"""
|
"""
|
||||||
load_mappings issues a warning if new-style mapping
|
load_mappings issues a warning if new-style mapping
|
||||||
|
@ -50,6 +50,15 @@ foo.bar.qux js:data 1 index.html#foo.bar.qux -
|
|||||||
a term including:colon std:term -1 glossary.html#term-a-term-including-colon -
|
a term including:colon std:term -1 glossary.html#term-a-term-including-colon -
|
||||||
'''.encode('utf-8'))
|
'''.encode('utf-8'))
|
||||||
|
|
||||||
|
inventory_v2_not_having_version = '''\
|
||||||
|
# Sphinx inventory version 2
|
||||||
|
# Project: foo
|
||||||
|
# Version:
|
||||||
|
# The remainder of this file is compressed with zlib.
|
||||||
|
'''.encode('utf-8') + zlib.compress('''\
|
||||||
|
module1 py:module 0 foo.html#module-module1 Long Module desc
|
||||||
|
'''.encode('utf-8'))
|
||||||
|
|
||||||
|
|
||||||
def test_read_inventory_v1():
|
def test_read_inventory_v1():
|
||||||
f = BytesIO(inventory_v1)
|
f = BytesIO(inventory_v1)
|
||||||
@ -76,3 +85,10 @@ def test_read_inventory_v2():
|
|||||||
'/util/glossary.html#term-a-term'
|
'/util/glossary.html#term-a-term'
|
||||||
assert invdata['std:term']['a term including:colon'][2] == \
|
assert invdata['std:term']['a term including:colon'][2] == \
|
||||||
'/util/glossary.html#term-a-term-including-colon'
|
'/util/glossary.html#term-a-term-including-colon'
|
||||||
|
|
||||||
|
|
||||||
|
def test_read_inventory_v2_not_having_version():
|
||||||
|
f = BytesIO(inventory_v2_not_having_version)
|
||||||
|
invdata = InventoryFile.load(f, '/util', posixpath.join)
|
||||||
|
assert invdata['py:module']['module1'] == \
|
||||||
|
('foo', '', '/util/foo.html#module-module1', 'Long Module desc')
|
||||||
|
Loading…
Reference in New Issue
Block a user