Re: docs: sphinx: avoid using the deprecated node.set_class()

[Jonathan Corbet <corbet@lwn.net>]

Akira Yokosawa <akiyks@gmail.com> writes:

> Hi Jon,
>
> On Thu, 19 Jun 2025 15:26:56 -0600, Jonathan Corbet wrote:
>> Docutils emits a deprecation warning when the set_class() element method is
>> used; that warning disappears into the ether, but it also causes a crash
>> with docutils 0.19 when combined with certain versions of Sphinx.
>
> To be accurate, I'd rather say:
>                                                 but it also causes a crash
>   with docutils 0.19 when combined with any version of Sphinx whose
>   requirement accepts it.

...or just "with docutils 0.19" and put the period there, perhaps?

>> Avoid the deprecated function and just append directly to the "classes"
>> attribute like the documentation says instead.
>
> Nice!  This is the kind of fix I wish I could have come up with by myself.

It helps to have broken it in the first place :)

> Tested OK against debian:12's Sphinx 5.3.0, as well as Sphinx 3.4.3 of
> debian:11 and almalinux:9, Sphinx 4.2.0 of Ubuntu 22.04 and other recent
> distro Sphinx packages.
>
>> 
>> Reported-by: Akira Yokosawa <akiyks@gmail.com>
>
> Closes: https://lore.kernel.org/de7bae91-3200-481f-9db2-c0dc382c91dd@gmail.com/
>
>> Fixes: d6d1df92c25f ("docs: automarkup: Mark up undocumented entities too")
>> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
>
> Tested-by: Akira Yokosawa <akiyks@gmail.com>

Thanks,

jon