Merge pull request #8879 from jfbu/latex_better_fix_pygments

LaTeX: better workaround for a Pygments LaTeXFormatter issue (with Pygments up to 2.7.4)

CHANGES

@@ -95,6 +95,8 @@ Bugs fixed
   change) with late TeXLive 2019
 * #8253: LaTeX: Figures with no size defined get overscaled (compared to images
   with size explicitly set in pixels) (fixed for ``'pdflatex'/'lualatex'`` only)
+* #8874: LaTeX: the fix to two minor Pygments LaTeXFormatter output issues ignore
+  Pygments style
 * #8925: LaTeX: 3.5.0 ``verbatimmaxunderfull`` setting does not work as
   expected
 * #8911: C++: remove the longest matching prefix in

sphinx/builders/latex/__init__.py

@@ -256,7 +256,8 @@ class LaTeXBuilder(Builder):
         with open(stylesheet, 'w') as f:
             f.write('\\NeedsTeXFormat{LaTeX2e}[1995/12/01]\n')
             f.write('\\ProvidesPackage{sphinxhighlight}'
-                    '[2016/05/29 stylesheet for highlighting with pygments]\n\n')
+                    '[2016/05/29 stylesheet for highlighting with pygments]\n')
+            f.write('% Its contents depend on pygments_style configuration variable.\n\n')
             f.write(highlighter.get_stylesheet())
 
     def write(self, *ignored: Any) -> None:

sphinx/highlighting.py

@@ -8,10 +8,12 @@
     :license: BSD, see LICENSE for details.
 """
 
+from distutils.version import LooseVersion
 from functools import partial
 from importlib import import_module
 from typing import Any, Dict
 
+from pygments import __version__ as pygmentsversion
 from pygments import highlight
 from pygments.filters import ErrorToken
 from pygments.formatter import Formatter
@@ -50,6 +52,20 @@ escape_hl_chars = {ord('\\'): '\\PYGZbs{}',
 _LATEX_ADD_STYLES = r'''
 \renewcommand\PYGZsq{\textquotesingle}
 '''
+# fix extra space between lines when Pygments highlighting uses \fcolorbox
+# add a {..} to limit \fboxsep scope, and force \fcolorbox use correct value
+# cf pygments #1708 which makes this unneeded for Pygments > 2.7.4
+_LATEX_ADD_STYLES_FIXPYG = r'''
+\makeatletter
+% fix for Pygments <= 2.7.4
+\let\spx@original@fcolorbox\fcolorbox
+\def\spx@fixpyg@fcolorbox{\fboxsep-\fboxrule\spx@original@fcolorbox}
+\def\PYG#1#2{\PYG@reset\PYG@toks#1+\relax+%
+             {\let\fcolorbox\spx@fixpyg@fcolorbox\PYG@do{#2}}}
+\makeatother
+'''
+if tuple(LooseVersion(pygmentsversion).version) <= (2, 7, 4):
+    _LATEX_ADD_STYLES += _LATEX_ADD_STYLES_FIXPYG
 
 
 class PygmentsBridge:

sphinx/texinputs/sphinx.sty

@@ -271,17 +271,6 @@
 %% PYGMENTS
 % stylesheet for highlighting with pygments
 \RequirePackage{sphinxhighlight}
-% fix baseline increase from Pygments latex formatter in case of error tokens
-% and keep \fboxsep's scope local via added braces
-\def\PYG@tok@err{%
-    \def\PYG@bc##1{{\setlength{\fboxsep}{-\fboxrule}%
-                    \fcolorbox[rgb]{1.00,0.00,0.00}{1,1,1}{\strut ##1}}}%
-}
-\def\PYG@tok@cs{%
-    \def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}%
-    \def\PYG@bc##1{{\setlength{\fboxsep}{0pt}%
-                    \colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}%
-}%
 
 
 %% TABLES