summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>2025-08-21 10:16:41 +0200
committerJonathan Corbet <corbet@lwn.net>2025-08-21 14:08:53 -0600
commite7880da7ed881c160a60784b6e011ad8b16aeb33 (patch)
tree659389688a9f3c5a658f21d2b398f4957c68f5a1
parent9fd4e4ce7e937e4a750a5dc49bd285641e977c5e (diff)
docs: conf.py: use dedent and r-strings for LaTeX macros
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
-rw-r--r--Documentation/conf.py26
1 files changed, 12 insertions, 14 deletions
diff --git a/Documentation/conf.py b/Documentation/conf.py
index 4db4883901f4..e00ec8f59f25 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -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 = []