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
This commit is contained in:
parent
196e6d9531
commit
abb3460b9e
@ -4,4 +4,5 @@ Trove Library Specific Commandments
|
|||||||
- [T101] Validate that LOG messages, except debug ones, are translated
|
- [T101] Validate that LOG messages, except debug ones, are translated
|
||||||
- [T102] Validate that debug level logs are not translated
|
- [T102] Validate that debug level logs are not translated
|
||||||
- [T103] Exception messages should be translated
|
- [T103] Exception messages should be translated
|
||||||
- [T104] Python 3 is not support basestring,replace basestring with six.string_types
|
- [T104] Python 3 is not support basestring,replace basestring with
|
||||||
|
six.string_types
|
||||||
|
@ -22,7 +22,8 @@ Download DevStack
|
|||||||
Enable the Trove plugin
|
Enable the Trove plugin
|
||||||
=======================
|
=======================
|
||||||
|
|
||||||
Enable the plugin by adding the following section to ``$DEVSTACK_DIR/local.conf``
|
Enable the plugin by adding the following section to
|
||||||
|
``$DEVSTACK_DIR/local.conf``
|
||||||
|
|
||||||
.. sourcecode:: bash
|
.. sourcecode:: bash
|
||||||
|
|
||||||
|
@ -26,5 +26,6 @@ psycopg2>=2.6.2 # LGPL/ZPL
|
|||||||
cassandra-driver!=3.6.0,>=2.1.4 # Apache-2.0
|
cassandra-driver!=3.6.0,>=2.1.4 # Apache-2.0
|
||||||
couchdb>=0.8 # Apache-2.0
|
couchdb>=0.8 # Apache-2.0
|
||||||
os-testr>=1.0.0 # Apache-2.0
|
os-testr>=1.0.0 # Apache-2.0
|
||||||
|
doc8>=0.6.0 # Apache-2.0
|
||||||
astroid<1.4.0 # LGPLv2.1 # breaks pylint 1.4.4
|
astroid<1.4.0 # LGPLv2.1 # breaks pylint 1.4.4
|
||||||
pylint==1.4.5 # GPLv2
|
pylint==1.4.5 # GPLv2
|
||||||
|
4
tox.ini
4
tox.ini
@ -30,6 +30,7 @@ sitepackages = True
|
|||||||
basepython = python2.7
|
basepython = python2.7
|
||||||
commands =
|
commands =
|
||||||
flake8
|
flake8
|
||||||
|
doc8 {posargs}
|
||||||
|
|
||||||
[testenv:py27]
|
[testenv:py27]
|
||||||
commands = {[testenv]commands}
|
commands = {[testenv]commands}
|
||||||
@ -69,6 +70,9 @@ commands =
|
|||||||
[testenv:venv]
|
[testenv:venv]
|
||||||
commands = {posargs}
|
commands = {posargs}
|
||||||
|
|
||||||
|
[doc8]
|
||||||
|
ignore-path = .venv,.tox,.git,dist,doc,*egg-info,tools,etc,build,*.po,*.pot,integration,releasenotes,*.txt,api-ref/source/samples
|
||||||
|
|
||||||
[flake8]
|
[flake8]
|
||||||
show-source = True
|
show-source = True
|
||||||
# H301 is ignored on purpose.
|
# H301 is ignored on purpose.
|
||||||
|
Loading…
Reference in New Issue
Block a user