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

doc/source/user/drivers.rst

@@ -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:
 
-+-------------------+---------------------+------------------------------------+------------------+
+.. list-table::
-| Driver            |     Maintainer      |        Email                       |     IRC Nick     |
+   :header-rows: 1
-+===================+=====================+====================================+==================+
+
-| File System       |     Glance Team     |  openstack-dev@lists.openstack.org | openstack-glance |
+   * - Driver
-+-------------------+---------------------+------------------------------------+------------------+
+     - Maintainer
-| HTTP              |     Glance Team     |  openstack-dev@lists.openstack.org | openstack-glance |
+     - Email
-+-------------------+---------------------+------------------------------------+------------------+
+     - IRC Nick
-| RBD               |    Fei Long Wang    |  flwang@catalyst.net.nz            |   flwang         |
+   * - File System
-+-------------------+---------------------+------------------------------------+------------------+
+     - Glance Team
-| Cinder            |  Tomoki Sekiyama    |  tomoki.sekiyama@gmail.com         |                  |
+     - openstack-dev@lists.openstack.org
-+-------------------+---------------------+------------------------------------+------------------+
+     - openstack-glance
-| Swift             |  Matthew Oliver     |  matt@oliver.net.au                |   mattoliverau   |
+   * - HTTP
-+-------------------+---------------------+------------------------------------+------------------+
+     - Glance Team
-| VMware            |  Sabari Murugesan   |  smurugesan@vmware.com             |   sabari         |
+     - openstack-dev@lists.openstack.org
-+-------------------+---------------------+------------------------------------+------------------+
+     - openstack-glance
-| Sheepdog          |  YAMADA Hideki      |  yamada.hideki@lab.ntt.co.jp       |   yamada-h       |
+   * - 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

requirements.txt

@@ -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
 

tox.ini

@@ -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