Add doc8 to pep8 check for neutron-fwaas project

This patch adds a doc8 check of .rst files to the current pep8 check.
It includes fixes to the .rst files that didn't pass the check.

Change-Id: I9d6d604e7a21540728c4f44afc9be5577d02805f
This commit is contained in:
Nguyen Van Trung 2017-12-13 12:56:17 +07:00
parent 0f7e1d20b5
commit 4eefecf4f0
3 changed files with 10 additions and 2 deletions

View File

@ -14,7 +14,8 @@ version you with to run.
How to run FWaaS V2 in DevStack
===============================
Add the following to the localrc section of your local.conf to configure FWaaS v2.
Add the following to the localrc section of your local.conf to configure
FWaaS v2.
.. code-block:: none
@ -35,7 +36,8 @@ testing.
How to run FWaaS V1 in DevStack
===============================
Add the following to the localrc section of your local.conf to configure FWaaS v1.
Add the following to the localrc section of your local.conf to configure
FWaaS v1.
.. code-block:: none

View File

@ -23,3 +23,4 @@ oslotest>=1.10.0 # Apache-2.0
reno>=2.5.0 # Apache-2.0
PyMySQL>=0.7.6 # MIT License
psycopg2>=2.6.2 # LGPL/ZPL
doc8>=0.6.0 # Apache-2.0

View File

@ -64,6 +64,7 @@ commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasen
[testenv:pep8]
commands =
flake8
doc8 {posargs}
{toxinidir}/tools/check_unit_test_structure.sh
neutron-db-manage --subproject neutron-fwaas --database-connection sqlite:// check_migration
{[testenv:genconfig]commands}
@ -80,6 +81,10 @@ commands = {posargs}
[testenv:docs]
commands = python setup.py build_sphinx
[doc8]
ignore = D000
ignore-path = .venv,.git,.tox,.tmp,*neutron_fwaas/locale*,*lib/python*,neutron_fwaas.egg*,doc/build,releasenotes/*,doc/source/contributor/api
[flake8]
# E125 continuation line does not distinguish itself from next logical line
# E126 continuation line over-indented for hanging indent