From fe5b8e3542ff9093611b93931fcb36a277f9c232 Mon Sep 17 00:00:00 2001 From: Behnaz Hassanshahi Date: Wed, 22 Nov 2023 08:52:02 +1000 Subject: [PATCH] feat: treat Sphinx docs warnings as errors (#648) This PR changes the Sphinx configuration to treat warnings as errors, which helps to detect documentation issues in CI tests. --- docs/Makefile | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/Makefile b/docs/Makefile index 92dd33a1..06079231 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -3,7 +3,9 @@ # You can set these variables from the command line, and also # from the environment for the first two. -SPHINXOPTS ?= + +# Treat the warnings as errors. +SPHINXOPTS ?= -W SPHINXBUILD ?= sphinx-build SOURCEDIR = source BUILDDIR = _build