diff --git a/doc/hyperv-guide.rst b/doc/hyperv-guide.rst
index 42fc0898c6cbe93ec3b6d1773f388ee638d31875..3b175267b2404d43ef9c6d623775e4ec6ef50a88 100644
--- a/doc/hyperv-guide.rst
+++ b/doc/hyperv-guide.rst
@@ -66,8 +66,9 @@ Virtual Interface the following PowerShell may be used:
-AllowManagementOS option is set on True, otherwise you will lose connectivity to the Hyper-V node.
-To prepare the Hyper-V node to be able to attach to volumes provided by cinder you must
-first make sure the Windows iSCSI initiator service is running and started automatically.
+To prepare the Hyper-V node to be able to attach to volumes provided by
+cinder you must first make sure the Windows iSCSI initiator service is
+running and started automatically.
.. code-block:: console
@@ -94,15 +95,16 @@ Hyper-V options are also required in ``/etc/kolla/globals.yml``:
vswitch_name: <HyperV virtual switch name>
nova_msi_url: "https://www.cloudbase.it/downloads/HyperVNovaCompute_Beta.msi"
-If tenant networks are to be built using VLAN add corresponding type in ``/etc/kolla/globals.yml``:
+If tenant networks are to be built using VLAN add corresponding type in
+``/etc/kolla/globals.yml``:
.. code-block:: console
neutron_tenant_network_types: 'flat,vlan'
The virtual switch is the same one created on the HyperV setup part.
-For nova_msi_url, different Nova MSI (Mitaka/Newton/Ocata) versions can be found on
-`Cloudbase website
+For nova_msi_url, different Nova MSI (Mitaka/Newton/Ocata) versions can
+be found on `Cloudbase website
<https://cloudbase.it/openstack-hyperv-driver/>`__.
@@ -120,7 +122,8 @@ Add the Hyper-V node in ``ansible/inventory`` file:
ansible_connection=winrm
ansible_winrm_server_cert_validation=ignore
-pywinrm package needs to be installed in order for Ansible to work on the HyperV node:
+``pywinrm`` package needs to be installed in order for Ansible to work
+on the HyperV node:
.. code-block:: console
@@ -136,16 +139,18 @@ pywinrm package needs to be installed in order for Ansible to work on the HyperV
Set-VMNetworkAdapterVlan -Trunk -AllowedVlanIdList <VLAN ID> -NativeVlanId 0 <VM name>
-networking-hyperv mechanism driver is needed for neutron-server to communicate with
-HyperV nova-compute. This can be built with source images by default. Manually it
-can be intalled in neutron-server container with pip:
+networking-hyperv mechanism driver is needed for neutron-server to
+communicate with HyperV nova-compute. This can be built with source
+images by default. Manually it can be intalled in neutron-server
+container with pip:
.. code-block:: console
pip install "networking-hyperv>=4.0.0"
-For neutron_extension_drivers, ``port_security`` and ``qos`` are currently supported by the networking-hyperv
-mechanism driver. By default only ``port_security`` is set.
+For neutron_extension_drivers, ``port_security`` and ``qos`` are
+currently supported by the networking-hyperv mechanism driver.
+By default only ``port_security`` is set.
Verify Operations
diff --git a/doc/ironic-guide.rst b/doc/ironic-guide.rst
index 08ffcd824ec809cebe07d4f9394b7c83a64f6c6e..fd8b4e0a4a1ae783b134e77d9bbfdcd29d9c9110 100644
--- a/doc/ironic-guide.rst
+++ b/doc/ironic-guide.rst
@@ -29,7 +29,8 @@ Enable Ironic role in ``/etc/kolla/globals.yml``:
enable_ironic: "yes"
-Beside that an additional network type 'flat' has to be added to a list of tenant network types:
+Beside that an additional network type 'flat' has to be added to a list of
+tenant network types:
.. code-block:: console
diff --git a/doc/kolla-for-openstack-development.rst b/doc/kolla-for-openstack-development.rst
index 5fedac556d52358ad7b3314f3cd64d2a86f0689c..af2d1f9f1cdc04289e45785bcccf0368f0f7de26 100644
--- a/doc/kolla-for-openstack-development.rst
+++ b/doc/kolla-for-openstack-development.rst
@@ -22,7 +22,8 @@ Only source containers are supported.
Enabling Kolla "dev mode"
-------------------------
-To enable dev mode for all supported services, set in ``/etc/kolla/globals.yml``:
+To enable dev mode for all supported services, set in
+``/etc/kolla/globals.yml``:
::
diff --git a/doc/networking-guide.rst b/doc/networking-guide.rst
index e4db822f5ce1ade629a45ad5f4e55c996b7619cf..3add2e3562288e36807cdcf817ab46428d18bd69 100644
--- a/doc/networking-guide.rst
+++ b/doc/networking-guide.rst
@@ -3,14 +3,17 @@
============================
Enabling Provider Networks
============================
-Provider networks allow to connect compute instances directly to physical networks avoiding tunnels.
-This is necessary for example for some performance critical applications. Only administrators of
-OpenStack can create such networks. For provider networks compute hosts must have external bridge
-created and configured by Ansible tasks like it is already done for tenant DVR mode networking.
-Normal tenant non-DVR networking does not need external bridge on compute hosts and therefore
-operators don't need additional dedicated network interface.
-
-To enable provider networks modify the configuration file ``/etc/kolla/globals.yml``:
+Provider networks allow to connect compute instances directly to physical
+networks avoiding tunnels. This is necessary for example for some performance
+critical applications. Only administrators of OpenStack can create such
+networks. For provider networks compute hosts must have external bridge
+created and configured by Ansible tasks like it is already done for tenant
+DVR mode networking. Normal tenant non-DVR networking does not need external
+bridge on compute hosts and therefore operators don't need additional
+dedicated network interface.
+
+To enable provider networks modify the configuration
+file ``/etc/kolla/globals.yml``:
::
diff --git a/doc/operating-kolla.rst b/doc/operating-kolla.rst
index 3f796ec4151661a30674c18ba2978c4e0f0ba1f0..cc7e1883f0909e6c510dbae97e13707eabb275d3 100644
--- a/doc/operating-kolla.rst
+++ b/doc/operating-kolla.rst
@@ -79,8 +79,8 @@ triggered on the Docker host when the neutron-agents containers are launched.
This can be useful when you want to do a new clean deployment, particularly one
changing the network topology.
-``tools/cleanup-images --all`` is used to remove all Docker images built by Kolla
-from the local Docker cache.
+``tools/cleanup-images --all`` is used to remove all Docker images built by
+Kolla from the local Docker cache.
``kolla-ansible -i INVENTORY deploy`` is used to deploy and start all Kolla
containers..
@@ -103,13 +103,15 @@ tests.
.. note::
In order to do smoke tests, requires ``kolla_enable_sanity_checks=yes``.
-``kolla-mergepwd --old OLD_PASSWORDS --new NEW_PASSWORDS --final FINAL_PASSWORDS``
-is used to merge passwords from old installation with newly generated passwords
-during upgrade of Kolla release. The workflow is:
+``kolla-mergepwd --old OLD_PASSWDS --new NEW_PASSWDS --final FINAL_PASSWDS``
+is used to merge passwords from old installation with newly generated
+passwords during upgrade of Kolla release. The workflow is:
-- save old passwords from ``/etc/kolla/passwords.yml`` into ``passwords.yml.old``
-- generate new passwords via ``kolla-genpwd`` as ``passwords.yml.new``
-- merge ``passwords.yml.old`` and ``passwords.yml.new`` into ``/etc/kolla/passwords.yml``
+- Save old passwords from ``/etc/kolla/passwords.yml`` into
+ ``passwords.yml.old``
+- Generate new passwords via ``kolla-genpwd`` as ``passwords.yml.new``
+- Merge ``passwords.yml.old`` and ``passwords.yml.new`` into
+ ``/etc/kolla/passwords.yml``
For example::
diff --git a/setup.cfg b/setup.cfg
index ae6ffb7412f6062d8423c716a188e5d94143d7bc..79f441d888bb7bd44e85c9d5480e37701a3c3cc7 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -54,6 +54,7 @@ setup-hooks =
all_files = 1
build-dir = doc/build
source-dir = doc
+warning-is-error = 1
[build_releasenotes]
all_files = 1
diff --git a/tox.ini b/tox.ini
index 584d48171b176b22ce8b34ae22d93516ae45e8cc..254efcd5d66d2a42d7abf9dcef65db30e48457f4 100644
--- a/tox.ini
+++ b/tox.ini
@@ -44,6 +44,7 @@ commands = {posargs}
[testenv:docs]
commands =
+ rm -rf doc/build
doc8 doc
python setup.py build_sphinx