Merge "Enable warning-is-error in doc build"

.gitignore

@@ -6,6 +6,7 @@ cover/
 covhtml/
 dist/
 doc/build
+doc/source/api/
 etc/*.sample
 *.DS_Store
 *.pyc

doc/source/index.rst

@@ -21,9 +21,10 @@ Testing and Usage Information:
    :maxdepth: 1
 
    devstack
+   API reference <api/modules>
 
-==================
+.. rubric:: Indices and tables
-Indices and tables
-==================
 
+* :ref:`genindex`
+* :ref:`modindex`
 * :ref:`search`

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 untrusted zones
-        - trusted to trusted 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

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 untrusted zones
-        - trusted to trusted 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

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
+autodoc_tree_index_modules = True
-warnerrors = True
+autodoc_tree_excludes =
+  setup.py
+  neutron_fwaas/tests