openstack/solum
Code Issues Proposed changes

Adding warning-is-error to doc building

Browse Source 
warning-is-error should be set for doc building. This change sets
the flag and corrects the warnings.

Change-Id: Ic7b007219c1351519b0d37567870c7477b239fa6
This commit is contained in:
zhurong 2017-08-18 13:29:46 +08:00
parent 9a3ea0675f
commit ede34099c7
2 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/source/conf.py
View File

@ -22,12 +22,15 @@ sys.path.insert(0, os.path.abspath('../..'))
extensions = [ extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.autodoc',
'sphinxcontrib.pecanwsme.rest', 'sphinxcontrib.pecanwsme.rest',
'sphinxcontrib.httpdomain',
'wsmeext.sphinxext', 'wsmeext.sphinxext',
'openstackdocstheme', 'openstackdocstheme',
] ]
wsme_protocols = ['restjson', 'restxml'] wsme_protocols = ['restjson', 'restxml']
suppress_warnings = ['app.add_directive']
# autodoc generation is a bit aggressive and a nuisance when doing heavy # autodoc generation is a bit aggressive and a nuisance when doing heavy
# 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

1
setup.cfg
View File

@ -26,6 +26,7 @@ packages =
source-dir = doc/source source-dir = doc/source
build-dir = doc/build build-dir = doc/build
all_files = 1 all_files = 1
warning-is-error = 1
[upload_sphinx] [upload_sphinx]
upload-dir = doc/build/html upload-dir = doc/build/html