Follow the new PTI for document build

For compliance with the Project Testing Interface as described in:
https://governance.openstack.org/tc/reference/project-testing-interface.html

For more detials information, please refer to:
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

Change-Id: Ic7dad29922af2efed2188f3215f364719f0e19ae
This commit is contained in:
melissaml 2018-03-27 10:30:27 +08:00
parent f1485b035b
commit 794dea3817
4 changed files with 15 additions and 15 deletions

6
doc/requirements.txt Normal file
View File

@ -0,0 +1,6 @@
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
sphinxcontrib-httpdomain>=1.3.0 # BSD
sphinxcontrib-blockdiag>=1.5.4 # BSD
reno>=2.5.0 # Apache-2.0
os-api-ref>=1.4.0 # Apache-2.0
openstackdocstheme>=1.18.1 # Apache-2.0

View File

@ -143,12 +143,6 @@ designate.notification.plugin =
default = designate.notifications:Default
audit = designate.notifications:Audit
[build_sphinx]
all_files = 1
build-dir = doc/build
source-dir = doc/source
warning-is-error = 1
[egg_info]
tag_build =
tag_date = 0

View File

@ -10,18 +10,12 @@ mock>=2.0.0 # BSD
os-testr>=1.0.0 # Apache-2.0
oslotest>=3.2.0 # Apache-2.0
requests-mock>=1.2.0 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
sphinxcontrib-httpdomain>=1.3.0 # BSD
testtools>=2.2.0 # MIT
sphinxcontrib-blockdiag>=1.5.4 # BSD
testrepository>=0.0.18 # Apache-2.0/BSD
testscenarios>=0.4 # Apache-2.0/BSD
WebTest>=2.0.27 # MIT
tempest>=17.1.0 # Apache-2.0
reno>=2.5.0 # Apache-2.0
# Bandit security code scanner
bandit>=1.1.0 # Apache-2.0
os-api-ref>=1.4.0 # Apache-2.0
zake>=0.1.6 # Apache-2.0
openstackdocstheme>=1.18.1 # Apache-2.0
doc8>=0.6.0 # Apache-2.0

12
tox.ini
View File

@ -38,9 +38,11 @@ commands =
ostestr '{posargs}'
[testenv:docs]
basepython = python2.7
commands = rm -rf doc/build
python setup.py build_sphinx
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
[testenv:cover]
commands =
@ -115,6 +117,10 @@ commands =
sphinx-build -E -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html
[testenv:releasenotes]
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 -a -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
[testenv:venv]