Add xeCJKVerbAddon to default fvset config for Chinese documents

make xeCJK not add extra spaces in fancyvrb Verbatim enviroment. Fixes: sphinx-doc#9414 Signed-off-by: Shengjing Zhu <i@zhsj.me>
zhsj · Jul 8, 2021 · baec13f · baec13f
1 parent b09acab
commit baec13f
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/doc/latex.rst b/doc/latex.rst
@@ -531,6 +531,10 @@ Keys that don't need to be overridden unless in special cases are:
       Changed default for ``'pdflatex'``. Previously it was using 
       ``'\\fvset{fontsize=\\small}'``.
 
+   .. versionchanged:: 4.1.0
+      Changed default for Chinese documents to
+      ``'\\fvset{fontsize=\\small,formatcom=\\xeCJKVerbAddon}'``
+
 Keys that are set by other options and therefore should not be overridden are:
 
 ``'docclass'``

diff --git a/sphinx/builders/latex/constants.py b/sphinx/builders/latex/constants.py
@@ -198,6 +198,9 @@
         'polyglossia':  '',
         'babel':        '\\usepackage{babel}',
         'fontenc':      '\\usepackage{xeCJK}',
+        # sed formatcom=\xeCJKVerbAddon to make xeCJK not add extra spaces in
+        # fancyvrb Verbatim enviroment.
+        'fvset':        '\\fvset{fontsize=\\small,formatcom=\\xeCJKVerbAddon}',
     },
     ('xelatex', 'el'): {
         'fontpkg':      XELATEX_GREEK_DEFAULT_FONTPKG,