From 2f99b85e22b918b9659d072d6cc8baf51b4922f3 Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Thu, 18 Sep 2025 13:54:49 +0200 Subject: tools/docs: sphinx-build-wrapper: add an argument for LaTeX interactive mode By default, we use LaTeX batch mode to build docs. This way, when an error happens, the build fails. This is good for normal builds, but when debugging problems with pdf generation, the best is to use interactive mode. We already support it via LATEXOPTS, but having a command line argument makes it easier: Interactive mode: ./scripts/sphinx-build-wrapper pdfdocs --sphinxdirs peci -v -i ... Running 'xelatex --no-pdf -no-pdf -recorder ".../Documentation/output/peci/latex/peci.tex"' ... Default batch mode: ./scripts/sphinx-build-wrapper pdfdocs --sphinxdirs peci -v ... Running 'xelatex --no-pdf -no-pdf -interaction=batchmode -no-shell-escape -recorder ".../Documentation/output/peci/latex/peci.tex"' ... Signed-off-by: Mauro Carvalho Chehab Message-ID: <9e5b9a8becc981b47ca3bf3ddce034f273400738.1758196090.git.mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet --- tools/docs/sphinx-build-wrapper | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) (limited to 'tools/docs/sphinx-build-wrapper') diff --git a/tools/docs/sphinx-build-wrapper b/tools/docs/sphinx-build-wrapper index c57c732b879c..50761f125bc9 100755 --- a/tools/docs/sphinx-build-wrapper +++ b/tools/docs/sphinx-build-wrapper @@ -173,7 +173,7 @@ class SphinxBuilder: if not verbose: self.sphinxopts += ["-q"] - def __init__(self, builddir, verbose=False, n_jobs=None): + def __init__(self, builddir, verbose=False, n_jobs=None, interactive=None): """Initialize internal variables""" self.verbose = None @@ -183,7 +183,11 @@ class SphinxBuilder: self.kernelversion = os.environ.get("KERNELVERSION", "unknown") self.kernelrelease = os.environ.get("KERNELRELEASE", "unknown") self.pdflatex = os.environ.get("PDFLATEX", "xelatex") - self.latexopts = os.environ.get("LATEXOPTS", "-interaction=batchmode -no-shell-escape") + + if not interactive: + self.latexopts = os.environ.get("LATEXOPTS", "-interaction=batchmode -no-shell-escape") + else: + self.latexopts = os.environ.get("LATEXOPTS", "") if not verbose: verbose = bool(os.environ.get("KBUILD_VERBOSE", "") != "") @@ -584,12 +588,16 @@ def main(): parser.add_argument('-j', '--jobs', type=jobs_type, help="Sets number of jobs to use with sphinx-build") + parser.add_argument('-i', '--interactive', action='store_true', + help="Change latex default to run in interactive mode") + args = parser.parse_args() PythonVersion.check_python(MIN_PYTHON_VERSION) builder = SphinxBuilder(builddir=args.builddir, - verbose=args.verbose, n_jobs=args.jobs) + verbose=args.verbose, n_jobs=args.jobs, + interactive=args.interactive) builder.build(args.target, sphinxdirs=args.sphinxdirs, conf=args.conf, theme=args.theme, css=args.css, paper=args.paper, -- cgit v1.2.3