linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	Jonathan Corbet <corbet@lwn.net>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	linux-kernel@vger.kernel.org, Akira Yokosawa <akiyks@gmail.com>
Subject: [PATCH 0/1] sphinx-build-wrapper: add support for skipping sphinx-build
Date: Sun, 21 Sep 2025 11:13:24 +0200	[thread overview]
Message-ID: <cover.1758444913.git.mchehab+huawei@kernel.org> (raw)

Hi Jon,

This patch adds support for not running sphinx-build at the wrapper
tool. It was requested by Akira, who wanted to be able to ignore
Sphinx errors during latex build and still try to build PDF.

This patch is against docs/build-script and applies after the 3 patch
series I sent yesterday:

    https://lore.kernel.org/linux-doc/cover.1758361087.git.mchehab+huawei@kernel.org/


While Akira's original intention is to have pdfdocs target depend on
latexdocs, IMO, this is overkill, as probably only Akira and a couple
of other developers might want to have such behavior.

See, after all changes, the makefile rule for *all* doc build targets
is simple:

        $(Q)@$(srctree)/tools/docs/sphinx-pre-install --version-check
        +$(Q)$(PYTHON3) $(BUILD_WRAPPER) $@ \
                --sphinxdirs="$(SPHINXDIRS)" $(RUSTDOC) \
                --builddir="$(BUILDDIR)" --deny-vf=$(FONTS_CONF_DENY_VF) \
                --theme=$(DOCS_THEME) --css=$(DOCS_CSS) --paper=$(PAPER)

After applying patch 1 from this series, it is really easy to replicate 
"make -i" by writing a small script that does:

	tools/docs/sphinx-pre-install --version-check	
	tools/docs/sphinx-build-wrapper latexdocs || echo "LaTeX build failed, but we'll try build PDF anyway"
	tools/docs/sphinx-build-wrapper -s pdfdocs

So, I'm not proposing doing any changes to Makefile, as IMHO, for
most people, the intermediate steps don't matter.

Mauro Carvalho Chehab (1):
  tools/docs/sphinx-build-wrapper: allow skipping sphinx-build step

 tools/docs/sphinx-build-wrapper | 18 ++++++++++++------
 1 file changed, 12 insertions(+), 6 deletions(-)

-- 
2.51.0



             reply	other threads:[~2025-09-21  9:13 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-09-21  9:13 Mauro Carvalho Chehab [this message]
2025-09-21  9:13 ` [PATCH 1/1] tools/docs/sphinx-build-wrapper: allow skipping sphinx-build step Mauro Carvalho Chehab
2025-09-22 11:30 ` [PATCH 0/1] sphinx-build-wrapper: add support for skipping sphinx-build Akira Yokosawa
2025-09-22 12:23   ` Mauro Carvalho Chehab
2025-09-24  7:03     ` Akira Yokosawa
2025-09-24  9:55       ` Mauro Carvalho Chehab

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=cover.1758444913.git.mchehab+huawei@kernel.org \
    --to=mchehab+huawei@kernel.org \
    --cc=akiyks@gmail.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).