diff options
| author | Doug Hellmann <doug@doughellmann.com> | 2017-06-15 16:58:36 -0400 |
|---|---|---|
| committer | Doug Hellmann <doug@doughellmann.com> | 2017-06-28 12:25:32 -0400 |
| commit | c859380718e24b95ad48d635d686ee0c57fb90f1 (patch) | |
| tree | 2b0d76721500c3300552066fe415870c7febda68 | |
| parent | 4565e2bf4514782d2b32bfff447875ed6b68058e (diff) | |
| download | python-glanceclient-c859380718e24b95ad48d635d686ee0c57fb90f1.tar.gz | |
turn on warning-is-error in sphinx build
Fix a formatting error in one docstring and turn on the flag to ensure
that future warnings in the doc build trigger a build failure.
Change-Id: I7159b985d1690a8ae61ff885408da4623c105952
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
| -rw-r--r-- | doc/source/index.rst | 2 | ||||
| -rw-r--r-- | glanceclient/common/utils.py | 2 | ||||
| -rw-r--r-- | setup.cfg | 1 |
3 files changed, 3 insertions, 2 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst index 1be7eff..43ee57f 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -3,7 +3,7 @@ ============================================== This is a client for the OpenStack Images API. There's :doc:`a Python -API <library/api/index>` (the :mod:`glanceclient` module) and a +API <reference/api/index>` (the :mod:`glanceclient` module) and a :doc:`command-line script <cli/glance>` (installed as :program:`glance`). diff --git a/glanceclient/common/utils.py b/glanceclient/common/utils.py index cc3387c..d194e65 100644 --- a/glanceclient/common/utils.py +++ b/glanceclient/common/utils.py @@ -311,7 +311,7 @@ def get_file_size(file_obj): """Analyze file-like object and attempt to determine its size. :param file_obj: file-like object. - :retval The file's size or None if it cannot be determined. + :retval: The file's size or None if it cannot be determined. """ if (hasattr(file_obj, 'seek') and hasattr(file_obj, 'tell') and (six.PY2 or six.PY3 and file_obj.seekable())): @@ -36,6 +36,7 @@ console_scripts = [build_sphinx] builders = html,man all-files = 1 +warning-is-error = 1 source-dir = doc/source build-dir = doc/build |