openstack/nova
Code Issues Proposed changes

docs - Set pbr 'warnerrors' option for doc build

Browse Source 
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
This commit is contained in:
Davanum Srinivas 2014-08-01 10:36:28 -04:00 committed by Davanum Srinivas (dims)
parent a3d274303e
commit a507d42cf5
3 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/conf.py
View File

@ -194,7 +194,7 @@ man_pages = [
# Add any paths that contain custom static files (such as style sheets) here, # 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, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # 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, # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format. # using the given strftime format.

1
doc/source/index.rst
View File

@ -48,6 +48,7 @@ Developer Docs
devref/index devref/index
man/index man/index
api/autoindex
API Extensions API Extensions
============== ==============

1
setup.cfg
View File

@ -166,3 +166,4 @@ universal = 1
[pbr] [pbr]
autodoc_index_modules = 1 autodoc_index_modules = 1
warnerrors = true