All of lore.kernel.org
 help / color / mirror / Atom feed
From: Masaharu Noguchi <nogunix@gmail.com>
To: Akira Yokosawa <akiyks@gmail.com>
Cc: Chen Miao <chenmiao.ku@gmail.com>,
	 Bagas Sanjaya <bagasdotme@gmail.com>,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	 Mauro Carvalho Chehab <mchehab@kernel.org>,
	Jonathan Corbet <corbet@lwn.net>,
	 Shuah Khan <skhan@linuxfoundation.org>,
	Randy Dunlap <rdunlap@infradead.org>
Subject: Re: [PATCH v2] docs: sphinx-pre-install: warn about unsupported Docutils versions
Date: Tue, 15 Sep 2026 22:41:01 +0900	[thread overview]
Message-ID: <aqlKnXHFVqO6baEW@elitemini> (raw)
In-Reply-To: <b5df5eee-661e-4f46-9abf-1bd9cec8069d@gmail.com>

Hi Akira,

On Tue, 15 Sep 2026 16:52:03 +0900, Akira Yokosawa wrote:
> I think this can annoy people who only care HTML docs.
>
> Why not do this check after the PDF doc builds have actually failed.
>
> That is what sphinx-build-wrapper is doing with LatexFontChecker().check()
> (see line 557 of tools/docs/sphinx-build-wrapper)

You are right, and that is a better place for it.  v3 follows it: the
check moves into tools/lib/python/kdoc/docutils_version.py, shaped like
latex_fonts.py, and sphinx-build-wrapper calls it from the same two
build_failed branches, next to LatexFontChecker.  sphinx-pre-install is
left untouched.

Measured on a broken pair: htmldocs now prints nothing new and still
exits 0, and the message appears only when pdfdocs has actually failed,
just above the error.  A working pair stays quiet in both.

Thank you for pointing at Ubuntu 26.04 LTS; that turned out to be the
strongest case for having this at all, so I checked it.  It has Sphinx
8.2.3 with Docutils 0.22.4, and its python3-sphinx depends on
"python3-docutils (>= 0.20)" with no upper bound at all, where Fedora 44
arrives at the same pair by patching the "<0.22" that Sphinx declares.
Both fail the same way here:

	              core-api            admin-guide
	---------------------------------------------------------
	Ubuntu 26.04  FAILS 26x Dim       FAILS capacity, 13 p
	Fedora 44     FAILS 26x Dim       FAILS capacity, 13 p

An LTS makes this a good deal less transient than Fedora 44 alone.

v3 follows shortly.

Thanks,
Masaharu

      parent reply	other threads:[~2026-09-15 13:41 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-09-14 10:35 [PATCH v2] docs: sphinx-pre-install: warn about unsupported Docutils versions Masaharu Noguchi
2026-09-15  7:52 ` Akira Yokosawa
2026-09-15  7:58   ` Akira Yokosawa
2026-09-15  8:16   ` Mauro Carvalho Chehab
2026-09-15 13:53     ` Masaharu Noguchi
2026-09-15 14:35     ` rst2pdf (was [PATCH v2] docs: sphinx-pre-install: warn about unsupported Docutils versions) Jonathan Corbet
2026-09-15 18:20       ` Mauro Carvalho Chehab
2026-09-15 13:41   ` Masaharu Noguchi [this message]

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=aqlKnXHFVqO6baEW@elitemini \
    --to=nogunix@gmail.com \
    --cc=akiyks@gmail.com \
    --cc=bagasdotme@gmail.com \
    --cc=chenmiao.ku@gmail.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab@kernel.org \
    --cc=rdunlap@infradead.org \
    --cc=skhan@linuxfoundation.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.