Skip to content

Commit 9741d13

Browse files
committed
LaTeX comments
1 parent 099d408 commit 9741d13

File tree

2 files changed

+9
-6
lines changed

2 files changed

+9
-6
lines changed

sphinx/texinputs/sphinx.sty

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,14 @@
3434
%% OPTION HANDLING
3535
%
3636

37-
% We first handle options then load packages, but we need \definecolor from
38-
% xcolor/color.
39-
40-
% FIXME: we should \RequirePackage{xcolor} always now
41-
% The xcolor package draws better fcolorboxes around verbatim code
37+
% We generally first handle options then load packages, but we need
38+
% \definecolor from xcolor/color to handle the options.
39+
40+
% MEMO: xcolor \fcolorbox coloured boxes render better in some PDF viewers
41+
% than with color package \fcolorbox. Since 1.6.3, Sphinx uses only its own
42+
% custom variant of \fcolorbox when handling verbatim code. Currently (last
43+
% checked at 5.0.0) \fcolorbox is used for admonitions (sphinxheavybox)
44+
% and appears also in Pygmentize output mark-up.
4245
\IfFileExists{xcolor.sty}{
4346
\RequirePackage{xcolor}
4447
}{

sphinx/texinputs/sphinxlatexliterals.sty

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@
105105
\long\def\spx@fcolorbox #1#2#3#4#5{%
106106
\hskip\@totalleftmargin
107107
\hskip-\fboxsep\hskip-\fboxrule
108-
% use of \color@b@x here is compatible with both xcolor.sty and color.sty
108+
% MEMO: \color@b@x from xcolor.sty is identical with the one from color.sty
109109
\color@b@x {\color{#1}\spx@CustomFBox{#3}{#4}}{\color{#2}}{#5}%
110110
\hskip-\fboxsep\hskip-\fboxrule
111111
\hskip-\linewidth \hskip-\@totalleftmargin \hskip\columnwidth

0 commit comments

Comments
 (0)