diff options
| author | Nicholas Chin <nic.c3.14@gmail.com> | 2024-10-27 14:41:07 -0600 |
|---|---|---|
| committer | Felix Singer <service+coreboot-gerrit@felixsinger.de> | 2024-10-27 23:51:11 +0000 |
| commit | 6d8bb8cf29653568f2446bbc7f2a1b37d3396276 (patch) | |
| tree | 1224c70bcbf5371f969feb684db95cbd4554131f /Documentation/Makefile | |
| parent | d95d9f8ce82988abd0dce010cbdd3c567508196f (diff) | |
Docs: Turn warnings into errors
Use the -W (--fail-on-warning) flag of sphinx-build to tell it to exit
with an error if any warnings are generated. This is intended to fail
the coreboot-docs-gerrit build to help catch issues.
To allow all warnings to be output in the same build, use the
--keep-going flag so that the author is able to see all issues and
address them after a single build. Note that this behavior is enabled by
default as of Sphinx 8.1 and this option may be removed in the future.
It is added here for compatibility with older versions of Sphinx,
including the doc.coreboot.org container which uses 7.2.6.
Change-Id: I3aa564b79d4d4125a3800023b1b805bf4a50b10a
Signed-off-by: Nicholas Chin <nic.c3.14@gmail.com>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/84886
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de>
Diffstat (limited to 'Documentation/Makefile')
| -rw-r--r-- | Documentation/Makefile | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/Makefile b/Documentation/Makefile index 6d2a64188f..af2f9bbaa2 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -5,7 +5,7 @@ # BUILDDIR ?= _build -SPHINXOPTS ?= -j auto +SPHINXOPTS ?= -j auto -W --keep-going export SPHINXOPTS |