Skip to contentSkip to conversation

doc: board: Move j721e document to doc/board/ti/ directory

PATCH Heinrich Schuchardt 2 participants 4 messages Aug 1, 2021

lore
Share & tools
lore
#0 lore raw

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).

doc/Makefile +1 -1
index 683e4b5609..050d9dd239 100644
@@ -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

#1 lore raw
Quoted 13 lines · Heinrich Schuchardt

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

Quoted 4 lines

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 ?

Signature · 1 line
Tom
#2 lore raw
Quoted 14 lines · Tom Rini
Quoted 13 lines · Heinrich Schuchardt

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

Quoted 8 lines
Quoted 4 lines

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

Quoted 1 line
#3 lore raw
Quoted 19 lines · Heinrich Schuchardt
Quoted 16 lines · Tom Rini
Quoted 15 lines · Heinrich Schuchardt

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.

Quoted 8 lines
Quoted 6 lines
Quoted 2 lines

@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.

Signature · 1 line
Tom