Re: [PATCH RFC 0/2] docs: Deal with some Sphinx deprecation warnings

From: Jani Nikula
Date: Wed May 22 2019 - 03:36:09 EST


On Tue, 21 May 2019, Jonathan Corbet <corbet@xxxxxxx> wrote:
> The Sphinx folks are deprecating some interfaces in the upcoming 2.0
> release; one immediate result of that is a bunch of warnings that show up
> when building with 1.8. These two patches make those warnings go away,
> but at a cost:
>
> - It introduces a couple of Sphinx version checks, which are always
> ugly, but the alternative would be to stop supporting versions
> before 1.7. For now, I think we can carry that cruft.

Frankly, I'd just require Sphinx 1.7+, available even in Debian stable
through stretch-backports.

> - The second patch causes the build to fail horribly on newer
> Sphinx installations. The change to switch_source_input() seems
> to make the parser much more finicky, increasing warnings and
> eventually failing the build altogether. In particular, it will
> scream about problems in .rst files that are not included in the
> TOC tree at all. The complaints appear to be legitimate, but it's
> a bunch of stuff to clean up.

I can understand Sphinx complaining that a file is not included in a TOC
tree, but I don't understand why it goes on to parse them anyway.

BR,
Jani.


>
> I've tested these with 1.4 and 1.8, but not various versions in between.
>
> Jonathan Corbet (2):
> doc: Cope with Sphinx logging deprecations
> doc: Cope with the deprecation of AutoReporter
>
> Documentation/sphinx/kerneldoc.py | 48 ++++++++++++++++++++++++-------
> Documentation/sphinx/kernellog.py | 28 ++++++++++++++++++
> Documentation/sphinx/kfigure.py | 38 +++++++++++++-----------
> 3 files changed, 87 insertions(+), 27 deletions(-)
> create mode 100644 Documentation/sphinx/kernellog.py

--
Jani Nikula, Intel Open Source Graphics Center