summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorjfbu <jfbu@free.fr>2017-05-23 13:00:42 +0200
committerjfbu <jfbu@free.fr>2017-05-23 13:00:42 +0200
commit2d1503262d3ba5cbdaee97c45606c38cb262404a (patch)
tree7fc3bfa0dc1fd63f449eb34cffa79e2c618631a8
parent2387d513fae7335d3fe22040b0c33f52e089e387 (diff)
downloadsphinx-git-2d1503262d3ba5cbdaee97c45606c38cb262404a.tar.gz
Add explanatory comment in LaTeX style file for ``\spx@VerbatimFBox``
-rw-r--r--sphinx/texinputs/sphinx.sty5
1 files changed, 5 insertions, 0 deletions
diff --git a/sphinx/texinputs/sphinx.sty b/sphinx/texinputs/sphinx.sty
index 2c73a9e10..05683a914 100644
--- a/sphinx/texinputs/sphinx.sty
+++ b/sphinx/texinputs/sphinx.sty
@@ -722,6 +722,11 @@
% Inspired and adapted from framed.sty's \CustomFBox with extra handling
% of a non separable by pagebreak caption.
+% The sole purpose of this macro is to add the framing and the title. The #1
+% already has the typeset contents with background color, and took into
+% account the \sphinxverbatimsep. The \fboxsep parameter is here zero
+% (see \spx@fcolorbox definition) in order for the frame borders to exactly
+% fit the colored contents.
\long\def\spx@VerbatimFBox#1{%
\leavevmode
\begingroup