openstack/keystoneauth
Code Issues Proposed changes

Uncomment warning-is-error for doc building

Browse Source 
Now that the latest version of pbr supports handling a
ChangeLog that can contain invalid characters, this
setting should be uncommented in order to support
strict documentation formatting.

This will cause any docs build warnings to be treated as
as errors and fail.

Change-Id: I22d631550f0dbb6e0efcfd875a24dcd278fa1d03
This commit is contained in:
Gage Hugo
2017-04-25 07:59:24 -05:00
parent 1abfa7c843
commit 1859a7f2ee
1 changed files with 1 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
setup.cfg
View File

@@ -59,13 +59,7 @@ keystoneauth1.plugin =
source-dir = doc/source
build-dir = doc/build
all_files = 1
# NOTE(gagehugo): Sphinx currently reads the Changelog in order
# to create the appropriate page, and this causes warnings to be thrown
# which causes the below setting to treat them as errors and fail.
# Once change 439897 merges (or something else is
# done to fix this issue) the below setting can be uncommented
# to allow sphinx warnings to be considered errors.
#warning-is-error = 1
warning-is-error = 1
[pbr]
autodoc_tree_index_modules = True