airship/armada
Code Issues Proposed changes

docs(requirements): update requirements

Browse Source 
This change migrates the docs building requirements as outlined in
the Project Testing Interface[0]. One benefit of this that we no longer
load all the doc-generating modules when we run tox unittest. See [1] for
more details.

[0] https://governance.openstack.org/tc/reference/project-testing-interface.html#documentation
[1] http://lists.openstack.org/pipermail/openstack-dev/2017-November/124815.html

Change-Id: I0f4920df6ea68c289c82005d30ecd0efe0e29ca1
Signed-off-by: Tin Lam <tin@irrational.io>
This commit is contained in:
Tin Lam 2018-05-18 18:30:30 -05:00
parent e959027ffb
commit 10207be7b9
2 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/requirements.txt Normal file
View File

@ -0,0 +1,7 @@
# 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.
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
sphinxcontrib-apidoc>=0.2.0 # BSD
sphinx_rtd_theme>=0.2.4
reno>=2.5.0 # Apache-2.0

3
tox.ini
View File

@ -22,9 +22,10 @@ commands =
{toxinidir}/tools/run-unit-tests.sh {posargs}
[testenv:docs]
deps = -r{toxinidir}/doc/requirements.txt
commands =
rm -rf doc/build
python setup.py build_sphinx
sphinx-build -W -b html doc/source doc/build/html
[testenv:genconfig]
commands =