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

Fix #2789: sphinx.ext.intersphinx generates wrong hyperlinks if the inventory is given

Browse Source
This commit is contained in:
Takeshi KOMIYA
2016-08-11 11:19:42 +09:00
parent 0db59b677a
commit d5078a64d7
3 changed files with 51 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGES
View File

@@ -17,6 +17,7 @@ Bugs fixed
* #2775: Fix failing linkcheck with servers not supporting identidy encoding
* #2833: Fix formatting instance annotations in ext.autodoc.
* #1911: ``-D`` option of ``sphinx-build`` does not override the ``extensions`` variable
* #2789: `sphinx.ext.intersphinx` generates wrong hyperlinks if the inventory is given
Release 1.4.5 (released Jul 13, 2016)
=====================================

12
sphinx/ext/intersphinx.py
View File

@@ -239,12 +239,12 @@ def fetch_inventory(app, uri, inv):
return
try:
if hasattr(f, 'geturl'):
newuri = f.geturl()
if newuri.endswith("/" + INVENTORY_FILENAME):
newuri = newuri[:-len(INVENTORY_FILENAME) - 1]
if uri != newuri and uri != newuri + "/":
app.info('intersphinx inventory has moved: %s -> %s' % (uri, newuri))
uri = newuri
newinv = f.geturl()
if inv != newinv:
app.info('intersphinx inventory has moved: %s -> %s' % (inv, newinv))
if uri in (inv, path.dirname(inv), path.dirname(inv) + '/'):
uri = path.dirname(newinv)
line = f.readline().rstrip().decode('utf-8')
try:
if line == '# Sphinx inventory version 1':

45
tests/test_ext_intersphinx.py
View File

@@ -19,7 +19,7 @@ from docutils import nodes
from sphinx import addnodes
from sphinx.ext.intersphinx import read_inventory_v1, read_inventory_v2, \
load_mappings, missing_reference, _strip_basic_auth, _read_from_url, \
_get_safe_url
_get_safe_url, fetch_inventory, INVENTORY_FILENAME
from util import with_app, with_tempdir, mock
@@ -83,6 +83,49 @@ def test_read_inventory_v2():
'/util/glossary.html#term-a-term-including-colon'
@with_app()
@mock.patch('sphinx.ext.intersphinx.read_inventory_v2')
@mock.patch('sphinx.ext.intersphinx._read_from_url')
def test_fetch_inventory_redirection(app, status, warning, _read_from_url, read_inventory_v2):
_read_from_url().readline.return_value = '# Sphinx inventory version 2'
# same uri and inv, not redirected
_read_from_url().geturl.return_value = 'http://hostname/' + INVENTORY_FILENAME
fetch_inventory(app, 'http://hostname/', 'http://hostname/' + INVENTORY_FILENAME)
assert 'intersphinx inventory has moved' not in status.getvalue()
assert read_inventory_v2.call_args[0][1] == 'http://hostname/'
status.truncate(0)
# same uri and inv, redirected
status.truncate(0)
_read_from_url().geturl.return_value = 'http://hostname/new/' + INVENTORY_FILENAME
fetch_inventory(app, 'http://hostname/', 'http://hostname/' + INVENTORY_FILENAME)
assert status.getvalue() == ('intersphinx inventory has moved: '
'http://hostname/%s -> http://hostname/new/%s\n' %
(INVENTORY_FILENAME, INVENTORY_FILENAME))
print read_inventory_v2.call_args
assert read_inventory_v2.call_args[0][1] == 'http://hostname/new'
# different uri and inv, not redirected
status.truncate(0)
_read_from_url().geturl.return_value = 'http://hostname/new/' + INVENTORY_FILENAME
fetch_inventory(app, 'http://hostname/', 'http://hostname/new/' + INVENTORY_FILENAME)
assert 'intersphinx inventory has moved' not in status.getvalue()
assert read_inventory_v2.call_args[0][1] == 'http://hostname/'
# different uri and inv, redirected
status.truncate(0)
_read_from_url().geturl.return_value = 'http://hostname/other/' + INVENTORY_FILENAME
fetch_inventory(app, 'http://hostname/', 'http://hostname/new/' + INVENTORY_FILENAME)
assert status.getvalue() == ('intersphinx inventory has moved: '
'http://hostname/new/%s -> http://hostname/other/%s\n' %
(INVENTORY_FILENAME, INVENTORY_FILENAME))
assert read_inventory_v2.call_args[0][1] == 'http://hostname/'
@with_app()
@with_tempdir
def test_missing_reference(tempdir, app, status, warning):