Include .inc files in doc8 linting

We use *.inc files extensively, especially in the api-ref, but these
files are not covered by default with our doc8 validation.

This adds support for those files and fixes a few issues that were
identified after enabling coverage.

Change-Id: I807823f3cb44274c3940db55e901d434304a09f5
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
This commit is contained in:
Sean McGinnis 2019-02-19 11:33:05 -06:00
parent 2d79dafcb3
commit b6f9932f9c
No known key found for this signature in database
GPG Key ID: CE7EE4BFAF8D70C8
3 changed files with 61 additions and 61 deletions

View File

@ -1,12 +1,12 @@
.. -*- rst -*-
.. _valid-boolean-values:
Valid boolean values
====================
Following is the list of valid values for boolean parameters.
[True, True, TRUE, true, 1, ON, On, on, YES,
Yes, yes, y, t, False, False, FALSE, false, 0,
OFF, Off, off, NO, No, no, n, f]
.. -*- rst -*-
.. _valid-boolean-values:
Valid boolean values
====================
Following is the list of valid values for boolean parameters.
[True, True, TRUE, true, 1, ON, On, on, YES,
Yes, yes, y, t, False, False, FALSE, false, 0,
OFF, Off, off, NO, No, no, n, f]

View File

@ -1,48 +1,48 @@
Volume driver configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~
This section describes how to configure the FusionStorage Volume Driver.
To configure the volume driver, follow the steps below:
#. Configure the ``cinder.conf`` file.
In the ``[default]`` block of ``/etc/cinder/cinder.conf``,
enable the ``VOLUME_BACKEND``:
.. code-block:: ini
enabled_backends = VOLUME_BACKEND
Add a new block ``[VOLUME_BACKEND]``, and add the following contents:
.. code-block:: ini
[VOLUME_BACKEND]
volume_driver = cinder.volume.drivers.fusionstorage.dsware.DSWAREDriver
volume_backend_name = backend_name
manager_ips =
host1:ip1,
host2:ip2
storage =
UserName: username,
Password: password,
RestURL: url,
StoragePool: pool0;pool1;pool2
* ``volume_driver`` indicates the loaded driver.
* ``volume_backend_name`` indicates the name of the backend.
* ``manager_ips`` indicates the management host name and its corresponding IP address;
The parameters takes the standard dict config form, such as
manager_ips = host1:ip1, host2:ip2.
* ``storage`` indicates the FusionStorage and user info, include "UserName",
"Password", "RestURL", "StoragePool". The parameters takes the standard
dict config form.
#. Run the :command:`service cinder-volume restart` command to restart the
Block Storage service.
Volume driver configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~
This section describes how to configure the FusionStorage Volume Driver.
To configure the volume driver, follow the steps below:
#. Configure the ``cinder.conf`` file.
In the ``[default]`` block of ``/etc/cinder/cinder.conf``,
enable the ``VOLUME_BACKEND``:
.. code-block:: ini
enabled_backends = VOLUME_BACKEND
Add a new block ``[VOLUME_BACKEND]``, and add the following contents:
.. code-block:: ini
[VOLUME_BACKEND]
volume_driver = cinder.volume.drivers.fusionstorage.dsware.DSWAREDriver
volume_backend_name = backend_name
manager_ips =
host1:ip1,
host2:ip2
storage =
UserName: username,
Password: password,
RestURL: url,
StoragePool: pool0;pool1;pool2
* ``volume_driver`` indicates the loaded driver.
* ``volume_backend_name`` indicates the name of the backend.
* ``manager_ips`` indicates the management host name and its corresponding IP address;
The parameters takes the standard dict config form, such as
manager_ips = host1:ip1, host2:ip2.
* ``storage`` indicates the FusionStorage and user info, include "UserName",
"Password", "RestURL", "StoragePool". The parameters takes the standard
dict config form.
#. Run the :command:`service cinder-volume restart` command to restart the
Block Storage service.

View File

@ -142,7 +142,7 @@ deps =
-r{toxinidir}/requirements.txt
-r{toxinidir}/doc/requirements.txt
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 -e .inc
rm -fr doc/build doc/source/contributor/api/ .autogenerated
sphinx-build -W -b html doc/source doc/build/html
rm -rf api-ref/build