From bccb7dea8033703aeb533382730f875257dff564 Mon Sep 17 00:00:00 2001 From: Sean McGinnis Date: Mon, 18 Dec 2017 15:29:36 -0600 Subject: [PATCH] Add doc job requirements.txt We had previously installed our docs dependencies as extras in setup.cfg. Doc jobs are now changed to not install the project, so these dependencies are no longer being installed. With recent changes to the doc jobs, we need to specificy that python3 is used. Update the zuul config file for this. Change-Id: Ie925efefb1126dbe7fa0a9f0f1727da01f48c512 Depends-on: Ib882a4d09898ff206b36ac8aef840bee0748368e --- .zuul.yaml | 9 +++++++-- doc/requirements.txt | 6 ++++++ tox.ini | 5 ++++- 3 files changed, 17 insertions(+), 3 deletions(-) create mode 100644 doc/requirements.txt diff --git a/.zuul.yaml b/.zuul.yaml index 93b1401e37..d6419c8151 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -10,11 +10,16 @@ jobs: - openstack-tox-validate - releases-tox-list-changes - - build-openstack-sphinx-docs + - build-openstack-sphinx-docs: + vars: + sphinx_python: python3 + gate: jobs: - openstack-tox-validate - - build-openstack-sphinx-docs + - build-openstack-sphinx-docs: + vars: + sphinx_python: python3 release-post: jobs: - tag-releases diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000000..349c9e8bd1 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,6 @@ +# Packages required for building docs + +sphinx>=1.6.2 # BSD +oslosphinx>=4.7.0 # Apache-2.0 +sphinxcontrib.datatemplates>=0.1.0 # BSD License +icalendar>=3.10 # BSD diff --git a/tox.ini b/tox.ini index 6076eee349..0adce92868 100644 --- a/tox.ini +++ b/tox.ini @@ -59,8 +59,11 @@ commands = {toxinidir}/tools/build_tag_history.sh {toxinidir} #commands = python setup.py testr --coverage --testr-args='{posargs}' [testenv:docs] +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 -W -d doc/build/doctrees -b html doc/source doc/build/html -deps = .[sphinxext] [flake8] # E123, E125 skipped as they are invalid PEP-8.