devref: consider sphinx warnings as failures

We previously introduced issues in our documentation due to not checking
for sphinx warnings [1], so let's enforce documentation validation.

This commit also fixes minor syntax issues caught by sphinx. Among
those, contribute.rst is now properly attached to ToC.

[1]: I48ab899077458d99eee6f643577d574106c1ca88

Change-Id: I9170883a20137c343f03d8b052399eacab4ae130

diff --git a/TESTING.rst b/TESTING.rst
index 6c9204d1b0f4b032a267a8ea0ebeb46b095ea738..77b9a57546ec7b1012bf4d210a61e2bcee7b34f4 100644 (file)
--- a/TESTING.rst
+++ b/TESTING.rst
@@ -64,7 +64,7 @@ tests in a virtualenv::
 
 
 With `nose2`
-~~~~~~~~~~~
+~~~~~~~~~~~~
 
 You can use `nose2`_ to run individual tests, as well as use for debugging
 portions of your code::

diff --git a/doc/source/devref/development.environment.rst b/doc/source/devref/development.environment.rst
index d7de7786dc0de140370f19fc785f3a3c92b61820..21b90b4ebf24be3940f0c3d55a1b2a54a02a8aed 100644 (file)
--- a/doc/source/devref/development.environment.rst
+++ b/doc/source/devref/development.environment.rst
@@ -47,5 +47,3 @@ Grab the code::
 
 
 .. include:: ../../../TESTING.rst
-
-.. include:: ./contribute.rst

diff --git a/doc/source/devref/index.rst b/doc/source/devref/index.rst
index 90394ec74cd03c91926be39deef766c361a4ae74..0467ecbdb37e34946aa4efea7dd4b6c18b04c2ba 100644 (file)
--- a/doc/source/devref/index.rst
+++ b/doc/source/devref/index.rst
@@ -30,6 +30,7 @@ Programming HowTos and Tutorials
     :maxdepth: 3
 
     development.environment
+    contribute
 
 
 Neutron Internals

diff --git a/tox.ini b/tox.ini
index 3779ad96f3ad8c79497943b4f40d44849cb6e005..dc8a5503d5e10cb3446e2710593f7641ece80e8c 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -65,7 +65,7 @@ commands =
 commands = {posargs}
 
 [testenv:docs]
-commands = python setup.py build_sphinx
+commands = sphinx-build -W -b html doc/source doc/build
 
 [flake8]
 # E125 continuation line does not distinguish itself from next logical line