mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
90 lines
3.4 KiB
Python
90 lines
3.4 KiB
Python
"""Test the HTML builder and check output against XPath."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import re
|
|
from unittest.mock import patch
|
|
|
|
import pytest
|
|
|
|
from tests.test_builders.xpath_html_util import _intradocument_hyperlink_check
|
|
from tests.test_builders.xpath_util import check_xpath
|
|
|
|
|
|
@pytest.mark.sphinx('html', testroot='toctree-glob')
|
|
def test_relations(app):
|
|
app.build(force_all=True)
|
|
assert app.builder.relations['index'] == [None, None, 'foo']
|
|
assert app.builder.relations['foo'] == ['index', 'index', 'bar/index']
|
|
assert app.builder.relations['bar/index'] == ['index', 'foo', 'bar/bar_1']
|
|
assert app.builder.relations['bar/bar_1'] == ['bar/index', 'bar/index', 'bar/bar_2']
|
|
assert app.builder.relations['bar/bar_2'] == ['bar/index', 'bar/bar_1', 'bar/bar_3']
|
|
assert app.builder.relations['bar/bar_3'] == [
|
|
'bar/index',
|
|
'bar/bar_2',
|
|
'bar/bar_4/index',
|
|
]
|
|
assert app.builder.relations['bar/bar_4/index'] == ['bar/index', 'bar/bar_3', 'baz']
|
|
assert app.builder.relations['baz'] == ['index', 'bar/bar_4/index', 'qux/index']
|
|
assert app.builder.relations['qux/index'] == ['index', 'baz', 'qux/qux_1']
|
|
assert app.builder.relations['qux/qux_1'] == ['qux/index', 'qux/index', 'qux/qux_2']
|
|
assert app.builder.relations['qux/qux_2'] == ['qux/index', 'qux/qux_1', None]
|
|
assert 'quux' not in app.builder.relations
|
|
|
|
|
|
@pytest.mark.sphinx('singlehtml', testroot='toctree-empty')
|
|
def test_singlehtml_toctree(app):
|
|
app.build(force_all=True)
|
|
try:
|
|
app.builder._get_local_toctree('index')
|
|
except AttributeError:
|
|
pytest.fail('Unexpected AttributeError in app.builder.fix_refuris')
|
|
|
|
|
|
@pytest.mark.sphinx(
|
|
'html',
|
|
testroot='toctree',
|
|
srcdir='numbered-toctree',
|
|
)
|
|
def test_numbered_toctree(app):
|
|
# give argument to :numbered: option
|
|
index = (app.srcdir / 'index.rst').read_text(encoding='utf8')
|
|
index = re.sub(':numbered:.*', ':numbered: 1', index)
|
|
(app.srcdir / 'index.rst').write_text(index, encoding='utf8')
|
|
app.build(force_all=True)
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
'expect',
|
|
[
|
|
# internal references should be same-document; external should not
|
|
(".//a[@class='reference internal']", _intradocument_hyperlink_check),
|
|
(".//a[@class='reference external']", r'https?://'),
|
|
],
|
|
)
|
|
@pytest.mark.sphinx('singlehtml', testroot='toctree')
|
|
def test_singlehtml_hyperlinks(app, cached_etree_parse, expect):
|
|
app.build()
|
|
check_xpath(cached_etree_parse(app.outdir / 'index.html'), 'index.html', *expect)
|
|
|
|
|
|
@pytest.mark.sphinx(
|
|
'html',
|
|
testroot='toctree-multiple-parents',
|
|
confoverrides={'html_theme': 'alabaster'},
|
|
)
|
|
def test_toctree_multiple_parents(app, cached_etree_parse):
|
|
# The lexicographically greatest parent of the document in global toctree
|
|
# should be chosen, regardless of the order in which files are read
|
|
with patch.object(app.builder, '_read_serial') as m:
|
|
# Read files in reversed order
|
|
_read_serial = type(app.builder)._read_serial
|
|
m.side_effect = lambda docnames: _read_serial(app.builder, docnames[::-1])
|
|
app.build()
|
|
# Check if charlie is a child of delta in charlie.html
|
|
xpath_delta_children = (
|
|
".//ul[@class='current']//a[@href='delta.html']/../ul/li//a"
|
|
)
|
|
etree = cached_etree_parse(app.outdir / 'charlie.html')
|
|
check_xpath(etree, 'charlie.html', xpath=xpath_delta_children, check='Charlie')
|