openstack/neutron
Code Issues Proposed changes

devref: consider sphinx warnings as failures

Browse Source 
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
This commit is contained in:
Ihar Hrachyshka
2015-02-20 15:05:07 +01:00
committed by Henry Gessau
parent 53ed158cba
commit 754b99668f
4 changed files with 3 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
TESTING.rst
View File

@@ -64,7 +64,7 @@ tests in a virtualenv::
With `nose2` With `nose2`
~~~~~~~~~~~ ~~~~~~~~~~~~
You can use `nose2`_ to run individual tests, as well as use for debugging You can use `nose2`_ to run individual tests, as well as use for debugging
portions of your code:: portions of your code::

2
doc/source/devref/development.environment.rst
View File

@@ -47,5 +47,3 @@ Grab the code::
.. include:: ../../../TESTING.rst .. include:: ../../../TESTING.rst
.. include:: ./contribute.rst

1
doc/source/devref/index.rst
View File

@@ -30,6 +30,7 @@ Programming HowTos and Tutorials
:maxdepth: 3 :maxdepth: 3
development.environment development.environment
contribute
Neutron Internals Neutron Internals

2
tox.ini
View File

@@ -65,7 +65,7 @@ commands =
commands = {posargs} commands = {posargs}
[testenv:docs] [testenv:docs]
commands = python setup.py build_sphinx commands = sphinx-build -W -b html doc/source doc/build
[flake8] [flake8]
# E125 continuation line does not distinguish itself from next logical line # E125 continuation line does not distinguish itself from next logical line