nagai/kernel
3
0
Fork 0
forked from mirrors/linux
Code Pull requests Activity

docs: pdfdocs: Refactor config for CJK document

Browse source 
To make generated LaTeX code portable across systems with different sets
of available fonts, convert font-availability check in python code to
LaTeX code by using a conditional command provided by the "fontspec"
package.

This will help those who run Sphinx on one machine/container and run
latexmk on other machines/containers.

Remove import of check_output as it is unused any more.

Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
Link: https://lore.kernel.org/r/4baf88af-316d-8aee-240f-6ccbc20907d7@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Akira Yokosawa 2021-08-09 10:12:05 +09:00 committed by Jonathan Corbet
parent bed4ed3057
commit 659653c9e5
1 changed files with 9 additions and 13 deletions
repo.diff.show_diff_stats Download patch file Download diff file Expand all files Collapse all files

14
Documentation/conf.py
View file

@ -16,8 +16,6 @@ import sys
import os import os
import sphinx import sphinx
from subprocess import check_output
# Get Sphinx version # Get Sphinx version
major, minor, patch = sphinx.version_info[:3] major, minor, patch = sphinx.version_info[:3]
@ -355,12 +353,11 @@ latex_elements = {
''', ''',
} }
# At least one book (translations) may have Asian characters # Translations have Asian (CJK) characters which are only displayed if
# with are only displayed if xeCJK is used # xeCJK is used
cjk_cmd = check_output(['fc-list', '--format="%{family[0]}\n"']).decode('utf-8', 'ignore')
if cjk_cmd.find("Noto Sans CJK SC") >= 0:
latex_elements['preamble'] += ''' latex_elements['preamble'] += '''
\\IfFontExistsTF{Noto Sans CJK SC}{
% This is needed for translations % This is needed for translations
\\usepackage{xeCJK} \\usepackage{xeCJK}
\\setCJKmainfont{Noto Sans CJK SC} \\setCJKmainfont{Noto Sans CJK SC}
@ -371,12 +368,11 @@ if cjk_cmd.find("Noto Sans CJK SC") >= 0:
\\usepackage{etoolbox} \\usepackage{etoolbox}
% Inactivate CJK after tableofcontents % Inactivate CJK after tableofcontents
\\apptocmd{\\sphinxtableofcontents}{\\kerneldocCJKoff}{}{} \\apptocmd{\\sphinxtableofcontents}{\\kerneldocCJKoff}{}{}
''' }{ % No CJK font found
else:
latex_elements['preamble'] += '''
% Custom macros to on/off CJK (Dummy) % Custom macros to on/off CJK (Dummy)
\\newcommand{\\kerneldocCJKon}{} \\newcommand{\\kerneldocCJKon}{}
\\newcommand{\\kerneldocCJKoff}{} \\newcommand{\\kerneldocCJKoff}{}
}
''' '''
# Fix reference escape troubles with Sphinx 1.4.x # Fix reference escape troubles with Sphinx 1.4.x