This is a :confval: to conf-title',
'This is a :hoverxref: to Configuration document',
'This is a :numref: to a Python code block (PyExample)'
]
for chunk in chunks:
assert chunk in content
@pytest.mark.sphinx(
srcdir=pythondomainsrcdir,
confoverrides={
'hoverxref_domains': ['py'],
},
)
def test_python_domain(app, status, warning):
app.build()
path = app.outdir / 'index.html'
assert path.exists() is True
content = open(path).read()
chunks = [
'This is a :py:class: role to a Python object',
'hoverxref.extension',
'hoverxref.extension.setup()',
'Constant',
]
for chunk in chunks:
assert chunk in content
@pytest.mark.sphinx(
srcdir=pythondomainsrcdir,
confoverrides={
'hoverxref_domains': ['py'],
'hoverxref_intersphinx': ['python'],
'hoverxref_auto_ref': True,
'extensions': [
'sphinx.ext.autodoc',
'sphinx.ext.autosectionlabel',
'sphinx.ext.intersphinx',
'hoverxref.extension',
],
},
)
def test_python_domain_intersphinx(app, status, warning):
app.build()
path = app.outdir / 'index.html'
assert path.exists() is True
content = open(path).read()
chunks = [
'This is a :py:class: role to a Python object',
'hoverxref.extension',
'hoverxref.extension.setup()',
'Constant',
]
for chunk in chunks:
assert chunk in content
@pytest.mark.skipif(sys.version_info >= (3, 12), reason="sphinxcontrib.bibtex is not compatible with Python 3.12")
@pytest.mark.sphinx(
srcdir=bibtexdomainsrcdir,
confoverrides={
'hoverxref_domains': ['cite'],
},
)
def test_bibtex_domain(app, status, warning):
app.build()
path = app.outdir / 'index.html'
assert path.exists() is True
content = open(path).read()
chunks = [
'See Nelson [Nel87] for an introduction to non-standard analysis.\nNon-standard analysis is fun [Nel87].
', ] for chunk in chunks: assert chunk in content @pytest.mark.sphinx( srcdir=srcdir, confoverrides={ 'hoverxref_roles': ['term'], }, ) def test_glossary_term_domain(app, status, warning): app.build() path = app.outdir / 'glossary.html' assert path.exists() is True content = open(path).read() chunks = [ 'See definition builder for more information.
', ] for chunk in chunks: assert chunk in content @pytest.mark.sphinx( srcdir=srcdir, confoverrides={ 'hoverxref_default_type': 'modal', }, ) def test_default_type(app, status, warning): app.build() path = app.outdir / 'index.html' assert path.exists() is True content = open(path).read() chunks = [ 'This a :ref: to Chapter I', 'This a :hoverxref: to Chapter I, Section I', ] for chunk in chunks: assert chunk in content @pytest.mark.sphinx( srcdir=srcdir, confoverrides={ 'hoverxref_ignore_refs': [ 'section i', ], }, ) def test_ignore_refs(app, status, warning): app.build() path = app.outdir / 'index.html' assert path.exists() is True content = open(path).read() chunks = [ 'This a :ref: to Chapter I', 'This a :hoverxref: to Chapter I, Section I', ] for chunk in chunks: assert chunk in content ignored_chunks = [ 'This a :hoverxref: to Chapter I, Section I', ] for chunk in ignored_chunks: assert chunk not in content @pytest.mark.sphinx( srcdir=intersphinxsrc, ) def test_intersphinx_default_configs(app, status, warning): app.build() path = app.outdir / 'index.html' assert path.exists() is True content = open(path).read() chunks_regex = [ r'This a :ref: to The Python Tutorial using intersphinx', r'This a :ref: to datetime.datetime Python’s function using intersphinx', r'This a :ref: to Config File v2 Read the Docs’ page using intersphinx', r'float',
]
chunks = [
'hoverxref.extension.setup()',
]
chunks.extend([
'float',
# Read the Docs' link does not have hoverxref enabled
r'This a :ref: to Config File v2 Read the Docs’ page using intersphinx',
]
chunks = [
# Python's domain does not have hoverxref enabled
'hoverxref.extension.setup()',
]
for chunk in chunks:
assert chunk in content
for chunk in chunks_regex:
assert re.search(chunk, content)
@pytest.mark.sphinx(
srcdir=intersphinxsrc,
confoverrides={
'hoverxref_intersphinx': [
'readthedocs',
'python',
],
'hoverxref_intersphinx_types': {
'readthedocs': 'modal',
'python': {
'class': 'modal',
}
},
'hoverxref_domains': ['py'],
'default_role': 'obj',
},
)
def test_intersphinx_all_mappings(app, status, warning):
app.build()
path = app.outdir / 'index.html'
assert path.exists() is True
content = open(path).read()
chunks_regex = [
# Python's links do have hoverxref enabled
r'This a :ref: to The Python Tutorial using intersphinx',
r'This a :ref: to datetime.datetime Python’s function using intersphinx',
r'Python\'s datetime.time.minute',
r'float',
# Read the Docs' link does have hoverxref enabled
r'This a :ref: to Config File v2 Read the Docs’ page using intersphinx',
# Using `default_role = 'obj'`
# Note the difference with the same `float` line previouly. Here it uses `py-obj` instead of `py-class`.
r'float'
]
chunks = [
# Python domain's link does have hoverxref enabled
'hoverxref.extension.setup()',
]
for chunk in chunks:
assert chunk in content
for chunk in chunks_regex:
assert re.search(chunk, content)