doc: verify all rst files

Make use of doc8 to verify all rst files which are not
autogenerated for errors and fail if there are any issues
found. The doc8 checks are now part of the tox 'docs'
environment and ran automatically. Checks can also be called
direcly via 'tox -e docs'.

Fix all issues found by doc8.

Closes-Bug: #1664841

Change-Id: I9215524d35646de7485504e4c5ff86fd91a1d09f
Signed-off-by: Danny Al-Gaaf <danny.al-gaaf@bisect.de>

HACKING.rst

@@ -1,5 +1,5 @@
 Manila Style Commandments
-=======================
+=========================
 
 - Step 1: Read the OpenStack Style Commandments
   http://docs.openstack.org/developer/hacking/
@@ -22,7 +22,7 @@ Manila Specific Commandments
 - [M329] LOG.info messages require translations _LI()!
 - [M330] LOG.warning messages require translations _LW()!
 - [M331] Log messages require translations!
-- [M333] 'oslo_' should be used instead of 'oslo.'
+- [M333] ``oslo_`` should be used instead of ``oslo.``
 - [M336] Must use a dict comprehension instead of a dict constructor
   with a sequence of key-value pairs.
 - [M337] Ensure to not use xrange().

doc/source/devref/container_driver.rst

@@ -81,7 +81,9 @@ This section describes steps needed to be performed to set the driver up
 manually. The driver has been tested on Ubuntu 14.04, thus in case of
 any other distribution package names might differ.
 The following packages must be installed:
- - docker.io
+
+- docker.io
+
 One can verify if the package is installed by issuing ``sudo docker info``
 command. In case of normal operation it should return docker usage statistics.
 In case it fails complaining on inaccessible socket try installing

doc/source/devref/driver_filter_goodness_weigher.rst

@@ -356,4 +356,5 @@ than 5 GB. ``example1`` will have priority until the provisioned capacity of
 all shares on it hits 30 GB. After that, ``example2`` will have priority until
 the provisioned capacity of all shares on it hits 80 GB. ``example3`` will
 collect all shares greater or equal to 5 GB as well as all shares once
-``example1`` and ``example2`` lose priority.
+``example1`` and ``example2`` lose priority.
+

doc/source/devref/emc_unity_driver.rst

@@ -179,7 +179,7 @@ Following driver features are implemented in the plugin.
 
 
 The :mod:`manila.share.drivers.dell_emc.driver` Module
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+------------------------------------------------------
 
 .. automodule:: manila.share.drivers.dell_emc.driver
     :noindex:
@@ -188,7 +188,7 @@ The :mod:`manila.share.drivers.dell_emc.driver` Module
     :show-inheritance:
 
 The :mod:`manila.share.drivers.dell_emc.plugins.unity.connection` Module
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+------------------------------------------------------------------------
 
 .. automodule:: manila.share.drivers.dell_emc.plugins.unity.connection
     :noindex:

doc/source/devref/fakes.rst

@@ -1,6 +1,6 @@
 ..
       Copyright 2010-2011 United States Government as represented by the
-      Administrator of the National Aeronautics and Space Administration. 
+      Administrator of the National Aeronautics and Space Administration.
       All Rights Reserved.
 
       Licensed under the Apache License, Version 2.0 (the "License"); you may
@@ -42,7 +42,7 @@ The :mod:`fake_driver` Module
     :members:
     :undoc-members:
     :show-inheritance:
-    
+
 
 The :mod:`fake_network` Module
 ------------------------------

doc/source/devref/manila.rst

@@ -1,6 +1,6 @@
 ..
       Copyright 2010-2011 United States Government as represented by the
-      Administrator of the National Aeronautics and Space Administration. 
+      Administrator of the National Aeronautics and Space Administration.
       All Rights Reserved.
 
       Licensed under the Apache License, Version 2.0 (the "License"); you may
@@ -49,7 +49,7 @@ The :mod:`manila.test` Module
     :noindex:
     :members:
     :undoc-members:
-    :show-inheritance:  
+    :show-inheritance:
 
 
 The :mod:`manila.utils` Module

doc/source/devref/threading.rst

@@ -28,9 +28,9 @@ in the long-running code path. The sleep call will trigger a context switch
 if there are pending threads, and using an argument of 0 will avoid introducing
 delays in the case that there is only a single green thread::
 
-	from eventlet import greenthread
-	...
-	greenthread.sleep(0)
+        from eventlet import greenthread
+        ...
+        greenthread.sleep(0)
 
 In current code, time.sleep(0) does the same thing as greenthread.sleep(0)
 if time module is patched through eventlet.monkey_patch(). To be explicit,

install-guide/source/common/dhss-true-mode-intro.rst

@@ -14,4 +14,5 @@ as the one used for the Block Storage service.
    information used for creating share servers is configured as share
    networks. Generic driver with DHSS enabled also requires the tenant's
    private network (where the compute instances are running) to be attached
-   to a public router.
+   to a public router.
+

test-requirements.txt

@@ -31,3 +31,4 @@ testresources>=0.2.4 # Apache-2.0/BSD
 testscenarios>=0.4 # Apache-2.0/BSD
 testtools>=1.4.0 # MIT
 reno>=1.8.0 # Apache-2.0
+doc8 # Apache-2.0

tox.ini

@@ -63,7 +63,9 @@ commands =
 commands = {posargs}
 
 [testenv:docs]
-commands = python setup.py build_sphinx
+commands =
+  python setup.py build_sphinx
+  doc8 --ignore D001 --ignore-path .tox --ignore-path doc/build --ignore-path manila.egg-info -e txt -e rst
 
 [testenv:cover]
 commands = {toxinidir}/tools/cover.sh {posargs}