Add doc8 to pep8 check for glance_store 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.

Co-authored-By: Nguyen Van Trung <trungnv@vn.fujitsu.com>
Change-Id: If35a7a9ea64c7482306ef6403e9585b78da27fb9
This commit is contained in:
Hoang Trung Hieu 2018-01-22 11:16:34 +07:00 committed by Nguyen Van Trung
parent c645af7c4b
commit 2a32fb63fa
3 changed files with 40 additions and 18 deletions

View File

@ -7,20 +7,38 @@ within the library's code base and they are maintained by either
members of the Glance community or OpenStack in general. Please, find
below the table of supported drivers and maintainers:
+-------------------+---------------------+------------------------------------+------------------+
| Driver | Maintainer | Email | IRC Nick |
+===================+=====================+====================================+==================+
| File System | Glance Team | openstack-dev@lists.openstack.org | openstack-glance |
+-------------------+---------------------+------------------------------------+------------------+
| HTTP | Glance Team | openstack-dev@lists.openstack.org | openstack-glance |
+-------------------+---------------------+------------------------------------+------------------+
| RBD | Fei Long Wang | flwang@catalyst.net.nz | flwang |
+-------------------+---------------------+------------------------------------+------------------+
| Cinder | Tomoki Sekiyama | tomoki.sekiyama@gmail.com | |
+-------------------+---------------------+------------------------------------+------------------+
| Swift | Matthew Oliver | matt@oliver.net.au | mattoliverau |
+-------------------+---------------------+------------------------------------+------------------+
| VMware | Sabari Murugesan | smurugesan@vmware.com | sabari |
+-------------------+---------------------+------------------------------------+------------------+
| Sheepdog | YAMADA Hideki | yamada.hideki@lab.ntt.co.jp | yamada-h |
+-------------------+---------------------+------------------------------------+------------------+
.. list-table::
:header-rows: 1
* - Driver
- Maintainer
- Email
- IRC Nick
* - File System
- Glance Team
- openstack-dev@lists.openstack.org
- openstack-glance
* - HTTP
- Glance Team
- openstack-dev@lists.openstack.org
- openstack-glance
* - RBD
- Fei Long Wang
- flwang@catalyst.net.nz
- flwang
* - Cinder
- Tomoki Sekiyama
- tomoki.sekiyama@gmail.com
-
* - Swift
- Matthew Oliver
- matt@oliver.net.au
- mattoliverau
* - VMware
- Sabari Murugesan
- smurugesan@vmware.com
- sabari
* - Sheepdog
- YAMADA Hideki
- yamada.hideki@lab.ntt.co.jp
- yamada-h

View File

@ -8,7 +8,7 @@ oslo.utils>=3.33.0 # Apache-2.0
oslo.concurrency>=3.25.0 # Apache-2.0
stevedore>=1.20.0 # Apache-2.0
enum34>=1.0.4;python_version=='2.7' or python_version=='2.6' or python_version=='3.3' # BSD
doc8>=0.6.0 # Apache-2.0
eventlet!=0.18.3,!=0.20.1,<0.21.0,>=0.18.2 # MIT
six>=1.10.0 # MIT

View File

@ -28,6 +28,7 @@ commands =
# B110 - Try, Except, Pass detected.
# B303 - Use of insecure MD2, MD4, or MD5 hash function.
bandit -r glance_store -x tests --skip B101,B110,B303
doc8 {posargs}
[testenv:bandit]
# NOTE(browne): This is required for the integration test job of the bandit
@ -55,6 +56,9 @@ sitepackages = True
setenv = OS_TEST_PATH=./glance_store/tests/functional/filesystem
commands = python setup.py testr --slowest --testr-args='glance_store.tests.functional.filesystem'
[doc8]
ignore-path = .venv,.git,.tox,*glance_store/locale*,*lib/python*,glance_store.egg*,doc/build,*requirements.txt
[flake8]
# TODO(dmllr): Analyze or fix the warnings blacklisted below
# H301 one import per line