Browse Source

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
Akihiro Motoki 1 year ago
parent
commit
8629b628cb
2 changed files with 2 additions and 3 deletions
  1. 1
    0
      doc/source/conf.py
  2. 1
    3
      setup.cfg

+ 1
- 0
doc/source/conf.py View File

@@ -22,6 +22,7 @@ sys.path.insert(0, os.path.abspath('../..'))
22 22
 extensions = [
23 23
     'sphinx.ext.autodoc',
24 24
     'sphinx.ext.doctest',
25
+    'sphinx.ext.napoleon',
25 26
     'openstackdocstheme',
26 27
 ]
27 28
 

+ 1
- 3
setup.cfg View File

@@ -26,6 +26,7 @@ packages =
26 26
 source-dir = doc/source
27 27
 build-dir = doc/build
28 28
 all_files = 1
29
+warning-is-error = 1
29 30
 
30 31
 [upload_sphinx]
31 32
 upload-dir = doc/build/html
@@ -34,9 +35,6 @@ upload-dir = doc/build/html
34 35
 directory = futurist/locale
35 36
 domain = futurist
36 37
 
37
-[pbr]
38
-warnerrors = True
39
-
40 38
 [wheel]
41 39
 universal = 1
42 40
 

Loading…
Cancel
Save