opendev/storyboard
Code Issues Proposed changes

suppress warnings from wsmeext.sphinxext

Browse Source 
When the wsmeext.sphinxext extension is initialized during the
documentation build it registers some autodoc classes that use the
same objtype as built-in types. This causes the associated directives
to be overridden, which emits a warning. That warning prevents us from
turning on warning-is-error in the build. Since there is nothing we
can do about it, we want to ignore it.

Change-Id: Ie74174176d6140467c60ea864dc2df4dc2287604
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This commit is contained in:
Doug Hellmann 2018-01-17 13:33:06 -05:00
parent 5b77f08c21
commit 833fdea9e5
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/source/conf.py
View File

@ -36,6 +36,11 @@ wsme_protocols = ['restjson', 'restxml']
# text edit cycles. # text edit cycles.
# execute "export SPHINX_DEBUG=1" in your terminal to disable # execute "export SPHINX_DEBUG=1" in your terminal to disable
# Ignore the following warning: WARNING: while setting up extension
# wsmeext.sphinxext: directive 'autoattribute' is already registered,
# it will be overridden.
suppress_warnings = ['app.add_directive']
# The suffix of source filenames. # The suffix of source filenames.
source_suffix = '.rst' source_suffix = '.rst'