From 754b99668fbda7dbfcab6d4d1aa9033fbbd4d459 Mon Sep 17 00:00:00 2001 From: Ihar Hrachyshka Date: Fri, 20 Feb 2015 15:05:07 +0100 Subject: [PATCH] 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 --- TESTING.rst | 2 +- doc/source/devref/development.environment.rst | 2 -- doc/source/devref/index.rst | 1 + tox.ini | 2 +- 4 files changed, 3 insertions(+), 4 deletions(-) diff --git a/TESTING.rst b/TESTING.rst index 6c9204d1b..77b9a5754 100644 --- 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 d7de7786d..21b90b4eb 100644 --- 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 90394ec74..0467ecbdb 100644 --- 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 3779ad96f..dc8a5503d 100644 --- 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 -- 2.45.2