Permalink
Browse files

Add make html-errors for the doc directory

This just adds the -W flag to sphinx-build, which treats all warnings as
errors.  This is useful for example with sympy-bot, where one can do

./sympy-bot review 1400 -t "-V; cd doc; make html-errors"

and the bot will report passing status iff the docs build without any errors
or warnings (the -V is necessary because the bot passes the -t argument to
python).
  • Loading branch information...
1 parent b84b728 commit b41a87a209227f43f67c99f6bee648699e9a538b @asmeurer asmeurer committed Jul 4, 2012
Showing with 3 additions and 0 deletions.
  1. +3 −0 doc/Makefile
View
@@ -51,6 +51,9 @@ html: $(SPHINXBUILDpy)
@echo
@echo "Build finished. The HTML pages are in _build/html."
+html-errors: SPHINXOPTS += -W
+html-errors: html
+
htmlapi: $(SPHINXBUILDpy)
mkdir -p api/.static
mkdir -p api/modules

0 comments on commit b41a87a

Please sign in to comment.