Turn warnings into errors in the Makefile. (#906)

ezio-melotti · AA-Turner · CAM-Gerlach · web-flow · commit 02f2b9845094 · 2022-07-14T00:19:20.000+02:00
* Turn warnings into errors in the Makefile.

* Restore missing label.

* Add `--keep-going`.

Co-authored-by: Adam Turner &lt;9087854+AA-Turner@users.noreply.github.com&gt;

* Add `-W --keep-going -n` to SPHINXOPTS.

* Fix a warning in conf.py.

* Update `make.bat`.

* Unquote variable in make.bat.

Co-authored-by: CAM Gerlach &lt;CAM.Gerlach@Gerlach.CAM&gt;

Co-authored-by: Adam Turner &lt;9087854+AA-Turner@users.noreply.github.com&gt;
Co-authored-by: CAM Gerlach &lt;CAM.Gerlach@Gerlach.CAM&gt;
diff --git a/Makefile b/Makefile
@@ -5,7 +5,7 @@
 PYTHON        = python3
 VENVDIR       = ./venv
 BUILDDIR      = _build
-SPHINXOPTS    =
+SPHINXOPTS    = -W --keep-going -n
 SPHINXBUILD   = $(VENVDIR)/bin/sphinx-build
 SPHINXLINT    = $(VENVDIR)/bin/sphinx-lint
 PAPER         =
diff --git a/conf.py b/conf.py
@@ -40,7 +40,7 @@
 # http://www.sphinx-doc.org/en/stable/config.html?highlight=linkcheck#confval-linkcheck_anchors_ignore
 linkcheck_anchors_ignore = [
     # match any anchor that starts with a '/' since this is an invalid HTML anchor
-    '\/.*',
+    r'\/.*',
 ]
 rediraffe_redirects = {
     "clang.rst": "advanced-tools/clang.rst",
diff --git a/make.bat b/make.bat
@@ -22,6 +22,7 @@ if not defined SPHINXLINT (
 )
 
 set BUILDDIR=_build
+set SPHINXOPTS=-W --keep-going -n
 set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
 if NOT "%PAPER%" == "" (
 	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@`
`40`	`40`	`# http://www.sphinx-doc.org/en/stable/config.html?highlight=linkcheck#confval-linkcheck_anchors_ignore`
`41`	`41`	`linkcheck_anchors_ignore = [`
`42`	`42`	`# match any anchor that starts with a '/' since this is an invalid HTML anchor`
`43`		`- '\/.*',`
	`43`	`+ r'\/.*',`
`44`	`44`	`]`
`45`	`45`	`rediraffe_redirects = {`
`46`	`46`	`"clang.rst": "advanced-tools/clang.rst",`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@ if not defined SPHINXLINT (`
`22`	`22`	`)`
`23`	`23`
`24`	`24`	`set BUILDDIR=_build`
	`25`	`+set SPHINXOPTS=-W --keep-going -n`
`25`	`26`	`set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .`
`26`	`27`	`if NOT "%PAPER%" == "" (`
`27`	`28`	`set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%`