CI: treat documentation warnings as errors

We do not want to merge documentation that produces Sphinx warnings.

scripts/kernel-doc uses environment variable KDOC_WERROR to determine
if warnings should be treated as errors.

Reported-by: Tom Rini <trini@konsulko.com>
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Reviewed-by: Simon Glass <sjg@chromium.org>
This commit is contained in:
Heinrich Schuchardt 2023-05-02 05:04:11 +02:00
parent 27a03f03b2
commit 8a6414d1e4
2 changed files with 2 additions and 2 deletions

View file

@ -89,7 +89,7 @@ stages:
virtualenv -p /usr/bin/python3 /tmp/venvhtml virtualenv -p /usr/bin/python3 /tmp/venvhtml
. /tmp/venvhtml/bin/activate . /tmp/venvhtml/bin/activate
pip install -r doc/sphinx/requirements.txt pip install -r doc/sphinx/requirements.txt
make htmldocs make htmldocs KDOC_WERROR=1
make infodocs make infodocs
- job: todo - job: todo

View file

@ -171,7 +171,7 @@ docs:
- virtualenv -p /usr/bin/python3 /tmp/venvhtml - virtualenv -p /usr/bin/python3 /tmp/venvhtml
- . /tmp/venvhtml/bin/activate - . /tmp/venvhtml/bin/activate
- pip install -r doc/sphinx/requirements.txt - pip install -r doc/sphinx/requirements.txt
- make htmldocs - make htmldocs KDOC_WERROR=1
- make infodocs - make infodocs
# some statistics about the code base # some statistics about the code base