linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 0/1] sphinx-build-wrapper: add support for skipping sphinx-build
@ 2025-09-21  9:13 Mauro Carvalho Chehab
  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
  0 siblings, 2 replies; 6+ messages in thread
From: Mauro Carvalho Chehab @ 2025-09-21  9:13 UTC (permalink / raw)
  To: Linux Doc Mailing List, Jonathan Corbet
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
	Akira Yokosawa

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



^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2025-09-24  9:55 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-09-21  9:13 [PATCH 0/1] sphinx-build-wrapper: add support for skipping sphinx-build Mauro Carvalho Chehab
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

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).