github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-05-24 15:12:13 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph

docs: conf.py: use dedent and r-strings for LaTeX macros

Browse Source 
Instead of adding extra weird indentation at the tex
file, use dedent(). While here, also use r-strings, to make
easier to make its content identical to the .tex output.

While here, also merge "preamble" that was added on two
separate parts of the code (in the past, there were some
version-specific checks).

No functional changes, just cosmetic ones.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/0d245fbd872ab3ec21bd8fe78b01340ba77ce365.1755763127.git.mchehab+huawei@kernel.org
This commit is contained in:
Mauro Carvalho Chehab 2025-08-21 10:16:41 +02:00 committed by Jonathan Corbet
parent 9fd4e4ce7e
commit e7880da7ed
1 changed files with 12 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
Documentation/conf.py
View File

@ -9,6 +9,8 @@ import os
import shutil
import sys
from textwrap import dedent
import sphinx
# If extensions (or modules to document with autodoc) are in another directory,
@ -462,11 +464,11 @@ latex_elements = {
"inputenc": "",
"utf8extra": "",
# Set document margins
"sphinxsetup": """
"sphinxsetup": dedent(r"""
hmargin=0.5in, vmargin=1in,
parsedliteralwraps=true,
verbatimhintsturnover=false,
""",
"""),
#
# Some of our authors are fond of deep nesting; tell latex to
# cope.
@ -475,20 +477,16 @@ latex_elements = {
# For CJK One-half spacing, need to be in front of hyperref
"extrapackages": r"\usepackage{setspace}",
# Additional stuff for the LaTeX preamble.
"preamble": """
"preamble": dedent(r"""
% Use some font with UTF-8 support with XeLaTeX
\\usepackage{fontspec}
\\setsansfont{DejaVu Sans}
\\setromanfont{DejaVu Serif}
\\setmonofont{DejaVu Sans Mono}
""",
}
# Load kerneldoc specific LaTeX settings
latex_elements["preamble"] += """
\usepackage{fontspec}
\setsansfont{DejaVu Sans}
\setromanfont{DejaVu Serif}
\setmonofont{DejaVu Sans Mono}
% Load kerneldoc specific LaTeX settings
\\input{kerneldoc-preamble.sty}
"""
\input{kerneldoc-preamble.sty}
""")
}
# This will be filled up by config-inited event
latex_documents = []