From fe7cd58a5df17852310d9623d890953d670eb349 Mon Sep 17 00:00:00 2001
From: Akihiro Motoki <amotoki@gmail.com>
Date: Wed, 5 Jul 2017 04:52:49 +0900
Subject: [PATCH] Enable warning-is-error in doc build

Clean up python build warnings to enable warning-is-error.
Part of doc-migration work

Change-Id: Iee76a112945a3619de41000e5022eaba195b96c0
---
 .gitignore                                               | 1 +
 doc/source/index.rst                                     | 7 ++++---
 neutron_fwaas/services/firewall/drivers/fwaas_base.py    | 7 ++++---
 neutron_fwaas/services/firewall/drivers/fwaas_base_v2.py | 7 ++++---
 setup.cfg                                                | 7 +++++--
 5 files changed, 18 insertions(+), 11 deletions(-)

diff --git a/.gitignore b/.gitignore
index 71062c5df..2cb11fe9d 100644
--- a/.gitignore
+++ b/.gitignore
@@ -6,6 +6,7 @@ cover/
 covhtml/
 dist/
 doc/build
+doc/source/api/
 etc/*.sample
 *.DS_Store
 *.pyc
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 8bdb9be17..e9d552234 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -21,9 +21,10 @@ Testing and Usage Information:
    :maxdepth: 1
 
    devstack
+   API reference <api/modules>
 
-==================
-Indices and tables
-==================
+.. rubric:: Indices and tables
 
+* :ref:`genindex`
+* :ref:`modindex`
 * :ref:`search`
diff --git a/neutron_fwaas/services/firewall/drivers/fwaas_base.py b/neutron_fwaas/services/firewall/drivers/fwaas_base.py
index 3ec22ecf0..da8cf3006 100644
--- a/neutron_fwaas/services/firewall/drivers/fwaas_base.py
+++ b/neutron_fwaas/services/firewall/drivers/fwaas_base.py
@@ -37,9 +37,10 @@ class FwaasDriverBase(object):
     The policy is applied on traffic ingressing/egressing interfaces on
     the trusted zone. This implies that policy will be applied for traffic
     passing from
-        - trusted to untrusted zones
-        - untrusted to trusted zones
-        - trusted to trusted zones
+
+    - trusted to untrusted zones
+    - untrusted to trusted zones
+    - trusted to trusted zones
 
     Policy WILL NOT be applied for traffic from untrusted to untrusted zones.
     This is not a problem in Havana release as there is only one interface
diff --git a/neutron_fwaas/services/firewall/drivers/fwaas_base_v2.py b/neutron_fwaas/services/firewall/drivers/fwaas_base_v2.py
index ee60d7e89..b50538b64 100644
--- a/neutron_fwaas/services/firewall/drivers/fwaas_base_v2.py
+++ b/neutron_fwaas/services/firewall/drivers/fwaas_base_v2.py
@@ -37,9 +37,10 @@ class FwaasDriverBase(object):
     The policy is applied on traffic ingressing/egressing interfaces on
     the trusted zone. This implies that policy will be applied for traffic
     passing from
-        - trusted to untrusted zones
-        - untrusted to trusted zones
-        - trusted to trusted zones
+
+    - trusted to untrusted zones
+    - untrusted to trusted zones
+    - trusted to trusted zones
 
     Policy WILL NOT be applied for traffic from untrusted to untrusted zones.
     This is not a problem in Havana release as there is only one interface
diff --git a/setup.cfg b/setup.cfg
index 72645962c..ce32f6271 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -59,6 +59,7 @@ neutron_fwaas.services.firewall.drivers.linux =
 all_files = 1
 build-dir = doc/build
 source-dir = doc/source
+warning-is-error = 1
 
 [extract_messages]
 keywords = _ gettext ngettext l_ lazy_gettext
@@ -78,5 +79,7 @@ input_file = neutron_fwaas/locale/neutron_fwaas.pot
 universal = 1
 
 [pbr]
-autodoc_index_modules = True
-warnerrors = True
+autodoc_tree_index_modules = True
+autodoc_tree_excludes =
+  setup.py
+  neutron_fwaas/tests