Merge "Structure for simply managing placement-api-ref"

This commit is contained in:
Jenkins
2017-03-24 20:17:52 +00:00
committed by Gerrit Code Review
7 changed files with 389 additions and 1 deletions
+14 -1
View File
@@ -118,7 +118,7 @@ commands = {posargs}
# with python 3.x
basepython = python2.7
commands =
rm -rf doc/source/api doc/build api-guide/build api-ref/build
rm -rf doc/source/api doc/build api-guide/build api-ref/build placement-api-ref/build
python setup.py build_sphinx
# Check that all JSON files don't have \r\n in line.
bash -c "! find doc/ -type f -name *.json | xargs grep -U -n $'\r'"
@@ -130,6 +130,7 @@ commands =
oslopolicy-policy-generator --namespace nova --output-file etc/nova/policy.yaml.merged
sphinx-build -W -b html api-guide/source api-guide/build/html
sphinx-build -W -b html api-ref/source api-ref/build/html
sphinx-build -W -b html placement-api-ref/source placement-api-ref/build/html
[testenv:api-guide]
# This environment is called from CI scripts to test and publish
@@ -144,6 +145,18 @@ commands =
rm -rf api-ref/build
sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html
[testenv:placement-api-ref]
# This environment is called from CI scripts to test and publish
# the Placement API Ref to developer.openstack.org.
commands =
# Check that all placement api routes are in the documentation
# TODO(cdent): Get rid of the leading '-' after all the existing
# routes have been documented. It causes the non-zero exit code to
# ignored.
- python tools/placement_api_docs.py placement-api-ref/source/index.rst
rm -rf placement-api-ref/build
sphinx-build -W -b html -d placement-api-ref/build/doctrees placement-api-ref/source placement-api-ref/build/html
[testenv:bandit]
# NOTE(browne): This is required for the integration test job of the bandit
# project. Please do not remove.