Re: [PATCH v4 00/52] Fix html build with Sphinx 3.1 and above

[Jonathan Corbet]

On Wed, 30 Sep 2020 15:24:23 +0200
Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx> wrote:

> This series add proper support for Sphinx 3.1 and above for building the html docs.
> 
> This series comes after the one I wrote fixing the warnings. 
> 
> With this series applied on the top of next-20200922, there are just 12
> warnings:
> 	- 2 of them happens also on Sphinx 2.4.4
> 	 (both seem easy to fix: I'll send later fixes for those);
> 	- 10 happens only on Sphinx 3.2.1.
> 
> The new warnings are all due to duplicated C domain cross-reference symbols. 
> 
> Basically, the C domain on Sphinx doesn't allow to have an struct and
> a function with the same name. I opened an issue on Sphinx.:
> 
>     https://github.com/sphinx-doc/sphinx/issues/8241
> 
> Hopefully, some newer version may have it fixed.
> 
> There is still one thing that requires a fix: the automarkup.py. The
> way cross-references are stored with Sphinx 3 are different.
> I didn't try yet to address it, but I suspect that it shouldn't be
> hard to address it.

Modulo my comment on part 4, I think this is what we want.  It's kind of
unfortunate that it's all necessary, but that's the way things are these
days, I guess.

This part is a bit intimidating, though:

>  288 files changed, 1709 insertions(+), 2183 deletions(-)

Should we maybe position this as an end-of-merge-window blast, once other
stuff has hopefully mostly settled?  I can certainly warn Linus that it's
coming when I send the main docs pull.

I wonder how soon we could pull our minimum version forward to 3.1 and
drop a bunch of stuff?  I fear it may not be for a while, alas...

Thanks for doing all this work,

jon