diff options
author | Zuul <zuul@review.openstack.org> | 2017-12-04 01:39:02 +0000 |
---|---|---|
committer | Gerrit Code Review <review@openstack.org> | 2017-12-04 01:39:02 +0000 |
commit | 10963e0abad1a69118df61bc77aa23b0a9c29e3c (patch) | |
tree | 4a870bf82b18cf410b15a54458adb12d3abc94ff | |
parent | 1b037aee0fd0a7a58df9be87acf456869eef4e19 (diff) | |
parent | 2f687e3373a471cbf66903af736f13b58eb4ee82 (diff) | |
download | cliff-10963e0abad1a69118df61bc77aa23b0a9c29e3c.tar.gz |
Merge "Move doc requirements to doc/requirements.txt"
-rw-r--r-- | doc/requirements.txt | 2 | ||||
-rw-r--r-- | setup.cfg | 11 | ||||
-rw-r--r-- | test-requirements.txt | 3 | ||||
-rw-r--r-- | tox.ini | 8 |
4 files changed, 11 insertions, 13 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000..3c822d2 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,2 @@ +sphinx>=1.6.2 # BSD +openstackdocstheme>=1.17.0 # Apache-2.0 @@ -16,17 +16,6 @@ classifier = Intended Audience :: Developers Environment :: Console -[extras] -# make openstackdocstheme an optional dependency. cliff is a low level lib -# that is used outside of OpenStack. Not having something OpenStack specific -# as build requirement is a good thing. -docs = - openstackdocstheme>=1.17.0 # Apache-2.0 - -[global] -setup-hooks = - pbr.hooks.setup_hook - [files] packages = cliff diff --git a/test-requirements.txt b/test-requirements.txt index 0628fbd..dbb6402 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -10,7 +10,8 @@ testscenarios>=0.4 # Apache-2.0/BSD coverage!=4.4,>=4.0 # Apache-2.0 -# this is required for the docs build jobs +# sphinx is required in test-requirements in addition to doc/requirements +# because there is a sphinx extension that has tests sphinx>=1.6.2 # BSD # Bandit security code scanner @@ -31,6 +31,11 @@ commands = bandit -c bandit.yaml -r cliff -x tests -n5 [testenv:venv] +# TODO(modred) remove doc/requirements.txt once the openstack-build-sphinx-docs +# job is updated. +deps = + -r{toxinidir}/test-requirements.txt + -r{toxinidir}/doc/requirements.txt commands = {posargs} [testenv:neutronclient-tip] @@ -44,4 +49,5 @@ deps = os:openstack/python-openstackclient:python-openstackclient commands = {toxinidir}/integration-tests/openstackclient-tip.sh {envdir} [testenv:docs] -commands = python setup.py build_sphinx +deps = -r{toxinidir}/doc/requirements.txt +commands = sphinx-build -b html doc/source doc/build/html |