Merge "Adds doc8 check to pep8"

doc/source/admin/index.rst

@@ -8,4 +8,3 @@ Table of Contents:
 
    installation
    operation
-   

doc/source/user/index.rst

@@ -8,4 +8,3 @@ User Guide
    freezer-agent
    freezer-scheduler
    freezer-web-ui
-   

lower-constraints.txt

@@ -17,6 +17,7 @@ ddt==1.0.1
 debtcollector==1.19.0
 decorator==4.2.1
 deprecation==2.0
+doc8==0.6.0
 docutils==0.14
 dogpile.cache==0.6.5
 dulwich==0.19.0

test-requirements.txt

@@ -19,3 +19,7 @@ tempest>=17.1.0 # Apache-2.0
 
 # Used in integration tests
 python-openstackclient>=3.12.0 # Apache-2.0
+
+# Used in doc8 check
+doc8>=0.6.0 # Apache-2.0
+Pygments>=2.2.0 # BSD license

tox.ini

@@ -65,7 +65,9 @@ commands =
 
 
 [testenv:pep8]
-commands = flake8 freezer
+commands =
+    flake8 freezer
+    doc8 {posargs}
 
 [testenv:pylint]
 commands = pylint --rcfile .pylintrc freezer
@@ -76,6 +78,10 @@ show-source = True
 enable-extensions = H203,H106
 exclude = .venv,.tox,dist,doc,test,*egg,releasenotes
 
+[doc8]
+ignore = D000,D001
+ignore-path = .venv,.git,.tox,.tmp,*freezer/locale*,*lib/python*,freezer.egg*,doc/build,releasenotes/*,doc/source/contributor/api
+
 [testenv:releasenotes]
 commands = sphinx-build -a -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html