From 1394771fcc35ab4680290e19f04843bea9d6a7fe Mon Sep 17 00:00:00 2001
From: Jay Faulkner <jay@jvf.cc>
Date: Thu, 2 Apr 2015 12:49:40 -0700
Subject: [PATCH] Error doc builds on WARN or ERROR

This will ensure that any new commits to IPA won't pass a docs job if
they introduce improperly formatted doc strings. This will enable us to
ensure our generated documentation remains of a high quality.

I will be following this up with a change to project-config to have IPA
run the docs job on every change.

Change-Id: I90236225623298a7070db1ff22acb44dddb1c520
---
 setup.cfg | 1 +
 1 file changed, 1 insertion(+)

diff --git a/setup.cfg b/setup.cfg
index 108044490..69ecdba5b 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -31,6 +31,7 @@ ironic_python_agent.hardware_managers =
 
 [pbr]
 autodoc_index_modules = True
+warnerrors = True
 
 [build_sphinx]
 all_files = 1