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
This commit is contained in:
parent
575d7c855e
commit
e68fba2b09
@ -136,6 +136,9 @@ class UnityDriver(driver.ManageableVD,
|
|||||||
and a list of wwns which are visible to the remote wwn(s).
|
and a list of wwns which are visible to the remote wwn(s).
|
||||||
Example return values:
|
Example return values:
|
||||||
FC:
|
FC:
|
||||||
|
|
||||||
|
.. code-block:: json
|
||||||
|
|
||||||
{
|
{
|
||||||
'driver_volume_type': 'fibre_channel'
|
'driver_volume_type': 'fibre_channel'
|
||||||
'data': {
|
'data': {
|
||||||
@ -148,7 +151,11 @@ class UnityDriver(driver.ManageableVD,
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
iSCSI:
|
iSCSI:
|
||||||
|
|
||||||
|
.. code-block:: json
|
||||||
|
|
||||||
{
|
{
|
||||||
'driver_volume_type': 'iscsi'
|
'driver_volume_type': 'iscsi'
|
||||||
'data': {
|
'data': {
|
||||||
@ -159,6 +166,7 @@ class UnityDriver(driver.ManageableVD,
|
|||||||
'target_luns': [1, 1],
|
'target_luns': [1, 1],
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
"""
|
"""
|
||||||
return self.adapter.initialize_connection(volume, connector)
|
return self.adapter.initialize_connection(volume, connector)
|
||||||
|
|
||||||
|
@ -209,6 +209,9 @@ class VMAXFCDriver(san.SanDriver, driver.FibreChannelDriver):
|
|||||||
The target_wwn can be a single entry or a list of wwns that
|
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.
|
correspond to the list of remote wwn(s) that will export the volume.
|
||||||
Example return values:
|
Example return values:
|
||||||
|
|
||||||
|
.. code-block:: json
|
||||||
|
|
||||||
{
|
{
|
||||||
'driver_volume_type': 'fibre_channel'
|
'driver_volume_type': 'fibre_channel'
|
||||||
'data': {
|
'data': {
|
||||||
@ -228,6 +231,7 @@ class VMAXFCDriver(san.SanDriver, driver.FibreChannelDriver):
|
|||||||
'target_wwn': ['1234567890123', '0987654321321'],
|
'target_wwn': ['1234567890123', '0987654321321'],
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
:param volume: the cinder volume object
|
:param volume: the cinder volume object
|
||||||
:param connector: the connector object
|
:param connector: the connector object
|
||||||
:returns: dict -- the target_wwns and initiator_target_map
|
:returns: dict -- the target_wwns and initiator_target_map
|
||||||
|
@ -178,6 +178,9 @@ class VNXDriver(driver.ManageableVD,
|
|||||||
and a list of wwns which are visible to the remote wwn(s).
|
and a list of wwns which are visible to the remote wwn(s).
|
||||||
Example return values:
|
Example return values:
|
||||||
FC:
|
FC:
|
||||||
|
|
||||||
|
.. code-block:: json
|
||||||
|
|
||||||
{
|
{
|
||||||
'driver_volume_type': 'fibre_channel'
|
'driver_volume_type': 'fibre_channel'
|
||||||
'data': {
|
'data': {
|
||||||
@ -190,7 +193,11 @@ class VNXDriver(driver.ManageableVD,
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
iSCSI:
|
iSCSI:
|
||||||
|
|
||||||
|
.. code-block:: json
|
||||||
|
|
||||||
{
|
{
|
||||||
'driver_volume_type': 'iscsi'
|
'driver_volume_type': 'iscsi'
|
||||||
'data': {
|
'data': {
|
||||||
@ -201,6 +208,7 @@ class VNXDriver(driver.ManageableVD,
|
|||||||
'target_luns': [1, 1],
|
'target_luns': [1, 1],
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
"""
|
"""
|
||||||
LOG.debug("Entering initialize_connection"
|
LOG.debug("Entering initialize_connection"
|
||||||
" - connector: %(connector)s.",
|
" - connector: %(connector)s.",
|
||||||
|
2
tox.ini
2
tox.ini
@ -113,7 +113,7 @@ deps =
|
|||||||
commands =
|
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
|
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
|
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
|
rm -rf api-ref/build
|
||||||
sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html/
|
sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html/
|
||||||
whitelist_externals = rm
|
whitelist_externals = rm
|
||||||
|
Loading…
x
Reference in New Issue
Block a user