Re: [PATCH] doc: board: Move j721e document to doc/board/ti/ directory
Dear Kishon,
your merged patch 8baeeecbe305 ("doc: board: Move j721e document to doc/board/ti/ directory") leads to 'make html' build errors:
doc/board/index.rst:6: WARNING: toctree contains reference to nonexisting document 'board/ti/index'
looking for now-outdated files... none found pickling environment... done checking consistency... /doc/board/ti/j721e_evm.rst: WARNING: document isn't included in any toctree
Please, provide a patch with the missing file doc/board/ti/index.rst.
@Tom: Shouldn't these errors result in an error on the CI platform? Please, enable option -W (Turn warnings into errors).
diff --git a/doc/Makefile b/doc/Makefile index 683e4b5609..050d9dd239 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -7,4 +7,4 @@ subdir-y := # You can set these variables from the command line. SPHINXBUILD = sphinx-build -SPHINXOPTS = +SPHINXOPTS = -W SPHINXDIRS = .
Best regards
Heinrich
On Sun, Aug 01, 2021 at 10:03:59PM +0200, Heinrich Schuchardt wrote:
Dear Kishon,
your merged patch 8baeeecbe305 ("doc: board: Move j721e document to doc/board/ti/ directory") leads to 'make html' build errors:
doc/board/index.rst:6: WARNING: toctree contains reference to nonexisting document 'board/ti/index'
looking for now-outdated files... none found pickling environment... done checking consistency... /doc/board/ti/j721e_evm.rst: WARNING: document isn't included in any toctree
Please, provide a patch with the missing file doc/board/ti/index.rst.
@Tom: Shouldn't these errors result in an error on the CI platform?
Apparently they don't, no. Please update whatever needs updating to the Azure/GitLab jobs so that htmldoc problems are errors. I think we're also overdue now to force a newer minimum version of sphinx ?
On 8/1/21 10:37 PM, Tom Rini wrote:
On Sun, Aug 01, 2021 at 10:03:59PM +0200, Heinrich Schuchardt wrote:
Dear Kishon,
your merged patch 8baeeecbe305 ("doc: board: Move j721e document to doc/board/ti/ directory") leads to 'make html' build errors:
doc/board/index.rst:6: WARNING: toctree contains reference to nonexisting document 'board/ti/index'
looking for now-outdated files... none found pickling environment... done checking consistency... /doc/board/ti/j721e_evm.rst: WARNING: document isn't included in any toctree
Please, provide a patch with the missing file doc/board/ti/index.rst.
@Tom: Shouldn't these errors result in an error on the CI platform?
Apparently they don't, no. Please update whatever needs updating to the Azure/GitLab jobs so that htmldoc problems are errors. I think we're also overdue now to force a newer minimum version of sphinx ?
I guess you relate to doc/sphinx/requirements.txt:2
This is what we currently require: Release 2.4.4 (released Mar 05, 2020) This is the last 2. series release.
Ubuntu 20.04 LTS has Release 1.8.5 (released Mar 10, 2019) This is the latest 1. series release.
Debian Bullseyes has Release 3.4.3 (released Jan 08, 2021)
Ubuntu 21.04 and 21.10 have Release 3.5.4 (released Apr 11, 2021) This is the newest 3. series release.
Current release is Release 4.1.2 (released Jul 27, 2021)
I see no imminent need to raise the Sphinx version. If you want to, 3.5.4 is what people could get via their distro.
Best regards
Heinrich
On Sun, Aug 01, 2021 at 11:10:43PM +0200, Heinrich Schuchardt wrote:
On 8/1/21 10:37 PM, Tom Rini wrote:
On Sun, Aug 01, 2021 at 10:03:59PM +0200, Heinrich Schuchardt wrote:
Dear Kishon,
your merged patch 8baeeecbe305 ("doc: board: Move j721e document to doc/board/ti/ directory") leads to 'make html' build errors:
doc/board/index.rst:6: WARNING: toctree contains reference to nonexisting document 'board/ti/index'
looking for now-outdated files... none found pickling environment... done checking consistency... /doc/board/ti/j721e_evm.rst: WARNING: document isn't included in any toctree
Please, provide a patch with the missing file doc/board/ti/index.rst.
@Tom: Shouldn't these errors result in an error on the CI platform?
Apparently they don't, no. Please update whatever needs updating to the Azure/GitLab jobs so that htmldoc problems are errors. I think we're also overdue now to force a newer minimum version of sphinx ?
I guess you relate to doc/sphinx/requirements.txt:2
Sorry, I meant: Running Sphinx v1.6.7 WARNING: Sphinx 1.7 or greater will be required as of the v2021.04 release ... 'make htmldocs' continues.
participants (2)
-
Heinrich Schuchardt -
Tom Rini