Building htmldocs

Tom Rini trini at konsulko.com
Thu Aug 5 18:26:37 CEST 2021


On Thu, Aug 05, 2021 at 10:17:19AM -0600, Simon Glass wrote:
> Hi,
> 
> On Thu, 5 Aug 2021 at 10:04, Tom Rini <trini at konsulko.com> wrote:
> >
> > On Thu, Aug 05, 2021 at 10:02:31AM -0600, Simon Glass wrote:
> > > Hi,
> > >
> > > On Thu, 5 Aug 2021 at 09:59, Tom Rini <trini at konsulko.com> wrote:
> > > >
> > > > On Thu, Aug 05, 2021 at 05:54:52PM +0200, Heinrich Schuchardt wrote:
> > > > >
> > > > >
> > > > > On 05.08.21 17:41, Simon Glass wrote:
> > > > > > Hi,
> > > > > >
> > > > > > I cannot do this at present:
> > > > > >
> > > > > > $ make htmldocs
> > > > > > doc/board/freescale/b4860qds.rst:170:duplicate label
> > > > > > board/freescale/b4860qds:switch settings, other instance in
> > > > > > doc/board/freescale/b4860qds.rst
> > > > >
> > > > > Hello Simon,
> > > > >
> > > > > that is for origin/master? I am not able to reproduce it there.
> > >
> > > Yes.
> > >
> > > > >
> > > > > Which version of python3-sphinx are you using? We require at least:
> > > > > doc/sphinx/requirements.txt:2:Sphinx==2.4.4
> > >
> > > OK I see. I uninstalled the Ubuntu one and installed this and it works
> > > now, thanks!
> > >
> > > What feature do we need from the newer version? I was using 1.8.5
> > >
> > > >
> > > > The check for too old a Sphinx needs to be fatal and not a WARNING I
> > > > believe.
> > >
> > > Actually I didn't even see a warning.
> >
> > The warning says that you need at least 1.7 or greater.  I still have
> > 1.6.7 from the distribution.
> 
> This is what I saw (i.e. I cannot see the warning):
> 
> make htmldocs
>   SPHINX  htmldocs -->
> file:///scratch/sglass/cosarm/src/third_party/u-boot/files/doc/output
>   PARSE   include/linker_lists.h
> Running Sphinx v1.8.5
> enabling CJK for LaTeX builder
> building [mo]: targets for 0 po files that are out of date
> building [html]: targets for 230 source files that are out of date
> updating environment: 230 added, 0 changed, 0 removed
> reading sources... [100%] usage/x86/cbsysinfo
> 
> Warning, treated as error:
> /scratch/sglass/cosarm/src/third_party/u-boot/files/doc/board/freescale/b4860qds.rst:170:duplicate
> label board/freescale/b4860qds:switch settings, other instance in
> /scratch/sglass/cosarm/src/third_party/u-boot/files/doc/board/freescale/b4860qds.rst
> make[1]: *** [doc/Makefile:68: htmldocs] Error 2
> make: *** [Makefile:2237: htmldocs] Error 2

In a real quick test, if we do:
diff --git a/doc/conf.py b/doc/conf.py
index eb74b86aefba..1485bfb7329e 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -31,7 +31,7 @@ from load_config import loadConfig
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-needs_sphinx = '1.3'
+needs_sphinx = '2.4'
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom

It's now a fatal error.  Heinrich, can you please post a patch to update
this to the real minimum required version and drop the bit about 1.7 or
later with v2021.04?  Thanks!

-- 
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 659 bytes
Desc: not available
URL: <https://lists.denx.de/pipermail/u-boot/attachments/20210805/3294b919/attachment.sig>


More information about the U-Boot mailing list