Follow the new PTI for document build

For compliance with the Project Testing Interface [1] as described in
[2].

[1]
https://governance.openstack.org/tc/reference/project-testing-interface.html
[2]
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

Change-Id: I03d36b2545f69c4ca3ca1ced73d179e81b7b8811
This commit is contained in:
Mark Goddard 2018-03-15 16:28:02 +00:00
parent 7bdee9a21c
commit dbc1f26848
4 changed files with 12 additions and 14 deletions

1
doc/requirements.txt Normal file
View File

@ -0,0 +1 @@
sphinx>=1.5.1 # BSD

View File

@ -66,12 +66,3 @@ kayobe.cli=
seed_service_deploy = kayobe.cli.commands:SeedServiceDeploy
seed_vm_deprovision = kayobe.cli.commands:SeedVMDeprovision
seed_vm_provision = kayobe.cli.commands:SeedVMProvision
[build_sphinx]
all-files = 1
warning-is-error = 1
source-dir = doc/source
build-dir = doc/build
[upload_sphinx]
upload-dir = doc/build/html

View File

@ -10,5 +10,6 @@ docker<3 # Apache-2.0
hacking>=0.12.0,<0.13 # Apache-2.0
molecule<3 # MIT
oslotest>=1.10.0 # Apache-2.0
# NOTE(mgoddard): This is required by tools/sphinx8.
sphinx>=1.5.1 # BSD
stestr # Apache-2.0

15
tox.ini
View File

@ -5,7 +5,7 @@ skipsdist = True
[testenv]
usedevelop = True
install_command = pip install -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt?h=stable/pike} {opts} {packages}
install_command = pip install {opts} {packages}
passenv =
HOME
whitelist_externals =
@ -16,7 +16,10 @@ setenv =
OS_STDOUT_CAPTURE=1
OS_STDERR_CAPTURE=1
OS_TEST_TIMEOUT=60
deps = -r{toxinidir}/test-requirements.txt
deps =
-c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt?h=stable/pike}
-r{toxinidir}/requirements.txt
-r{toxinidir}/test-requirements.txt
commands = stestr run {posargs}
[testenv:pep8]
@ -36,7 +39,6 @@ usedevelop = True
# Create the virtualenv with access to system site packages, as this is
# required to use the python and apt modules, which are not available via PyPI.
sitepackages = True
install_command = pip install -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt?h=stable/pike} {opts} {packages}
commands =
# Install ansible role dependencies from Galaxy.
ansible-galaxy install \
@ -45,7 +47,6 @@ commands =
{toxinidir}/tools/test-ansible.sh {posargs}
[testenv:molecule]
install_command = pip install -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt?h=stable/pike} {opts} {packages}
commands =
# Install ansible role dependencies from Galaxy.
ansible-galaxy install \
@ -89,7 +90,11 @@ commands =
coverage xml -o cover/coverage.xml
[testenv:docs]
commands = python setup.py build_sphinx
deps =
-c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt?h=stable/pike}
-r{toxinidir}/requirements.txt
-r{toxinidir}/doc/requirements.txt
commands = sphinx-build -b html doc/source doc/build/html
[testenv:debug]
commands = oslo_debug_helper {posargs}