Treat warnings as errors in docs and fix warnings

This patch set fixes Promenade's failing documenation job (it
is currently issuing a number of warnings that should be treated
as errors):

/home/zuul/src/git.openstack.org/openstack/airship-promenade/doc/source/configuration/index.rst:10: WARNING: toctree contains reference to nonexisting document 'configuration/encryption-policy'
WARNING: autodoc: failed to import exception 'exceptions.ApiError' from module 'promenade'; the following exception was raised:
No module named 'falcon'

The first one indicates that the file has the wrong extension
and the second one that autodoc is failing to import something
(first case => rename file, second case => add requirement to
test-requirements.txt)

.. http://logs.openstack.org/18/605818/1/gate/airship-promenade-unit-py35/c733138/ara-report/

Change-Id: I974d5929aaac8a6e27d4196eed5f8bc97703e61d
This commit is contained in:
Felipe Monteiro 2018-10-04 15:21:56 +01:00
parent bd9a1b00ca
commit 9d1e27f040
3 changed files with 6 additions and 1 deletions

View File

@ -4,3 +4,8 @@ bandit>=1.5
yapf==0.24.0
sphinx>=1.6.2
sphinx_rtd_theme==0.2.4
# Imported when the source code is parsed for generating documentation:
# TODO(felipemonteiro): Move documentation-only requirements into
# doc/requirements.txt
falcon==1.2.0

View File

@ -36,7 +36,7 @@ deps =
-r{toxinidir}/test-requirements.txt
commands =
rm -rf doc/build
sphinx-build -b html doc/source doc/build
sphinx-build -W -b html doc/source doc/build
[testenv:fmt]
deps =