Browse Source

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>
Danny Al-Gaaf 2 years ago
parent
commit
a8ec3317be

+ 2
- 2
HACKING.rst View File

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

+ 3
- 1
doc/source/devref/container_driver.rst View File

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

+ 2
- 1
doc/source/devref/driver_filter_goodness_weigher.rst View File

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

+ 2
- 2
doc/source/devref/emc_unity_driver.rst View File

@@ -179,7 +179,7 @@ Following driver features are implemented in the plugin.
179 179
 
180 180
 
181 181
 The :mod:`manila.share.drivers.dell_emc.driver` Module
182
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
182
+------------------------------------------------------
183 183
 
184 184
 .. automodule:: manila.share.drivers.dell_emc.driver
185 185
     :noindex:
@@ -188,7 +188,7 @@ The :mod:`manila.share.drivers.dell_emc.driver` Module
188 188
     :show-inheritance:
189 189
 
190 190
 The :mod:`manila.share.drivers.dell_emc.plugins.unity.connection` Module
191
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
191
+------------------------------------------------------------------------
192 192
 
193 193
 .. automodule:: manila.share.drivers.dell_emc.plugins.unity.connection
194 194
     :noindex:

+ 2
- 2
doc/source/devref/fakes.rst View File

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

+ 2
- 2
doc/source/devref/manila.rst View File

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

+ 3
- 3
doc/source/devref/threading.rst View File

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

+ 2
- 1
install-guide/source/common/dhss-true-mode-intro.rst View File

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

+ 1
- 0
test-requirements.txt View File

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

+ 3
- 1
tox.ini View File

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

Loading…
Cancel
Save