summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorColleen Murphy <colleen@gazlene.net>2017-12-19 22:14:10 +0100
committerColleen Murphy <colleen@gazlene.net>2018-07-19 20:38:29 +0200
commit2ea36322d62aba04ee36ae6c07e85b123ea7fd04 (patch)
treefd359445bcc62619a5a0e6b493e5558aa1165a87
parent69aed2693475797c8d0dda2725a790eea05a9419 (diff)
Fix docs buildsstable/pike
This is a squash of two commits, which is required to fix two separate issues on the stable/pike branch. First: Fix docs builds With the new way of generating docs in the gate[1] our autodoc builds are slightly broken. Put the required dependencies for doc building and autodoc generation into doc/requirements.txt. We can also now remove docs-related requirements from test-requirements.txt. [1] http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html (cherry picked from commit ba9c1a3bec7b7c06dfbb3392b56f789752696a66) Second: Fix the doc CI failure CI job now uses pip >= 10.0.0 to install the package. In pip >= 10.0.0, if the package name is missing, the command "pip install -U" returns error, but in pip < 10.0.0 it just logs warning. So this patch make sure the package name exists first. (cherry picked from commit ad10c32a89b770c08e8c21f65d2ddc961e1e6d48) Co-authored-by: wangxiyuan <wangxiyuan@huawei.com> Change-Id: Ifbd16fe364bb216821125c70bb7d3ab0ac1f10a3
Notes
Notes (review): Code-Review+1: Gage Hugo <gagehugo@gmail.com> Code-Review+1: Samuel de Medeiros Queiroz <samueldmq@gmail.com> Code-Review+2: Morgan Fainberg <morgan.fainberg@gmail.com> Workflow+1: Morgan Fainberg <morgan.fainberg@gmail.com> Code-Review+2: Lance Bragstad <lbragstad@gmail.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Thu, 19 Jul 2018 22:40:38 +0000 Reviewed-on: https://review.openstack.org/546643 Project: openstack/keystonemiddleware Branch: refs/heads/stable/pike
-rw-r--r--doc/requirements.txt18
-rw-r--r--test-requirements.txt3
-rwxr-xr-xtools/tox_install.sh4
-rw-r--r--tox.ini2
4 files changed, 23 insertions, 4 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt
new file mode 100644
index 0000000..53fca8c
--- /dev/null
+++ b/doc/requirements.txt
@@ -0,0 +1,18 @@
1# The order of packages is significant, because pip processes them in the order
2# of appearance. Changing the order has an impact on the overall integration
3# process, which may cause wedges in the gate later.
4
5# For generating sphinx documentation
6doc8>=0.6.0 # Apache-2.0
7openstackdocstheme>=1.17.0 # Apache-2.0
8reno>=2.5.0 # Apache-2.0
9sphinx>=1.6.2 # BSD
10
11# For autodoc builds
12mock>=2.0.0 # BSD
13oslotest>=1.10.0 # Apache-2.0
14requests-mock>=1.1.0 # Apache-2.0
15testresources>=2.0.0 # Apache-2.0/BSD
16python-memcached>=1.56 # PSF
17WebTest>=2.0.27 # MIT
18oslo.messaging>=5.29.0 # Apache-2.0
diff --git a/test-requirements.txt b/test-requirements.txt
index 739a411..e35cb13 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -7,14 +7,11 @@ flake8-docstrings==0.2.1.post1 # MIT
7 7
8coverage!=4.4,>=4.0 # Apache-2.0 8coverage!=4.4,>=4.0 # Apache-2.0
9cryptography!=2.0,>=1.6 # BSD/Apache-2.0 9cryptography!=2.0,>=1.6 # BSD/Apache-2.0
10docutils>=0.11 # OSI-Approved Open Source, Public Domain
11fixtures>=3.0.0 # Apache-2.0/BSD 10fixtures>=3.0.0 # Apache-2.0/BSD
12mock>=2.0 # BSD 11mock>=2.0 # BSD
13openstackdocstheme>=1.16.0 # Apache-2.0
14oslotest>=1.10.0 # Apache-2.0 12oslotest>=1.10.0 # Apache-2.0
15reno!=2.3.1,>=1.8.0 # Apache-2.0 13reno!=2.3.1,>=1.8.0 # Apache-2.0
16requests-mock>=1.1 # Apache-2.0 14requests-mock>=1.1 # Apache-2.0
17sphinx>=1.6.2 # BSD
18stevedore>=1.20.0 # Apache-2.0 15stevedore>=1.20.0 # Apache-2.0
19testrepository>=0.0.18 # Apache-2.0/BSD 16testrepository>=0.0.18 # Apache-2.0/BSD
20testresources>=0.2.4 # Apache-2.0/BSD 17testresources>=0.2.4 # Apache-2.0/BSD
diff --git a/tools/tox_install.sh b/tools/tox_install.sh
index e61b63a..f3423d9 100755
--- a/tools/tox_install.sh
+++ b/tools/tox_install.sh
@@ -26,5 +26,7 @@ pip install -c"$localfile" openstack-requirements
26# install will be constrained and we need to unconstrain it. 26# install will be constrained and we need to unconstrain it.
27edit-constraints "$localfile" -- "$CLIENT_NAME" 27edit-constraints "$localfile" -- "$CLIENT_NAME"
28 28
29pip install -c"$localfile" -U "$@" 29if [[ -n "$@" ]]; then
30 pip install -c"$localfile" -U "$@"
31fi
30exit $? 32exit $?
diff --git a/tox.ini b/tox.ini
index 6eb7341..1dd8f8c 100644
--- a/tox.ini
+++ b/tox.ini
@@ -50,10 +50,12 @@ show-source = True
50exclude = .venv,.tox,dist,doc,*egg,build 50exclude = .venv,.tox,dist,doc,*egg,build
51 51
52[testenv:docs] 52[testenv:docs]
53deps = -r{toxinidir}/doc/requirements.txt
53commands= 54commands=
54 python setup.py build_sphinx 55 python setup.py build_sphinx
55 56
56[testenv:releasenotes] 57[testenv:releasenotes]
58deps = -r{toxinidir}/doc/requirements.txt
57commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html 59commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
58 60
59[hacking] 61[hacking]