Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

docs: conf.py: extra cleanups and fixes

Makes it more adehent with modern Sphinx LaTeX build setup as
defined at:

https://www.sphinx-doc.org/en/master/latex.html

There, it suggests:

1) to add: 'printindex'

“printindex” call, the last thing in the file. Override if you want to generate
the index differently, append some content after the index, or change the font.
As LaTeX uses two-column mode for the index it is often advisable to set this
key to r'\footnotesize\raggedright\printindex'.

This indeed solved a corner case on a distro where the index was not properly
generated.

2) to add at the main example:
\PassOptionsToPackage{svgnames}{xcolor}

3) I got a corner case on one of the distros was using xindy to produce
indexes. This ended causing the build logic to incorretly try to use
T1 fontenc, which is not UTF-8 compatible.

This patch adds:

\PassOptionsToPackage{xindy}{language=english,codepage=utf8,noautomatic}

to cover such case. It should be noticed that, as the config doesn't
have \usepackage{xindy}, this will be used only if latexmk ends
using xindy.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/08d16c2ad817910eb5606842f776d3f77d83282f.1755763127.git.mchehab+huawei@kernel.org

authored by

Mauro Carvalho Chehab and committed by
Jonathan Corbet
d242e256 d3265de6

+7
+7
Documentation/conf.py
··· 456 456 latex_elements = { 457 457 # The paper size ('letterpaper' or 'a4paper'). 458 458 "papersize": "a4paper", 459 + "passoptionstopackages": dedent(r""" 460 + \PassOptionsToPackage{svgnames}{xcolor} 461 + % Avoid encoding troubles when creating indexes 462 + \PassOptionsToPackage{xindy}{language=english,codepage=utf8,noautomatic} 463 + """), 459 464 # The font size ('10pt', '11pt' or '12pt'). 460 465 "pointsize": "11pt", 466 + # Needed to generate a .ind file 467 + "printindex": r"\footnotesize\raggedright\printindex", 461 468 # Latex figure (float) alignment 462 469 # 'figure_align': 'htbp', 463 470 # Don't mangle with UTF-8 chars