Adding the -n option to the Sphinx build invocation so that WARNINGs will be treated as ERRORs. This will cause builds to fail if Sphinx cannot import modules for its autoclass directives. Currently, they fail silently and leave gaps in the published HTML where docstring content should have been.

2016-03-03 14:52:29 -05:00
parent ad5cec1046
commit afd04658cd
1 changed files with 1 additions and 1 deletions
--- a/docs/en_us/platform_api/Makefile
+++ b/docs/en_us/platform_api/Makefile
@@ -2,7 +2,7 @@
 #

 # You can set these variables from the command line.
-SPHINXOPTS    ?=
+SPHINXOPTS    ?= -n
 SPHINXBUILD   ?= sphinx-build
 PAPER         ?=
 BUILDDIR      ?= build