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

#3998: Add optional section numbering in plain text output

Browse Source 
Controlled by new config values: text_add_secnumbers and
text_secnumber_suffix.
This commit is contained in:
Matthew Woodcraft
2017-11-05 22:47:57 +00:00
parent f46c91b652
commit 6b15c9c1c7
9 changed files with 105 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
tests/test_build_text.py
View File

@@ -110,3 +110,57 @@ def test_list_items_in_admonition(app, status, warning):
assert lines[2] == " * item 1"
assert lines[3] == ""
assert lines[4] == " * item 2"
@with_text_app()
def test_secnums(app, status, warning):
app.builder.build_all()
result = (app.outdir / 'doc2.txt').text(encoding='utf8')
expect = (
"Section B\n"
"*********\n"
"\n"
"\n"
"Sub Ba\n"
"======\n"
"\n"
"\n"
"Sub Bb\n"
"======\n"
)
assert result == expect
app.config.text_add_secnumbers = True
app.builder.build_all()
result = (app.outdir / 'doc2.txt').text(encoding='utf8')
expect = (
"2. Section B\n"
"************\n"
"\n"
"\n"
"2.1. Sub Ba\n"
"===========\n"
"\n"
"\n"
"2.2. Sub Bb\n"
"===========\n"
)
assert result == expect
app.config.text_secnumber_suffix = " "
app.builder.build_all()
result = (app.outdir / 'doc2.txt').text(encoding='utf8')
expect = (
"2 Section B\n"
"***********\n"
"\n"
"\n"
"2.1 Sub Ba\n"
"==========\n"
"\n"
"\n"
"2.2 Sub Bb\n"
"==========\n"
)
assert result == expect