Create doc/requirements.txt

This change migrates the docs building requirements in order to meet
the compliance with the Project Testing Interface[0]. See [1] for
more details.

[0] https://governance.openstack.org/tc/reference/project-testing-interface.html#documentation
[1] http://lists.openstack.org/pipermail/openstack-dev/2017-November/124815.html

Change-Id: I8e31da06b946d18a760bc59b6fee63db25eebdc5
This commit is contained in:
Gage Hugo 2017-12-19 10:54:27 -06:00
parent 03b390b59b
commit 13e80ac52c
3 changed files with 9 additions and 3 deletions

7
doc/requirements.txt Normal file
View File

@ -0,0 +1,7 @@
# The order of packages is significant, because pip processes them in the order
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
openstackdocstheme>=1.17.0 # Apache-2.0
sphinx>=1.6.2 # BSD
reno>=2.5.0 # Apache-2.0
oslosphinx>=4.7.0 # Apache-2.0

View File

@ -10,9 +10,6 @@ testscenarios>=0.4 # Apache-2.0/BSD
testtools>=2.2.0 # MIT
oslotest>=1.10.0 # Apache-2.0
sphinx>=1.6.2 # BSD
oslosphinx>=4.7.0 # Apache-2.0
beautifulsoup4>=4.6.0 # MIT
reno>=2.5.0 # Apache-2.0
pylint==1.4.5 # GPLv2

View File

@ -69,6 +69,7 @@ whitelist_externals = bash
commands = bash scripts/integration-test.sh {posargs}
[testenv:docs]
deps = -r{toxinidir}/doc/requirements.txt
commands=
python setup.py build_sphinx
@ -80,6 +81,7 @@ exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build,releasenotes
enable-extensions = H106,H203
[testenv:releasenotes]
deps = -r{toxinidir}/doc/requirements.txt
commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
[testenv:pylint]