From e68fba2b09bd87e55fee5f8e535cb0e473f519c2 Mon Sep 17 00:00:00 2001
From: Sean McGinnis <sean.mcginnis@huawei.com>
Date: Wed, 28 Mar 2018 16:56:49 -0500
Subject: [PATCH] Fix doc format errors in module docstrings

This fixes some formatting issues in docstrings to allow us
to enable the warnings-as-errors flag for our docs build.

Co-authored by: Jay S. Bryant <jungleboyj@electronicjungle.net>

Change-Id: I9567e232686d8775ff67418e8333c164f8acd8f3
---
 cinder/volume/drivers/dell_emc/unity/driver.py | 8 ++++++++
 cinder/volume/drivers/dell_emc/vmax/fc.py      | 4 ++++
 cinder/volume/drivers/dell_emc/vnx/driver.py   | 8 ++++++++
 tox.ini                                        | 2 +-
 4 files changed, 21 insertions(+), 1 deletion(-)

diff --git a/cinder/volume/drivers/dell_emc/unity/driver.py b/cinder/volume/drivers/dell_emc/unity/driver.py
index 08c2c301ef5..80c91c4b51a 100644
--- a/cinder/volume/drivers/dell_emc/unity/driver.py
+++ b/cinder/volume/drivers/dell_emc/unity/driver.py
@@ -136,6 +136,9 @@ class UnityDriver(driver.ManageableVD,
         and a list of wwns which are visible to the remote wwn(s).
         Example return values:
         FC:
+
+        .. code-block:: json
+
             {
                 'driver_volume_type': 'fibre_channel'
                 'data': {
@@ -148,7 +151,11 @@ class UnityDriver(driver.ManageableVD,
                     }
                 }
             }
+
         iSCSI:
+
+        .. code-block:: json
+
             {
                 'driver_volume_type': 'iscsi'
                 'data': {
@@ -159,6 +166,7 @@ class UnityDriver(driver.ManageableVD,
                     'target_luns': [1, 1],
                 }
             }
+
         """
         return self.adapter.initialize_connection(volume, connector)
 
diff --git a/cinder/volume/drivers/dell_emc/vmax/fc.py b/cinder/volume/drivers/dell_emc/vmax/fc.py
index 51aac85652e..d201bf60e8a 100644
--- a/cinder/volume/drivers/dell_emc/vmax/fc.py
+++ b/cinder/volume/drivers/dell_emc/vmax/fc.py
@@ -209,6 +209,9 @@ class VMAXFCDriver(san.SanDriver, driver.FibreChannelDriver):
         The target_wwn can be a single entry or a list of wwns that
         correspond to the list of remote wwn(s) that will export the volume.
         Example return values:
+
+        .. code-block:: json
+
             {
                 'driver_volume_type': 'fibre_channel'
                 'data': {
@@ -228,6 +231,7 @@ class VMAXFCDriver(san.SanDriver, driver.FibreChannelDriver):
                     'target_wwn': ['1234567890123', '0987654321321'],
                 }
             }
+
         :param volume: the cinder volume object
         :param connector: the connector object
         :returns: dict -- the target_wwns and initiator_target_map
diff --git a/cinder/volume/drivers/dell_emc/vnx/driver.py b/cinder/volume/drivers/dell_emc/vnx/driver.py
index 40c3c3eba37..9225a327684 100644
--- a/cinder/volume/drivers/dell_emc/vnx/driver.py
+++ b/cinder/volume/drivers/dell_emc/vnx/driver.py
@@ -178,6 +178,9 @@ class VNXDriver(driver.ManageableVD,
         and a list of wwns which are visible to the remote wwn(s).
         Example return values:
         FC:
+
+        .. code-block:: json
+
             {
                 'driver_volume_type': 'fibre_channel'
                 'data': {
@@ -190,7 +193,11 @@ class VNXDriver(driver.ManageableVD,
                     }
                 }
             }
+
         iSCSI:
+
+        .. code-block:: json
+
             {
                 'driver_volume_type': 'iscsi'
                 'data': {
@@ -201,6 +208,7 @@ class VNXDriver(driver.ManageableVD,
                     'target_luns': [1, 1],
                 }
             }
+
         """
         LOG.debug("Entering initialize_connection"
                   " - connector: %(connector)s.",
diff --git a/tox.ini b/tox.ini
index 3820018497f..fdb0aaa52ea 100644
--- a/tox.ini
+++ b/tox.ini
@@ -113,7 +113,7 @@ deps =
 commands =
   doc8 --ignore D001 --ignore-path .tox --ignore-path *.egg-info --ignore-path doc/src/api --ignore-path doc/source/drivers.rst --ignore-path doc/build --ignore-path .eggs/*/EGG-INFO/*.txt -e txt -e rst
   rm -fr doc/build doc/source/contributor/api/ .autogenerated
-  sphinx-build -b html doc/source doc/build/html
+  sphinx-build -W -b html doc/source doc/build/html
   rm -rf api-ref/build
   sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html/
 whitelist_externals = rm