doc: enable warning-is-error and fix warnings

A small workaround is required for a specific parameter (see the
inline comment).

Change-Id: I1eac60cc8ca89a12dd568f5a12f70fdab9b76b62
This commit is contained in:
Luigi Toscano 2017-07-13 18:44:26 +02:00
parent df536ba753
commit 76f056899c
3 changed files with 6 additions and 3 deletions

View File

@ -142,7 +142,7 @@ html_title = 'Sahara Client'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.

View File

@ -48,9 +48,11 @@ class ImageManager(base.ResourceManager):
def update_tags(self, image_id, new_tags):
"""Update an Image tags.
:param list new_tags: list of tags that will replace currently
assigned tags
:param new_tags: list of tags that will replace currently
assigned tags
"""
# Do not add :param list in the docstring above until this is solved:
# https://github.com/sphinx-doc/sphinx/issues/2549
old_image = self.get(image_id)
old_tags = frozenset(old_image.tags)

View File

@ -96,6 +96,7 @@ openstack.data_processing.v1 =
all_files = 1
build-dir = doc/build
source-dir = doc/source
warning-is-error = 1
[wheel]
universal = 1