From 46dbbea43c00bd7dde501807ac338878eb3f0b60 Mon Sep 17 00:00:00 2001
From: Steph Prince <40640337+stephprince@users.noreply.github.com>
Date: Thu, 18 Jan 2024 15:59:54 -0800
Subject: [PATCH] raise sphinx warnings as errors

---
 .github/workflows/check_external_links.yml | 2 +-
 docs/Makefile                              | 2 +-
 docs/make.bat                              | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/.github/workflows/check_external_links.yml b/.github/workflows/check_external_links.yml
index e030f37ae..312669fd9 100644
--- a/.github/workflows/check_external_links.yml
+++ b/.github/workflows/check_external_links.yml
@@ -30,4 +30,4 @@ jobs:
           python -m pip install .
 
       - name: Check Sphinx external links
-        run: sphinx-build -b linkcheck ./docs/source ./test_build
+        run: sphinx-build -W -b linkcheck ./docs/source ./test_build
diff --git a/docs/Makefile b/docs/Makefile
index 5129f2240..f01af1f8b 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -149,7 +149,7 @@ changes:
 	@echo "The overview file is in $(BUILDDIR)/changes."
 
 linkcheck:
-	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	$(SPHINXBUILD) -W -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
 	@echo
 	@echo "Link check complete; look for any errors in the above output " \
 	      "or in $(BUILDDIR)/linkcheck/output.txt."
diff --git a/docs/make.bat b/docs/make.bat
index 25d3a04d4..dc48f5b3e 100644
--- a/docs/make.bat
+++ b/docs/make.bat
@@ -183,7 +183,7 @@ if "%1" == "changes" (
 )
 
 if "%1" == "linkcheck" (
-	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
+	%SPHINXBUILD% -W -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
 	if errorlevel 1 exit /b 1
 	echo.
 	echo.Link check complete; look for any errors in the above output ^