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: I77a09349304451041491893466ca98ba6ebdf96b
This commit is contained in:
Colleen Murphy 2017-12-19 22:31:15 +01:00
parent 14dd37b34c
commit 48829139d3
2 changed files with 21 additions and 0 deletions

19
doc/requirements.txt Normal file
View File

@ -0,0 +1,19 @@
# 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 generationg sphinx documentation
openstackdocstheme>=1.17.0 # Apache-2.0
reno>=2.5.0 # Apache-2.0
sphinx>=1.6.2 # BSD
# For autodoc builds
hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0
fixtures>=3.0.0 # Apache-2.0/BSD
mock>=2.0.0 # BSD
betamax>=0.7.0 # Apache-2.0
oslo.config>=4.6.0 # Apache-2.0
oslo.utils>=3.31.0 # Apache-2.0
requests-mock>=1.1.0 # Apache-2.0
lxml!=3.7.0,>=3.4.1 # BSD
oauthlib>=0.6.0 # BSD

View File

@ -63,12 +63,14 @@ show-source = True
exclude = .venv,.tox,dist,doc,*egg,build
[testenv:docs]
deps = -r{toxinidir}/doc/requirements.txt
commands=
bash -c "rm -rf doc/build"
bash -c "rm -rf doc/source/api"
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]