diff options
| author | Julia Kreger <juliaashleykreger@gmail.com> | 2018-07-11 12:36:06 -0700 |
|---|---|---|
| committer | Julia Kreger <juliaashleykreger@gmail.com> | 2018-07-18 07:02:33 -0700 |
| commit | 3530316882ef63f05eaf61025ecd796ab41f9a98 (patch) | |
| tree | 4573e3a924d8f58b8f1eead687f53e7c9c97b54a /tox.ini | |
| parent | 52bdfd32df52a460d5c4c6e34e26e7d46aa9df4b (diff) | |
| download | ironic-3530316882ef63f05eaf61025ecd796ab41f9a98.tar.gz | |
Don't handle warnings as errors
At some point between changes to the doc builds in the
gates and local doc builds, warnings were no longer being
treated as errors. In that time, multiple changes have occured
with sphinx and related tooling that results in errors being
generatd out of the results from autodoc, as our program model
uses classes which are inherited in various modules and that
contain docstrings.
Due to dulicate method names in the api automatic doc genration
we raise a warning. Guidence from the error is to add :noindex:
to one of the duplicates to suppress the error, however those
text entries in the index are being autogenerated, so that is
not an option.
Since there seems to be no simple path to take to remedy this,
removing the -W flag from the docs build to enable developers
to simply execute `tox` to test their changes
Story: 2003020
Change-Id: I4ae8dee9a624781b231659fb24c5c4d53353da3f
Diffstat (limited to 'tox.ini')
| -rw-r--r-- | tox.ini | 4 |
1 files changed, 3 insertions, 1 deletions
@@ -87,7 +87,9 @@ deps = -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} -r{toxinidir}/requirements.txt -r{toxinidir}/doc/requirements.txt -commands = sphinx-build -W -b html doc/source doc/build/html +# FIXME(TheJulia): we need to add the -W flag back at some point to this command. +# See story https://storyboard.openstack.org/#!/story/2003020 +commands = sphinx-build -b html doc/source doc/build/html [testenv:api-ref] basepython = python3 |