summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNguyen Van Trung <trungnv@vn.fujitsu.com>2017-11-30 08:27:38 +0700
committerNguyen Van Trung <trungnv@vn.fujitsu.com>2017-11-30 08:28:55 +0700
commitabb3460b9e43b374eed8095936d9120979de46e4 (patch)
tree5b44c7fabf62d1e267e4a532a205ea039c91f411
parent196e6d95312cda64899baadbce9709325c25de3e (diff)
Add doc8 to pep8 check for trove 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: I866ee72cfdd6067ae219a751aa7c2a0c391886f7
Notes
Notes (review): Code-Review+1: David Rabel <rabel@b1-systems.de> Code-Review+1: Cuong Nguyen <cuongnv@vn.fujitsu.com> Code-Review+2: Manoj Kumar <manoj@linux.vnet.ibm.com> Workflow+1: Manoj Kumar <manoj@linux.vnet.ibm.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Sat, 02 Dec 2017 08:32:59 +0000 Reviewed-on: https://review.openstack.org/524042 Project: openstack/trove Branch: refs/heads/master
-rw-r--r--HACKING.rst3
-rw-r--r--devstack/README.rst3
-rw-r--r--test-requirements.txt1
-rw-r--r--tox.ini4
4 files changed, 9 insertions, 2 deletions
diff --git a/HACKING.rst b/HACKING.rst
index bceaba4..8aa5218 100644
--- a/HACKING.rst
+++ b/HACKING.rst
@@ -4,4 +4,5 @@ Trove Library Specific Commandments
4- [T101] Validate that LOG messages, except debug ones, are translated 4- [T101] Validate that LOG messages, except debug ones, are translated
5- [T102] Validate that debug level logs are not translated 5- [T102] Validate that debug level logs are not translated
6- [T103] Exception messages should be translated 6- [T103] Exception messages should be translated
7- [T104] Python 3 is not support basestring,replace basestring with six.string_types 7- [T104] Python 3 is not support basestring,replace basestring with
8 six.string_types
diff --git a/devstack/README.rst b/devstack/README.rst
index a84ddfa..c85d27f 100644
--- a/devstack/README.rst
+++ b/devstack/README.rst
@@ -22,7 +22,8 @@ Download DevStack
22Enable the Trove plugin 22Enable the Trove plugin
23======================= 23=======================
24 24
25Enable the plugin by adding the following section to ``$DEVSTACK_DIR/local.conf`` 25Enable the plugin by adding the following section to
26``$DEVSTACK_DIR/local.conf``
26 27
27.. sourcecode:: bash 28.. sourcecode:: bash
28 29
diff --git a/test-requirements.txt b/test-requirements.txt
index a705e0b..2b99ae8 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -26,5 +26,6 @@ psycopg2>=2.6.2 # LGPL/ZPL
26cassandra-driver!=3.6.0,>=2.1.4 # Apache-2.0 26cassandra-driver!=3.6.0,>=2.1.4 # Apache-2.0
27couchdb>=0.8 # Apache-2.0 27couchdb>=0.8 # Apache-2.0
28os-testr>=1.0.0 # Apache-2.0 28os-testr>=1.0.0 # Apache-2.0
29doc8>=0.6.0 # Apache-2.0
29astroid<1.4.0 # LGPLv2.1 # breaks pylint 1.4.4 30astroid<1.4.0 # LGPLv2.1 # breaks pylint 1.4.4
30pylint==1.4.5 # GPLv2 31pylint==1.4.5 # GPLv2
diff --git a/tox.ini b/tox.ini
index c2c9101..35cefcf 100644
--- a/tox.ini
+++ b/tox.ini
@@ -30,6 +30,7 @@ sitepackages = True
30basepython = python2.7 30basepython = python2.7
31commands = 31commands =
32 flake8 32 flake8
33 doc8 {posargs}
33 34
34[testenv:py27] 35[testenv:py27]
35commands = {[testenv]commands} 36commands = {[testenv]commands}
@@ -69,6 +70,9 @@ commands =
69[testenv:venv] 70[testenv:venv]
70commands = {posargs} 71commands = {posargs}
71 72
73[doc8]
74ignore-path = .venv,.tox,.git,dist,doc,*egg-info,tools,etc,build,*.po,*.pot,integration,releasenotes,*.txt,api-ref/source/samples
75
72[flake8] 76[flake8]
73show-source = True 77show-source = True
74# H301 is ignored on purpose. 78# H301 is ignored on purpose.