openstack/placement
Code Issues Proposed changes

Final warnings removals for api-ref

Browse Source 
This removes the final warnings from the api-ref code base, and flips
the sphinx switch to enforce warnings as errors.

It also adds code to the rest_parameters extension to make it more
clear where a problem is when it comes to included parameters. This
puts us in a place where we can start doing the file per file look at
content.

Part of bp:api-ref-in-rst

Change-Id: Ic2c99d96d6addcafa00b9f16785c2fe59b1798d3
This commit is contained in:
Sean Dague 2016-04-20 11:20:05 -04:00
parent 48d520233e
commit 2bda949735
1 changed files with 4 additions and 3 deletions

7
tox.ini

@ -86,12 +86,12 @@ commands = {posargs}
[testenv:docs] [testenv:docs]
commands = commands =
rm -rf doc/source/api doc/build api-guide/build rm -rf doc/source/api doc/build api-guide/build api-ref/build
python setup.py build_sphinx python setup.py build_sphinx
bash -c '! find doc/ -type f -name *.json | xargs -t -n1 python -m json.tool 2>&1 > /dev/null | grep -B1 -v ^python' bash -c '! find doc/ -type f -name *.json | xargs -t -n1 python -m json.tool 2>&1 > /dev/null | grep -B1 -v ^python'
oslo-config-generator --config-file=etc/nova/nova-config-generator.conf oslo-config-generator --config-file=etc/nova/nova-config-generator.conf
sphinx-build -W -b html api-guide/source api-guide/build/html sphinx-build -W -b html api-guide/source api-guide/build/html
sphinx-build -b html api-ref/source api-ref/build/html sphinx-build -W -b html api-ref/source api-ref/build/html
[testenv:api-guide] [testenv:api-guide]
# This environment is called from CI scripts to test and publish # This environment is called from CI scripts to test and publish
@ -115,7 +115,8 @@ commands =
# ignoring the duplicate stanzas warning. # ignoring the duplicate stanzas warning.
install_command = pip install -U --force-reinstall {opts} {packages} install_command = pip install -U --force-reinstall {opts} {packages}
commands = commands =
sphinx-build -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html rm -rf api-ref/build
sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html
[testenv:bandit] [testenv:bandit]
commands = bandit -c bandit.yaml -r nova -n 5 -ll commands = bandit -c bandit.yaml -r nova -n 5 -ll