From ba9c1a3bec7b7c06dfbb3392b56f789752696a66 Mon Sep 17 00:00:00 2001 From: Colleen Murphy Date: Tue, 19 Dec 2017 22:14:10 +0100 Subject: [PATCH] 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 Change-Id: Ifbd16fe364bb216821125c70bb7d3ab0ac1f10a3 --- doc/requirements.txt | 18 ++++++++++++++++++ test-requirements.txt | 4 ---- tox.ini | 2 ++ 3 files changed, 20 insertions(+), 4 deletions(-) create mode 100644 doc/requirements.txt diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 00000000..53fca8c6 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,18 @@ +# 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. + +# For generating sphinx documentation +doc8>=0.6.0 # Apache-2.0 +openstackdocstheme>=1.17.0 # Apache-2.0 +reno>=2.5.0 # Apache-2.0 +sphinx>=1.6.2 # BSD + +# For autodoc builds +mock>=2.0.0 # BSD +oslotest>=1.10.0 # Apache-2.0 +requests-mock>=1.1.0 # Apache-2.0 +testresources>=2.0.0 # Apache-2.0/BSD +python-memcached>=1.56 # PSF +WebTest>=2.0.27 # MIT +oslo.messaging>=5.29.0 # Apache-2.0 diff --git a/test-requirements.txt b/test-requirements.txt index 413cea48..eae2aa1d 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -7,15 +7,11 @@ flake8-docstrings==0.2.1.post1 # MIT coverage!=4.4,>=4.0 # Apache-2.0 cryptography!=2.0,>=1.9 # BSD/Apache-2.0 -doc8>=0.6.0 # Apache-2.0 -docutils>=0.11 # OSI-Approved Open Source, Public Domain fixtures>=3.0.0 # Apache-2.0/BSD mock>=2.0.0 # BSD -openstackdocstheme>=1.17.0 # Apache-2.0 oslotest>=1.10.0 # Apache-2.0 reno>=2.5.0 # Apache-2.0 requests-mock>=1.1.0 # Apache-2.0 -sphinx>=1.6.2 # BSD stevedore>=1.20.0 # Apache-2.0 testrepository>=0.0.18 # Apache-2.0/BSD testresources>=2.0.0 # Apache-2.0/BSD diff --git a/tox.ini b/tox.ini index c0a99df2..1292b2e5 100644 --- a/tox.ini +++ b/tox.ini @@ -51,11 +51,13 @@ show-source = True exclude = .venv,.tox,dist,doc,*egg,build [testenv:docs] +deps = -r{toxinidir}/doc/requirements.txt commands= doc8 doc/source python setup.py build_sphinx [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 [hacking]