From e82bb7f33049b68c4a9abe56d29f322b64ab20cc Mon Sep 17 00:00:00 2001 From: ricolin Date: Tue, 19 Dec 2017 15:16:32 +0800 Subject: [PATCH] Create doc/requirements.txt For compliance with the Project Testing Interface as described in: https://governance.openstack.org/tc/reference/project-testing-interface.html Refer to: http://lists.openstack.org/pipermail/openstack-dev/2017-November/124815.html Change-Id: Ifdfdaacad8574fcfcac9c1b52b0bed6fed4f8411 --- doc/requirements.txt | 9 +++++++++ test-requirements.txt | 4 ---- tox.ini | 10 ++++++---- 3 files changed, 15 insertions(+), 8 deletions(-) create mode 100644 doc/requirements.txt diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000000..4cd49fe936 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,9 @@ +# 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.18.1 # Apache-2.0 +os-api-ref>=1.4.0 # Apache-2.0 +sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD +reno>=2.5.0 # Apache-2.0 +sphinxcontrib-httpdomain>=1.3.0 # BSD diff --git a/test-requirements.txt b/test-requirements.txt index 5ed3f1c2ab..3f0e45a4ba 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -11,17 +11,13 @@ kombu!=4.0.2,>=4.0.0 # BSD mock>=2.0.0 # BSD mox3>=0.20.0 # Apache-2.0 PyMySQL>=0.7.6 # MIT License -openstackdocstheme>=1.18.1 # Apache-2.0 -os-api-ref>=1.4.0 # Apache-2.0 os-testr>=1.0.0 # Apache-2.0 oslotest>=3.2.0 # Apache-2.0 qpid-python>=0.26;python_version=='2.7' # Apache-2.0 psycopg2>=2.6.2 # LGPL/ZPL -sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD testrepository>=0.0.18 # Apache-2.0/BSD testscenarios>=0.4 # Apache-2.0/BSD testtools>=2.2.0 # MIT testresources>=2.0.0 # Apache-2.0/BSD -reno>=2.5.0 # Apache-2.0 # Next are used in integration tests only tempest>=17.1.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index be0da0a0ab..bf5ce0c9a4 100644 --- a/tox.ini +++ b/tox.ini @@ -61,14 +61,15 @@ commands = coverage report [testenv:docs] -deps = -r{toxinidir}/requirements.txt - -r{toxinidir}/test-requirements.txt - sphinxcontrib-httpdomain -commands = python setup.py build_sphinx +deps = -r{toxinidir}/doc/requirements.txt +commands = + rm -rf doc/build + sphinx-build -b html doc/source doc/build/html [testenv:api-ref] # This environment is called from CI scripts to test and publish # the API Ref to developer.openstack.org. +deps = -r{toxinidir}/doc/requirements.txt whitelist_externals = bash rm commands = @@ -114,4 +115,5 @@ local-check-factory = heat.hacking.checks.factory commands = oslo_debug_helper {posargs} [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