openstack/taskflow
Code Issues Proposed changes

Use doc/requirements.txt

Browse Source 
The infra jobs expect documentation requirements in either
doc/requirements.txt or test-requirements.txt. Since neither is
available, they currently fail.

Move doc requirements to doc/requirements.txt and use that to
fix releasenotes build. Note that doc/requirements.txt needs some
requirements for code analysis of taskflow.

For the docs environment - which is a developer convenience - use the
same command that is used by OpenStack CI.

Change-Id: Iec65211e5059a4afdd88a45e2c1ac535b8ec97fe
This commit is contained in:
Andreas Jaeger 2017-12-18 15:50:01 +01:00
parent 4caeea11cc
commit 760f4414ea
3 changed files with 27 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/requirements.txt Normal file
View File

@ -0,0 +1,21 @@
sphinx>=1.6.2 # BSD
openstackdocstheme>=1.17.0 # Apache-2.0
reno>=2.5.0 # Apache-2.0
doc8>=0.6.0 # Apache-2.0
# This copies requirements from [extra] section of setup.cfg.
# These need to be installed for some code analysis done
# via "inheritance-diagram" directive.
kombu!=4.0.2,>=4.0.0 # BSD
kazoo>=2.2 # Apache-2.0
zake>=0.1.6 # Apache-2.0
redis>=2.10.0 # MIT
eventlet!=0.18.3,!=0.20.1,<0.21.0,>=0.18.2 # MIT
SQLAlchemy!=1.1.5,!=1.1.6,!=1.1.7,!=1.1.8,>=1.0.10 # MIT
alembic>=0.8.10 # MIT
SQLAlchemy-Utils>=0.30.11 # BSD License
PyMySQL>=0.7.6 # MIT License
psycopg2>=2.6.2 # LGPL/ZPL

4
setup.cfg
View File

@ -66,9 +66,6 @@ workers =
kombu!=4.0.2,>=4.0.0 # BSD
eventlet =
eventlet!=0.18.3,!=0.20.1,<0.21.0,>=0.18.2 # MIT
doc =
sphinx>=1.6.2 # BSD
openstackdocstheme>=1.17.0 # Apache-2.0
database =
SQLAlchemy!=1.1.5,!=1.1.6,!=1.1.7,!=1.1.8,>=1.0.10 # MIT
alembic>=0.8.10 # MIT
@ -83,7 +80,6 @@ test =
testtools>=2.2.0 # MIT
testscenarios>=0.4 # Apache-2.0/BSD
doc8>=0.6.0 # Apache-2.0
reno>=2.5.0 # Apache-2.0
[nosetests]
cover-erase = true

8
tox.ini
View File

@ -16,11 +16,12 @@ setenv = VIRTUAL_ENV={envdir}
install_command = {toxinidir}/tools/tox_install.sh {env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} {opts} {packages}
# We need to install a bit more than just `test' because those drivers have
# custom tests that we always run
deps = .[test,workers,zookeeper,database,redis,eventlet,doc]
deps = .[test,workers,zookeeper,database,redis,eventlet]
commands = python setup.py testr --slowest --testr-args='{posargs}'
[testenv:docs]
commands = python setup.py build_sphinx
deps = -r{toxinidir}/doc/requirements.txt
commands = sphinx-build -E -W -b html doc/source doc/build/html
doc8 doc/source
[testenv:update-states]
@ -54,10 +55,13 @@ import_exceptions = six.moves
unittest.mock
[testenv:py27]
deps = .[test,workers,zookeeper,database,redis,eventlet]
-r{toxinidir}/doc/requirements.txt
commands =
python setup.py testr --slowest --testr-args='{posargs}'
sphinx-build -b doctest doc/source doc/build
doc8 --ignore-path "doc/source/history.rst" doc/source
[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