mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
89e8cb3459
This could fix https://github.com/sphinx-doc/sphinx/issues/2262 The 1.3.5 Verbatim environment from sphinx.sty has many places allowing a page break after the caption: from the \smallskip, from the list environment, and from the \MakeFramed: indeed framed package documentation explains that it encourages page breaks above it. The only way to avoid the pagebreaks is to put the caption inside the environment whic is started by \MakeFramed. However, as this environment typesets multiple times its contents, we must inhibit within it the increase of counters (only the literal-block counter is concerned), this is done thanks to a switch provided by the package amsmath which is already loaded by sphinx.sty. modified: sphinx/texinputs/sphinx.sty modified: sphinx/writers/latex.py modified: tests/test_directive_code.py
234 lines
6.9 KiB
Python
234 lines
6.9 KiB
Python
# -*- coding: utf-8 -*-
|
|
"""
|
|
test_directive_code
|
|
~~~~~~~~~~~~~~~~~~~
|
|
|
|
Test the code-block directive.
|
|
|
|
:copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
|
|
:license: BSD, see LICENSE for details.
|
|
"""
|
|
|
|
from xml.etree import ElementTree
|
|
|
|
from util import with_app
|
|
|
|
|
|
@with_app('xml', testroot='directive-code')
|
|
def test_code_block(app, status, warning):
|
|
app.builder.build('index')
|
|
et = ElementTree.parse(app.outdir / 'index.xml')
|
|
secs = et.findall('./section/section')
|
|
code_block = secs[0].findall('literal_block')
|
|
assert len(code_block) > 0
|
|
actual = code_block[0].text
|
|
expect = (
|
|
" def ruby?\n" +
|
|
" false\n" +
|
|
" end"
|
|
)
|
|
assert actual == expect
|
|
|
|
|
|
@with_app('xml', testroot='directive-code')
|
|
def test_code_block_dedent(app, status, warning):
|
|
app.builder.build(['dedent_code'])
|
|
et = ElementTree.parse(app.outdir / 'dedent_code.xml')
|
|
blocks = et.findall('./section/section/literal_block')
|
|
|
|
for i in range(5): # 0-4
|
|
actual = blocks[i].text
|
|
indent = " " * (4 - i)
|
|
expect = (
|
|
indent + "def ruby?\n" +
|
|
indent + " false\n" +
|
|
indent + "end"
|
|
)
|
|
assert (i, actual) == (i, expect)
|
|
|
|
assert blocks[5].text == '\n\n' # dedent: 1000
|
|
|
|
|
|
@with_app('html', testroot='directive-code')
|
|
def test_code_block_caption_html(app, status, warning):
|
|
app.builder.build(['caption'])
|
|
html = (app.outdir / 'caption.html').text(encoding='utf-8')
|
|
caption = (u'<div class="code-block-caption">'
|
|
u'<span class="caption-text">caption <em>test</em> rb'
|
|
u'</span><a class="headerlink" href="#caption-test-rb" '
|
|
u'title="Permalink to this code">\xb6</a></div>')
|
|
assert caption in html
|
|
|
|
|
|
@with_app('latex', testroot='directive-code')
|
|
def test_code_block_caption_latex(app, status, warning):
|
|
app.builder.build_all()
|
|
latex = (app.outdir / 'Python.tex').text(encoding='utf-8')
|
|
caption = '\\setupcaptionforverbatim{literal-block}{caption \\emph{test} rb}'
|
|
assert caption in latex
|
|
|
|
|
|
@with_app('xml', testroot='directive-code')
|
|
def test_literal_include(app, status, warning):
|
|
app.builder.build(['index'])
|
|
et = ElementTree.parse(app.outdir / 'index.xml')
|
|
secs = et.findall('./section/section')
|
|
literal_include = secs[1].findall('literal_block')
|
|
literal_src = (app.srcdir / 'literal.inc').text(encoding='utf-8')
|
|
assert len(literal_include) > 0
|
|
actual = literal_include[0].text
|
|
assert actual == literal_src
|
|
|
|
|
|
@with_app('xml', testroot='directive-code')
|
|
def test_literal_include_dedent(app, status, warning):
|
|
literal_src = (app.srcdir / 'literal.inc').text(encoding='utf-8')
|
|
literal_lines = [l[4:] for l in literal_src.split('\n')[9:11]]
|
|
|
|
app.builder.build(['dedent'])
|
|
et = ElementTree.parse(app.outdir / 'dedent.xml')
|
|
blocks = et.findall('./section/section/literal_block')
|
|
|
|
for i in range(5): # 0-4
|
|
actual = blocks[i].text
|
|
indent = ' ' * (4 - i)
|
|
expect = '\n'.join(indent + l for l in literal_lines) + '\n'
|
|
assert (i, actual) == (i, expect)
|
|
|
|
assert blocks[5].text == '\n\n' # dedent: 1000
|
|
|
|
|
|
@with_app('xml', testroot='directive-code')
|
|
def test_literal_include_block_start_with_comment_or_brank(app, status, warning):
|
|
app.builder.build(['python'])
|
|
et = ElementTree.parse(app.outdir / 'python.xml')
|
|
secs = et.findall('./section/section')
|
|
literal_include = secs[0].findall('literal_block')
|
|
assert len(literal_include) > 0
|
|
actual = literal_include[0].text
|
|
expect = (
|
|
'def block_start_with_comment():\n'
|
|
' # Comment\n'
|
|
' return 1\n'
|
|
)
|
|
assert actual == expect
|
|
|
|
actual = literal_include[1].text
|
|
expect = (
|
|
'def block_start_with_blank():\n'
|
|
'\n'
|
|
' return 1\n'
|
|
)
|
|
assert actual == expect
|
|
|
|
|
|
@with_app('html', testroot='directive-code')
|
|
def test_literal_include_linenos(app, status, warning):
|
|
app.builder.build(['linenos'])
|
|
html = (app.outdir / 'linenos.html').text(encoding='utf-8')
|
|
linenos = (
|
|
'<td class="linenos"><div class="linenodiv"><pre>'
|
|
' 1\n'
|
|
' 2\n'
|
|
' 3\n'
|
|
' 4\n'
|
|
' 5\n'
|
|
' 6\n'
|
|
' 7\n'
|
|
' 8\n'
|
|
' 9\n'
|
|
'10\n'
|
|
'11\n'
|
|
'12\n'
|
|
'13\n'
|
|
'14</pre></div></td>')
|
|
assert linenos in html
|
|
|
|
|
|
@with_app('html', testroot='directive-code')
|
|
def test_literal_include_lineno_start(app, status, warning):
|
|
app.builder.build(['lineno_start'])
|
|
html = (app.outdir / 'lineno_start.html').text(encoding='utf-8')
|
|
linenos = (
|
|
'<td class="linenos"><div class="linenodiv"><pre>'
|
|
'200\n'
|
|
'201\n'
|
|
'202\n'
|
|
'203\n'
|
|
'204\n'
|
|
'205\n'
|
|
'206\n'
|
|
'207\n'
|
|
'208\n'
|
|
'209\n'
|
|
'210\n'
|
|
'211\n'
|
|
'212\n'
|
|
'213</pre></div></td>')
|
|
assert linenos in html
|
|
|
|
|
|
@with_app('html', testroot='directive-code')
|
|
def test_literal_include_lineno_match(app, status, warning):
|
|
app.builder.build(['lineno_match'])
|
|
html = (app.outdir / 'lineno_match.html').text(encoding='utf-8')
|
|
pyobject = (
|
|
'<td class="linenos"><div class="linenodiv"><pre>'
|
|
' 9\n'
|
|
'10\n'
|
|
'11</pre></div></td>')
|
|
|
|
assert pyobject in html
|
|
|
|
lines = (
|
|
'<td class="linenos"><div class="linenodiv"><pre>'
|
|
'5\n'
|
|
'6\n'
|
|
'7\n'
|
|
'8\n'
|
|
'9</pre></div></td>')
|
|
assert lines in html
|
|
|
|
start_after = (
|
|
'<td class="linenos"><div class="linenodiv"><pre>'
|
|
' 8\n'
|
|
' 9\n'
|
|
'10\n'
|
|
'11\n'
|
|
'12\n'
|
|
'13\n'
|
|
'14</pre></div></td>')
|
|
assert start_after in html
|
|
|
|
|
|
@with_app('latex', testroot='directive-code')
|
|
def test_literalinclude_file_whole_of_emptyline(app, status, warning):
|
|
app.builder.build_all()
|
|
latex = (app.outdir / 'Python.tex').text(encoding='utf-8').replace('\r\n', '\n')
|
|
includes = (
|
|
'\\begin{Verbatim}[commandchars=\\\\\\{\\},numbers=left,firstnumber=1,stepnumber=1]\n'
|
|
'\n'
|
|
'\n'
|
|
'\n'
|
|
'\\end{Verbatim}\n')
|
|
assert includes in latex
|
|
|
|
|
|
@with_app('html', testroot='directive-code')
|
|
def test_literalinclude_caption_html(app, status, warning):
|
|
app.builder.build('index')
|
|
html = (app.outdir / 'caption.html').text(encoding='utf-8')
|
|
caption = (u'<div class="code-block-caption">'
|
|
u'<span class="caption-text">caption <strong>test</strong> py'
|
|
u'</span><a class="headerlink" href="#caption-test-py" '
|
|
u'title="Permalink to this code">\xb6</a></div>')
|
|
assert caption in html
|
|
|
|
|
|
@with_app('latex', testroot='directive-code')
|
|
def test_literalinclude_caption_latex(app, status, warning):
|
|
app.builder.build('index')
|
|
latex = (app.outdir / 'Python.tex').text(encoding='utf-8')
|
|
caption = '\\setupcaptionforverbatim{literal-block}{caption \\textbf{test} py}'
|
|
assert caption in latex
|