Merge pull request #13657 from tacaswell/doc_finish_then_fail

jklymak · web-flow · commit 3c860545df19 · 2019-03-13T19:10:56.000-07:00
DOC: fail the doc build on errors, but keep going to end
diff --git a/doc/Makefile b/doc/Makefile
@@ -2,7 +2,7 @@
 #
 
 # You can set these variables from the command line.
-SPHINXOPTS    = -W
+SPHINXOPTS    = -W --keep-going
 SPHINXBUILD   = python -msphinx
 SPHINXPROJ    = matplotlib
 SOURCEDIR     = .
diff --git a/doc/devel/documenting_mpl.rst b/doc/devel/documenting_mpl.rst
@@ -81,8 +81,9 @@ Other useful invocations include
    # Build pdf docs.
    make latexpdf
 
-The ``SPHINXOPTS`` variable is set to ``-W`` by default to turn warnings into
-errors.  To unset it, use
+The ``SPHINXOPTS`` variable is set to ``-W --keep-going`` by default to build
+the complete docs but exit with exit status 1 if there are warnings.  To unset
+it, use
 
 .. code-block:: sh
 
@@ -98,7 +99,7 @@ Multiple options can be combined using e.g. ``make O='-j4 -Dplot_gallery=0'
 html``.
 
 On Windows, options needs to be set as environment variables, e.g. ``set O=-W
--j4 & make html``.
+--keep-going -j4 & make html``.
 
 .. _writing-rest-pages:
 
diff --git a/requirements/doc/doc-requirements.txt b/requirements/doc/doc-requirements.txt
@@ -7,7 +7,7 @@
 # Install the documentation requirements with:
 #     pip install -r requirements/doc/doc-requirements.txt
 #
-sphinx>=1.3,!=1.5.0,!=1.6.4,!=1.7.3,!=1.8.0
+sphinx>=1.8.1
 colorspacious
 ipython
 ipywidgets

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`#`
`3`	`3`
`4`	`4`	`# You can set these variables from the command line.`
`5`		`-SPHINXOPTS = -W`
	`5`	`+SPHINXOPTS = -W --keep-going`
`6`	`6`	`SPHINXBUILD = python -msphinx`
`7`	`7`	`SPHINXPROJ = matplotlib`
`8`	`8`	`SOURCEDIR = .`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`# Install the documentation requirements with:`
`8`	`8`	`# pip install -r requirements/doc/doc-requirements.txt`
`9`	`9`	`#`
`10`		`-sphinx>=1.3,!=1.5.0,!=1.6.4,!=1.7.3,!=1.8.0`
	`10`	`+sphinx>=1.8.1`
`11`	`11`	`colorspacious`
`12`	`12`	`ipython`
`13`	`13`	`ipywidgets`