turn on warning-is-error in doc build
sphinx.ext.napoleon is a preprocessor which converts Google style docstring into ReST style. This is required to avoid sphinx warnings. warnerrors = True in [pbr] section is no longer needed in favor of warning-is-error in sphinx. Change-Id: If4a7adfae5dab3313bb54ad465a75290476b7154
This commit is contained in:
parent
e1bcf9dff1
commit
8629b628cb
|
@ -22,6 +22,7 @@ sys.path.insert(0, os.path.abspath('../..'))
|
||||||
extensions = [
|
extensions = [
|
||||||
'sphinx.ext.autodoc',
|
'sphinx.ext.autodoc',
|
||||||
'sphinx.ext.doctest',
|
'sphinx.ext.doctest',
|
||||||
|
'sphinx.ext.napoleon',
|
||||||
'openstackdocstheme',
|
'openstackdocstheme',
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
|
@ -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
|
||||||
|
@ -34,9 +35,6 @@ upload-dir = doc/build/html
|
||||||
directory = futurist/locale
|
directory = futurist/locale
|
||||||
domain = futurist
|
domain = futurist
|
||||||
|
|
||||||
[pbr]
|
|
||||||
warnerrors = True
|
|
||||||
|
|
||||||
[wheel]
|
[wheel]
|
||||||
universal = 1
|
universal = 1
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue