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

manpage: Stop creating a section directory on build manpage by default

Browse Source
This commit is contained in:
Takeshi KOMIYA 2021-05-15 22:17:20 +09:00
parent 1ab7e28db8
commit 630e5bd15f
5 changed files with 15 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES
View File

@ -8,6 +8,8 @@ Incompatible changes
--------------------
* #9222: Update Underscore.js to 1.13.1
* #9217: manpage: Stop creating a section directory on build manpage by default
(see :confval:`man_make_section_directory`)
Deprecated
----------

4
doc/usage/configuration.rst
View File

@ -2339,6 +2339,10 @@ These options influence manual page output.
The default is changed to ``False`` from ``True``.
.. versionchanged:: 4.0.2
The default is changed to ``True`` from ``False`` again.
.. _texinfo-options:
Options for Texinfo output

2
sphinx/builders/manpage.py
View File

@ -118,7 +118,7 @@ def setup(app: Sphinx) -> Dict[str, Any]:
app.add_config_value('man_pages', default_man_pages, None)
app.add_config_value('man_show_urls', False, None)
app.add_config_value('man_make_section_directory', True, None)
app.add_config_value('man_make_section_directory', False, None)
return {
'version': 'builtin',

12
tests/test_build_manpage.py
View File

@ -17,9 +17,9 @@ from sphinx.config import Config
@pytest.mark.sphinx('man')
def test_all(app, status, warning):
app.builder.build_all()
assert (app.outdir / '1' / 'sphinxtests.1').exists()
assert (app.outdir / 'sphinxtests.1').exists()
content = (app.outdir / '1' / 'sphinxtests.1').read_text()
content = (app.outdir / 'sphinxtests.1').read_text()
assert r'\fBprint \fP\fIi\fP\fB\en\fP' in content
assert r'\fBmanpage\en\fP' in content
@ -31,16 +31,16 @@ def test_all(app, status, warning):
@pytest.mark.sphinx('man', testroot='basic',
confoverrides={'man_make_section_directory': False})
confoverrides={'man_make_section_directory': True})
def test_man_make_section_directory(app, status, warning):
app.build()
assert (app.outdir / 'python.1').exists()
assert (app.outdir / '1' / 'python.1').exists()
@pytest.mark.sphinx('man', testroot='directive-code')
def test_captioned_code_block(app, status, warning):
app.builder.build_all()
content = (app.outdir / '1' / 'python.1').read_text()
content = (app.outdir / 'python.1').read_text()
assert ('.sp\n'
'caption \\fItest\\fP rb\n'
@ -71,5 +71,5 @@ def test_default_man_pages():
@pytest.mark.sphinx('man', testroot='markup-rubric')
def test_rubric(app, status, warning):
app.build()
content = (app.outdir / '1' / 'python.1').read_text()
content = (app.outdir / 'python.1').read_text()
assert 'This is a rubric\n' in content

4
tests/test_smartquotes.py
View File

@ -31,7 +31,7 @@ def test_text_builder(app, status, warning):
def test_man_builder(app, status, warning):
app.build()
content = (app.outdir / '1' / 'python.1').read_text()
content = (app.outdir / 'python.1').read_text()
assert '\\-\\- "Sphinx" is a tool that makes it easy ...' in content
@ -84,5 +84,5 @@ def test_smartquotes_excludes_language(app, status, warning):
def test_smartquotes_excludes_builders(app, status, warning):
app.build()
content = (app.outdir / '1' / 'python.1').read_text()
content = (app.outdir / 'python.1').read_text()
assert '– “Sphinx” is a tool that makes it easy …' in content