Default to -W.

anntzer · anntzer · commit b4b1f64275f2 · 2017-12-02T15:20:28.000-08:00
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -68,7 +68,7 @@ mpl-run: &mpl-install
 
 doc-run: &doc-build
   name: Build documentation
-  command: make O=-W html
+  command: make html
   working_directory: doc
 
 doc-bundle-run: &doc-bundle
diff --git a/doc/Makefile b/doc/Makefile
@@ -2,7 +2,7 @@
 #
 
 # You can set these variables from the command line.
-SPHINXOPTS    =
+SPHINXOPTS    = -W
 SPHINXBUILD   = python -msphinx
 SPHINXPROJ    = matplotlib
 SOURCEDIR     = .
diff --git a/doc/devel/documenting_mpl.rst b/doc/devel/documenting_mpl.rst
@@ -87,17 +87,24 @@ Other useful invocations include
    # Build pdf docs.
    make latexpdf
 
-You can build the documentation with several options:
+The ``SPHINXOPTS`` variable is set to ``-W`` by default to turn warnings into
+errors.  To unset it, use
 
-* ``make O=-W html`` turns Sphinx warnings into errors.  The continuous
-  integration script uses this option.
-* ``make O=-j4 html`` (for example) runs a parallel build with 4 processes.
+.. code-block:: sh
+
+   make SPHINXOPTS= html
+
+You can use the ``O`` variable to set additional options:
+
+* ``make O=-j4 html`` runs a parallel build with 4 processes.
 * ``make O=-Dplot_formats=png:100 html`` saves figures in low resolution.
 * ``make O=-Dplot_gallery=0 html`` skips the gallery build.
 
-Multiple options can be combined using e.g. ``make O='-W -j4 ...' html``.  On
-Windows, the option needs to be set as the ``SPHINXOPTS`` environment
-variable, e.g. ``set SPHINXOPTS=-W -j4 & make html``.
+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``.
 
 Writing new documentation
 =========================
diff --git a/doc/make.bat b/doc/make.bat
@@ -10,6 +10,8 @@ if "%SPHINXBUILD%" == "" (
 set SOURCEDIR=.
 set BUILDDIR=build
 set SPHINXPROJ=matplotlib
+set SPHINXOPTS=-W
+set O=
 
 %SPHINXBUILD% >NUL 2>NUL
 if errorlevel 9009 (
@@ -26,11 +28,11 @@ if errorlevel 9009 (
 
 if "%1" == "" goto help
 
-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
 goto end
 
 :help
-%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
 
 :end
 popd

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 =`
	`5`	`+SPHINXOPTS = -W`
`6`	`6`	`SPHINXBUILD = python -msphinx`
`7`	`7`	`SPHINXPROJ = matplotlib`
`8`	`8`	`SOURCEDIR = .`