mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
41b363dbff
This commit adds a `level` option to the `rubric` directive, which propagates a `level` attribute to the `rubric` node, and allows renderers to select a specific heading level. Logic for this attribute has been added to the HTML5 and LaTeX builder.
133 lines
5.0 KiB
Python
133 lines
5.0 KiB
Python
"""Test the build process with Texinfo builder with the test root."""
|
|
|
|
import re
|
|
import subprocess
|
|
from pathlib import Path
|
|
from subprocess import CalledProcessError
|
|
from unittest.mock import Mock
|
|
|
|
import pytest
|
|
|
|
from sphinx.builders.texinfo import default_texinfo_documents
|
|
from sphinx.config import Config
|
|
from sphinx.util.docutils import new_document
|
|
from sphinx.writers.texinfo import TexinfoTranslator
|
|
|
|
|
|
@pytest.mark.sphinx('texinfo')
|
|
def test_texinfo(app, status, warning):
|
|
TexinfoTranslator.ignore_missing_images = True
|
|
app.build(force_all=True)
|
|
result = (app.outdir / 'sphinxtests.texi').read_text(encoding='utf8')
|
|
assert ('@anchor{markup doc}@anchor{11}'
|
|
'@anchor{markup id1}@anchor{12}'
|
|
'@anchor{markup testing-various-markup}@anchor{13}' in result)
|
|
assert 'Footnotes' not in result
|
|
# now, try to run makeinfo over it
|
|
try:
|
|
args = ['makeinfo', '--no-split', 'sphinxtests.texi']
|
|
subprocess.run(args, capture_output=True, cwd=app.outdir, check=True)
|
|
except OSError as exc:
|
|
raise pytest.skip.Exception from exc # most likely makeinfo was not found
|
|
except CalledProcessError as exc:
|
|
print(exc.stdout)
|
|
print(exc.stderr)
|
|
msg = f'makeinfo exited with return code {exc.retcode}'
|
|
raise AssertionError(msg) from exc
|
|
|
|
|
|
@pytest.mark.sphinx('texinfo', testroot='markup-rubric')
|
|
def test_texinfo_rubric(app, status, warning):
|
|
app.build()
|
|
|
|
output = (app.outdir / 'projectnamenotset.texi').read_text(encoding='utf8')
|
|
assert '@heading This is a rubric' in output
|
|
assert '@heading This is a multiline rubric' in output
|
|
assert '@heading A rubric with a heading level' in output
|
|
|
|
|
|
@pytest.mark.sphinx('texinfo', testroot='markup-citation')
|
|
def test_texinfo_citation(app, status, warning):
|
|
app.build(force_all=True)
|
|
|
|
output = (app.outdir / 'projectnamenotset.texi').read_text(encoding='utf8')
|
|
assert 'This is a citation ref; @ref{1,,[CITE1]} and @ref{2,,[CITE2]}.' in output
|
|
assert ('@anchor{index cite1}@anchor{1}@w{(CITE1)} \n'
|
|
'This is a citation\n') in output
|
|
assert ('@anchor{index cite2}@anchor{2}@w{(CITE2)} \n'
|
|
'This is a multiline citation\n') in output
|
|
|
|
|
|
def test_default_texinfo_documents():
|
|
config = Config({'project': 'STASI™ Documentation',
|
|
'author': "Wolfgang Schäuble & G'Beckstein"})
|
|
expected = [('index', 'stasi', 'STASI™ Documentation',
|
|
"Wolfgang Schäuble & G'Beckstein", 'stasi',
|
|
'One line description of project', 'Miscellaneous')]
|
|
assert default_texinfo_documents(config) == expected
|
|
|
|
|
|
@pytest.mark.sphinx('texinfo')
|
|
def test_texinfo_escape_id(app, status, warning):
|
|
settings = Mock(title='',
|
|
texinfo_dir_entry='',
|
|
texinfo_elements={})
|
|
document = new_document('', settings)
|
|
translator = app.builder.create_translator(document, app.builder)
|
|
|
|
assert translator.escape_id('Hello world') == 'Hello world'
|
|
assert translator.escape_id('Hello world') == 'Hello world'
|
|
assert translator.escape_id('Hello Sphinx world') == 'Hello Sphinx world'
|
|
assert translator.escape_id('Hello:world') == 'Hello world'
|
|
assert translator.escape_id('Hello(world)') == 'Hello world'
|
|
assert translator.escape_id('Hello world.') == 'Hello world'
|
|
assert translator.escape_id('.') == '.'
|
|
|
|
|
|
@pytest.mark.sphinx('texinfo', testroot='footnotes')
|
|
def test_texinfo_footnote(app, status, warning):
|
|
app.build(force_all=True)
|
|
|
|
output = (app.outdir / 'projectnamenotset.texi').read_text(encoding='utf8')
|
|
assert 'First footnote: @footnote{\nFirst\n}' in output
|
|
|
|
|
|
@pytest.mark.sphinx('texinfo')
|
|
def test_texinfo_xrefs(app, status, warning):
|
|
app.build(force_all=True)
|
|
output = (app.outdir / 'sphinxtests.texi').read_text(encoding='utf8')
|
|
assert re.search(r'@ref{\w+,,--plugin\.option}', output)
|
|
|
|
# Now rebuild it without xrefs
|
|
app.config.texinfo_cross_references = False
|
|
app.build(force_all=True)
|
|
output = (app.outdir / 'sphinxtests.texi').read_text(encoding='utf8')
|
|
assert not re.search(r'@ref{\w+,,--plugin\.option}', output)
|
|
assert 'Link to perl +p, --ObjC++, --plugin.option, create-auth-token, arg and -j' in output
|
|
|
|
|
|
@pytest.mark.sphinx('texinfo', testroot='root')
|
|
def test_texinfo_samp_with_variable(app, status, warning):
|
|
app.build()
|
|
|
|
output = (app.outdir / 'sphinxtests.texi').read_text(encoding='utf8')
|
|
|
|
assert '@code{@var{variable_only}}' in output
|
|
assert '@code{@var{variable} and text}' in output
|
|
assert '@code{Show @var{variable} in the middle}' in output
|
|
|
|
|
|
@pytest.mark.sphinx('texinfo', testroot='images')
|
|
def test_copy_images(app, status, warning):
|
|
app.build()
|
|
|
|
images_dir = Path(app.outdir) / 'projectnamenotset-figures'
|
|
images = {image.name for image in images_dir.rglob('*')}
|
|
images.discard('python-logo.png')
|
|
assert images == {
|
|
'ba30773957c3fe046897111afd65a80b81cad089.png', # texinfo: image from data:image/png URI in source
|
|
'img.png',
|
|
'rimg.png',
|
|
'testimäge.png',
|
|
}
|