Fix #7095: dirhtml: Cross references are broken via intersphinx and :doc:

This commit is contained in:
Takeshi KOMIYA 2020-02-06 23:19:03 +09:00
parent 4198219bb1
commit 13ca2323a9
9 changed files with 79 additions and 1 deletions

View File

@ -83,6 +83,7 @@ Bugs fixed
* #6889: autodoc: Trailing comma in ``:members::`` option causes cryptic warning
* #7055: linkcheck: redirect is treated as an error
* #7090: std domain: Can't assign numfig-numbers for custom container nodes
* #7095: dirhtml: Cross references are broken via intersphinx and ``:doc:`` role
Testing
--------

View File

@ -122,7 +122,7 @@ class InventoryFile:
for line in stream.read_compressed_lines():
# be careful to handle names with embedded spaces correctly
m = re.match(r'(?x)(.+?)\s+(\S*:\S*)\s+(-?\d+)\s+(\S+)\s+(.*)',
m = re.match(r'(?x)(.+?)\s+(\S*:\S*)\s+(-?\d+)\s+?(\S*)\s+(.*)',
line.rstrip())
if not m:
continue

View File

@ -0,0 +1,4 @@
.. _bar:
bar
===

View File

View File

@ -0,0 +1,4 @@
.. _foo_1:
foo/foo_1
=========

View File

@ -0,0 +1,4 @@
.. _foo_2:
foo/foo_2
=========

View File

@ -0,0 +1,9 @@
.. _foo:
foo/index
=========
.. toctree::
foo_1
foo_2

View File

@ -0,0 +1,9 @@
.. _index:
index
=====
.. toctree::
foo/index
bar

View File

@ -0,0 +1,47 @@
"""
test_build_dirhtml
~~~~~~~~~~~~~~~~~~
Test dirhtml builder.
:copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
import posixpath
import pytest
from sphinx.util.inventory import InventoryFile
@pytest.mark.sphinx(buildername='dirhtml', testroot='builder-dirhtml')
def test_dirhtml(app, status, warning):
app.build()
assert (app.outdir / 'index.html').exists()
assert (app.outdir / 'foo/index.html').exists()
assert (app.outdir / 'foo/foo_1/index.html').exists()
assert (app.outdir / 'foo/foo_2/index.html').exists()
assert (app.outdir / 'bar/index.html').exists()
content = (app.outdir / 'index.html').text()
assert 'href="foo/"' in content
assert 'href="foo/foo_1/"' in content
assert 'href="foo/foo_2/"' in content
assert 'href="bar/"' in content
# objects.inv (refs: #7095)
f = (app.outdir / 'objects.inv').open('rb')
invdata = InventoryFile.load(f, 'path/to', posixpath.join)
assert 'index' in invdata.get('std:doc')
assert ('Python', '', 'path/to/', '-') == invdata['std:doc']['index']
assert 'foo/index' in invdata.get('std:doc')
assert ('Python', '', 'path/to/foo/', '-') == invdata['std:doc']['foo/index']
assert 'index' in invdata.get('std:label')
assert ('Python', '', 'path/to/#index', '-') == invdata['std:label']['index']
assert 'foo' in invdata.get('std:label')
assert ('Python', '', 'path/to/foo/#foo', 'foo/index') == invdata['std:label']['foo']