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

Allow custom targets in the manpage role (#11825)

Browse Source 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
This commit is contained in:
Nicolas Peugnet
2024-01-17 02:09:18 +01:00
committed by GitHub
parent 95fb0e5e57
commit 59cf4d4c35
6 changed files with 48 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
tests/roots/test-manpage_url/index.rst
View File

@@ -1,3 +1,5 @@
* :manpage:`man(1)`
* :manpage:`ls.1`
* :manpage:`sphinx`
* :manpage:`mailx(1) <bsd-mailx/mailx.1>`
* :manpage:`!man(1)`

29
tests/test_build_html.py
View File

@@ -1492,18 +1492,25 @@ def test_html_sidebar(app, status, warning):
assert ctx['sidebars'] == []
@pytest.mark.parametrize(("fname", "expect"), flat_dict({
'index.html': [(".//em/a[@href='https://example.com/man.1']", "", True),
(".//em/a[@href='https://example.com/ls.1']", "", True),
(".//em/a[@href='https://example.com/sphinx.']", "", True)],
@pytest.mark.sphinx('html', testroot='manpage_url',
confoverrides={'manpages_url': 'https://example.com/{page}.{section}'})
def test_html_manpage(app, cached_etree_parse):
app.build(force_all=True)
}))
@pytest.mark.sphinx('html', testroot='manpage_url', confoverrides={
'manpages_url': 'https://example.com/{page}.{section}'})
@pytest.mark.test_params(shared_result='test_build_html_manpage_url')
def test_html_manpage(app, cached_etree_parse, fname, expect):
app.build()
check_xpath(cached_etree_parse(app.outdir / fname), fname, *expect)
content = (app.outdir / 'index.html').read_text(encoding='utf8')
assert ('<em class="manpage">'
'<a class="manpage reference external" href="https://example.com/man.1">man(1)</a>'
'</em>') in content
assert ('<em class="manpage">'
'<a class="manpage reference external" href="https://example.com/ls.1">ls.1</a>'
'</em>') in content
assert ('<em class="manpage">'
'<a class="manpage reference external" href="https://example.com/sphinx.">sphinx</a>'
'</em>') in content
assert ('<em class="manpage">'
'<a class="manpage reference external" href="https://example.com/bsd-mailx/mailx.1">mailx(1)</a>'
'</em>') in content
assert '<em class="manpage">man(1)</em>' in content
@pytest.mark.sphinx('html', testroot='toctree-glob',