Browse Source

Remove pbr warnerrors in favor of sphinx check

This change removes the now unused "warnerrors" setting,
which is replaced by "warning-is-error" in sphinx
releases >= 1.5[0]. This also fixes any warnings
that came up when testing with the latest version
of sphinx:

- Redundant loading of todo extension
- Empty man_pages config value

Also updated the requirements for pbr and sphinx to the latest
version(s) in requirements.txt

With this change, any doc warnings will cause the build to fail
[0] http://lists.openstack.org/pipermail/openstack-dev/2017-March/113085.html

Change-Id: Id828161e866da6766d88ce553a3c5ea2593b8f84
bhavani.cr 1 year ago
parent
commit
e635f29965
3 changed files with 4 additions and 6 deletions
  1. 0
    4
      doc/source/conf.py
  2. 2
    2
      requirements.txt
  3. 2
    0
      setup.cfg

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

@@ -28,7 +28,6 @@ import os
28 28
 # Add any Sphinx extension module names here, as strings. They can be extensions
29 29
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
30 30
 extensions = ['sphinx.ext.autodoc',
31
-              'sphinx.ext.todo',
32 31
               'sphinx.ext.viewcode',
33 32
               'oslosphinx',
34 33
               'yasfb',
@@ -93,9 +92,6 @@ pygments_style = 'sphinx'
93 92
 # A list of ignored prefixes for module index sorting.
94 93
 modindex_common_prefix = ['mogan-specs.']
95 94
 
96
-# -- Options for man page output ----------------------------------------------
97
-man_pages = []
98
-
99 95
 # -- Options for HTML output ---------------------------------------------------
100 96
 
101 97
 # The theme to use for HTML and HTML Help pages.  See the documentation for

+ 2
- 2
requirements.txt View File

@@ -1,6 +1,6 @@
1 1
 oslosphinx>=2.2.0.0a2
2
-pbr>=0.6,!=0.7,<1.0
3
-sphinx>=1.1.2,<1.2
2
+pbr>=2.0.0,!=2.1.0
3
+sphinx>=1.5.1,!=1.6.1
4 4
 testrepository>=0.0.18
5 5
 testtools>=0.9.34
6 6
 yasfb>=0.5.1

+ 2
- 0
setup.cfg View File

@@ -15,6 +15,8 @@ classifier =
15 15
 source-dir = doc/source
16 16
 build-dir = doc/build
17 17
 all_files = 1
18
+builders = html
19
+warning-is-error = 1
18 20
 
19 21
 [pbr]
20 22
 warnerrors = True

Loading…
Cancel
Save