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

resolve issue #2147

Browse Source 
Replace legacy float by newfloat package to allow page-break
within literal-block environment. capt-of and needspace packages are
additionally required.

reference:
http://tex.stackexchange.com/questions/175650/how-to-allow-page-break-inside-a-float-environment
This commit is contained in:
Takaaki AOKI
2015-12-04 13:23:27 +09:00
committed by Takeshi KOMIYA
parent 024a3f701e
commit a1240d2cab
2 changed files with 23 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
sphinx/texinputs/sphinx.sty
View File

@@ -524,11 +524,18 @@
\fi \fi
% Define literal-block environment % Define literal-block environment
\RequirePackage{float} \RequirePackage{newfloat}
\floatstyle{plaintop} \DeclareFloatingEnvironment{literal-block}
\ifx\thechapter\undefined \ifx\thechapter\undefined
\newfloat{literal-block}{htbp}{loc}[section] \SetupFloatingEnvironment{literal-block}{within=section,placement=h}
\else \else
\newfloat{literal-block}{htbp}{loc}[chapter] \SetupFloatingEnvironment{literal-block}{within=chapter,placement=h}
\fi \fi
\floatname{literal-block}{List} \SetupFloatingEnvironment{literal-block}{name=List}
% control caption around literal-block
\RequirePackage{capt-of}
\RequirePackage{needspace}
% if the left page space is less than \literalblockneedsapce, insert page-break
\newcommand{\literalblockneedspace}{5\baselineskip}
% margin before the caption of literal-block
\newcommand{\literalblockcaptiontopvspace}{0.5\baselineskip}

14
sphinx/writers/latex.py
View File

@@ -296,6 +296,7 @@ class LaTeXTranslator(nodes.NodeVisitor):
self.in_production_list = 0 self.in_production_list = 0
self.in_footnote = 0 self.in_footnote = 0
self.in_caption = 0 self.in_caption = 0
self.in_container_literal_block = 0
self.first_document = 1 self.first_document = 1
self.this_is_the_title = 1 self.this_is_the_title = 1
self.literal_whitespace = 0 self.literal_whitespace = 0
@@ -400,7 +401,7 @@ class LaTeXTranslator(nodes.NodeVisitor):
if len(codeblock) == 1: if len(codeblock) == 1:
pass # FIXME pass # FIXME
else: else:
ret.append('\\floatname{literal-block}{%s}\n' % ret.append('\\SetupFloatingEnvironment{literal-block}{name=%s}\n' %
text_type(codeblock[0]).translate(tex_escape_map)) text_type(codeblock[0]).translate(tex_escape_map))
if table[1]: if table[1]:
pass # FIXME pass # FIXME
@@ -1222,6 +1223,11 @@ class LaTeXTranslator(nodes.NodeVisitor):
def visit_caption(self, node): def visit_caption(self, node):
self.in_caption += 1 self.in_caption += 1
if self.in_container_literal_block:
self.body.append('\\needspace{\\literalblockneedspace}')
self.body.append('\\vspace{\\literalblockcaptiontopvspace}')
self.body.append('\\captionof{literal-block}{')
return
self.body.append('\\caption{') self.body.append('\\caption{')
def depart_caption(self, node): def depart_caption(self, node):
@@ -1774,17 +1780,19 @@ class LaTeXTranslator(nodes.NodeVisitor):
def visit_container(self, node): def visit_container(self, node):
if node.get('literal_block'): if node.get('literal_block'):
self.in_container_literal_block += 1
ids = '' ids = ''
for id in self.next_literal_ids: for id in self.next_literal_ids:
ids += self.hypertarget(id, anchor=False) ids += self.hypertarget(id, anchor=False)
if node['ids']: if node['ids']:
ids += self.hypertarget(node['ids'][0]) ids += self.hypertarget(node['ids'][0])
self.next_literal_ids.clear() self.next_literal_ids.clear()
self.body.append('\n\\begin{literal-block}\n') self.body.append('\n')
self.context.append(ids + '\n\\end{literal-block}\n') self.context.append(ids + '\n')
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.body.append(self.context.pop()) self.body.append(self.context.pop())
def visit_decoration(self, node): def visit_decoration(self, node):