From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>
Subject: [PATCH 0/2] A couple patches for sphinx-build-wrapper
Date: Fri, 19 Sep 2025 17:09:58 +0200 [thread overview]
Message-ID: <cover.1758294450.git.mchehab+huawei@kernel.org> (raw)
Hi Jon,
This small series is against docs/build-script branch.
The first patch addresses the lack of a check after running
sphinx-build to see if it returned some error code.
The second patch is a bonus cleanup: it get rids with
load_config.py, replacing it by a single line at conf.py,
simplifying even further docs Makefile. Thanks for
reminding me about that legacy code that we can drop!
-
I didn't implement yet Akira's suggestion of having a way
to use make -i to ignore errors from latexdocs while
doing pdf builds. I have a couple of ideas on my head.
I'm tempting to implement a:
--no-sphinx
command line argument at sphinx-build-wrapper, which would
make it ignore the sphinx-build step. this way a makefile
rule like:
pdf-after-latex: latexdocs
+$(Q)$(PYTHON3) $(BUILD_WRAPPER) $@ $(RUSTDOC) \
--sphinxdirs="$(SPHINXDIRS)" \
--builddir="$(BUILDDIR)" --deny-vf=$(FONTS_CONF_DENY_VF) \
--css=$(DOCS_CSS) --paper=$(PAPER) --no-sphinx
would allow people to play with "-i", "-k", "--output-sync" and
other make arguments.
However, Friday's happy hour is quickly approaching here... Not the
best time to implement new ideas :-D
I'll try to materialize it next week.
Have a nice weekend!
Mauro
Mauro Carvalho Chehab (2):
tools/docs: sphinx-build-wrapper: handle sphinx-build errors
docs: conf.py: get rid of load_config.py
Documentation/Makefile | 4 --
Documentation/conf.py | 15 +++-----
Documentation/sphinx/load_config.py | 60 -----------------------------
tools/docs/sphinx-build-wrapper | 9 ++++-
4 files changed, 12 insertions(+), 76 deletions(-)
delete mode 100644 Documentation/sphinx/load_config.py
--
2.51.0
next reply other threads:[~2025-09-19 15:10 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-09-19 15:09 Mauro Carvalho Chehab [this message]
2025-09-19 15:09 ` [PATCH 1/2] tools/docs: sphinx-build-wrapper: handle sphinx-build errors Mauro Carvalho Chehab
2025-09-19 15:10 ` [PATCH 2/2] docs: conf.py: get rid of load_config.py Mauro Carvalho Chehab
2025-09-19 21:38 ` Jonathan Corbet
2025-09-20 9:36 ` 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.1758294450.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.