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

Fix broken numeric reference in PDF hyperlinks to "Listing " code-blocks

Browse Source 
The `\label` is now inserted into the caption on top of the Verbatim,
and `\ref` will work as expected. No need for `\phantomsection`.

	modified:   sphinx/writers/latex.py
	modified:   tests/test_directive_code.py
This commit is contained in:
jfbu 2016-04-03 16:21:28 +02:00
parent 6123ea49e5
commit a1647b6bb9
2 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
sphinx/writers/latex.py
View File

@ -1445,8 +1445,8 @@ class LaTeXTranslator(nodes.NodeVisitor):
if self.in_container_literal_block: if self.in_container_literal_block:
self.body.append('\\needspace{\\literalblockneedspace}') self.body.append('\\needspace{\\literalblockneedspace}')
self.body.append('\\vspace{\\literalblockcaptiontopvspace}\n') self.body.append('\\vspace{\\literalblockcaptiontopvspace}\n')
self.body.append(self.context.pop()) self.body.append('\\SphinxSetupCaptionForVerbatim{literal-block}{'
self.body.append('\\SphinxSetupCaptionForVerbatim{literal-block}{') + self.context.pop())
elif self.in_minipage and isinstance(node.parent, nodes.figure): elif self.in_minipage and isinstance(node.parent, nodes.figure):
self.body.append('\\captionof{figure}{') self.body.append('\\captionof{figure}{')
else: else:
@ -1992,14 +1992,15 @@ class LaTeXTranslator(nodes.NodeVisitor):
for id in self.pop_hyperlink_ids('code-block'): for id in self.pop_hyperlink_ids('code-block'):
ids += self.hypertarget(id, anchor=False) ids += self.hypertarget(id, anchor=False)
if node['ids']: if node['ids']:
ids += self.hypertarget(node['ids'][0]) # suppress with anchor=False \phantomsection generation
ids += self.hypertarget(node['ids'][0], anchor=False)
self.body.append('\n') self.body.append('\n')
self.context.append(ids + '\n') if ids:
self.context.append(ids) # will be used in visit_caption
def depart_container(self, node): def depart_container(self, node):
if node.get('literal_block'): if node.get('literal_block'):
self.in_container_literal_block -= 1 self.in_container_literal_block -= 1
# self.body.append(self.context.pop()) moved to visit_caption
def visit_decoration(self, node): def visit_decoration(self, node):
pass pass

4
tests/test_directive_code.py
View File

@ -64,7 +64,7 @@ def test_code_block_caption_html(app, status, warning):
def test_code_block_caption_latex(app, status, warning): def test_code_block_caption_latex(app, status, warning):
app.builder.build_all() app.builder.build_all()
latex = (app.outdir / 'Python.tex').text(encoding='utf-8') latex = (app.outdir / 'Python.tex').text(encoding='utf-8')
caption = '\\SphinxSetupCaptionForVerbatim{literal-block}{caption \\emph{test} rb}' caption = '\\SphinxSetupCaptionForVerbatim{literal-block}{\label{caption:caption-test-rb}caption \\emph{test} rb}'
assert caption in latex assert caption in latex
@ -229,7 +229,7 @@ def test_literalinclude_caption_html(app, status, warning):
def test_literalinclude_caption_latex(app, status, warning): def test_literalinclude_caption_latex(app, status, warning):
app.builder.build('index') app.builder.build('index')
latex = (app.outdir / 'Python.tex').text(encoding='utf-8') latex = (app.outdir / 'Python.tex').text(encoding='utf-8')
caption = '\\SphinxSetupCaptionForVerbatim{literal-block}{caption \\textbf{test} py}' caption = '\\SphinxSetupCaptionForVerbatim{literal-block}{\label{caption:caption-test-py}caption \\textbf{test} py}'
assert caption in latex assert caption in latex