Re: Linux 5.10-rc2 (docs build)

[Mauro Carvalho Chehab <mchehab@kernel.org>]

Em Mon, 2 Nov 2020 08:02:34 -0800
Randy Dunlap <rdunlap@infradead.org> escreveu:

> On 11/2/20 12:33 AM, Mauro Carvalho Chehab wrote:
> > Em Mon, 2 Nov 2020 08:58:41 +0100
> > Mauro Carvalho Chehab <mchehab@kernel.org> escreveu:
> >   
> >> Hi Randy,
> >>
> >> Em Sun, 1 Nov 2020 16:01:54 -0800
> >> Randy Dunlap <rdunlap@infradead.org> escreveu:
> >>  
> >>> Something broke the docs build (SEVERE):
> >>>
> >>>
> >>> Sphinx parallel build error:
> >>> docutils.utils.SystemMessage: /home/rdunlap/lnx/lnx-510-rc2/Documentation/ABI/testing/sysfs-bus-rapidio:2: (SEVERE/4) Title level inconsistent:
> >>>
> >>> Attributes Common for All RapidIO Devices
> >>> -----------------------------------------
> >>>
> >>>  
> >>
> >> On what tree did you notice this? Linux-next or upstream?  
> 
> See $Subject:  5.10-rc2
> 
> 
> > Also: on what Sphinx version are you getting it? I'm not
> > able to reproduce the issue here, neither with Sphinx 2.4.4
> > nor with Sphinx 3.2.1.  
> 
> That could be one source of the problem:  ;)
> 
> from my docs build:
> 
> Sphinx version: 1.7.6
> Warning: It is recommended at least Sphinx version 1.7.9.
>          If you want pdf, you need at least 2.4.4.

Could be... From 1.7.6 to 1.7.9, there were bug fixes ;-)

Also, on Sphinx, they stop maintaining old versions once newer
stable ones are launched. So, any bug on 1.7.x (up to 3.2.x) will
remain unfixed[1].

In any case, could you please check if this patch solves the
issue?

	https://lore.kernel.org/lkml/6c62ef5c01d39dee8d891f8390c816d2a889670a.1604312590.git.mchehab+huawei@kernel.org/
	

> Note: It is recommended at least Sphinx version 2.4.4 if you need PDF support.
> 
> 
> > (building against next-20201102 and against 5.10-rc2)  
> 
> 
> Someone might want to update Documentation/process/changes.rst:
> Sphinx\ [#f1]_	       1.3		sphinx-build --version
> 
> Documentation/doc-guide/sphinx.rst also says minimal version is 1.3
> but then goes on to discuss other versions. It's a bit of a mess.

I don't test versions below 2.4 for a while, but I believe that
version 1.3 is still the minimal one for the documentation to be
built (earlier versions don't support some keywords used on a few
documents - and the Sphinx extensions can also break). 

Anyway, Jon is planning to raise the minimal version on Kernel
5.11, dropping some logic inside Documentation/sphinx/*.py that
are there to preserve backward compatibility with Python2 and with
too old versions of the toolchain.

After such changes, we should update changes.rst and sphinx.rst.

-

[1] On a side note, according with:
    https://www.sphinx-doc.org/en/master/changes.html
    Sphinx v3.3.0 was released today. Didn't test building with it yet.


Thanks,
Mauro