From a507d42cf5d9912c2b3622e84afb8b7d3278595b Mon Sep 17 00:00:00 2001 From: Davanum Srinivas Date: Fri, 1 Aug 2014 10:36:28 -0400 Subject: [PATCH] docs - Set pbr 'warnerrors' option for doc build By setting this pbr option in setup.cfg, the doc build will fail in case of any warnings or errors occur during the build process. Closes-Bug: #1351350 Change-Id: Id4858062d2aaa4c2fe5b597e40e4e8947f544a4d --- doc/source/conf.py | 2 +- doc/source/index.rst | 1 + setup.cfg | 1 + 3 files changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 83723a24abed..f83589a895ce 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -194,7 +194,7 @@ man_pages = [ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +#html_static_path = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. diff --git a/doc/source/index.rst b/doc/source/index.rst index 37fcb48b88f7..123506fb09e3 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -48,6 +48,7 @@ Developer Docs devref/index man/index + api/autoindex API Extensions ============== diff --git a/setup.cfg b/setup.cfg index 20c9399e1bd8..46b34e46c1c0 100644 --- a/setup.cfg +++ b/setup.cfg @@ -166,3 +166,4 @@ universal = 1 [pbr] autodoc_index_modules = 1 +warnerrors = true