summaryrefslogtreecommitdiff
path: root/setup.cfg
diff options
context:
space:
mode:
authorAndreas Jaeger <aj@suse.com>2017-03-04 19:11:26 +0100
committerAndreas Jaeger <aj@suse.com>2017-03-08 08:22:24 +0100
commit4cff2ab6d56b01431d52a067aa415d3d0f14f404 (patch)
tree30efe79c2f1a8c28fcb2bb3de27f41f5ca2baf0d /setup.cfg
parent2751ab9b81499b653991afeade9851edb7e7eb47 (diff)
downloadironic-4cff2ab6d56b01431d52a067aa415d3d0f14f404.tar.gz
Use Sphinx 1.5 warning-is-error
With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as errors is setting warning-is-error in build_sphinx section. Migrate the setting from the old warnerrors one. Fix problems found: * Duplicate labels (rename wrong faq entries, rename unused drivers entries) * Add api/autoindex.rst as hidden to the index so that we do not get a warning. The modindex includes the same content, so no need to show this. * Add releasenotes/index.rst, webapi/v1.rst, user-guide, and install-guide.rst to hidden index since they're not listed in index on purpose, so sphinx will not warn that they do not appear in a toc * Add deploy/radosgw to index * ignore app.add_directiv warning * Fix reference to user-guide to use proper markup so that Sphinx knows the user-guide is referenced. Change-Id: I00d249229d4d31ba36d4393d60847fdb1513a744
Diffstat (limited to 'setup.cfg')
-rw-r--r--setup.cfg2
1 files changed, 1 insertions, 1 deletions
diff --git a/setup.cfg b/setup.cfg
index eba73c353..587110225 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -153,12 +153,12 @@ autodoc_exclude_modules =
ironic.db.sqlalchemy.alembic.env
ironic.db.sqlalchemy.alembic.versions.*
ironic_tempest_plugin.*
-warnerrors = True
[build_sphinx]
all_files = 1
build-dir = doc/build
source-dir = doc/source
+warning-is-error = 1
[egg_info]
tag_build =