openstack-zuul-jobs/roles/neutron-horizon-hack/README.rst
Andreas Jaeger 64f521656c Update README for neutron-horizon-hack
Let's describe the API we need for tox_install.sh.

Change-Id: I5155ebffd3c7e8ec1f354b2afd6dfcb3986795fe
2017-12-16 19:36:41 +01:00

32 lines
1.0 KiB
ReStructuredText

Hack around some requirements being declared in tox_install.sh
.. note:: TODO(mordred) ZOMG DELETE THIS
neutron and horizon plugin repos currently require running the tox_install.sh
script where a list of additional dependencies are listed that are not in
their requirements files. Luckily, tox_install.sh is designed to be run
inside of a virtualenv, so we can just run it in the sphinx ~/.venv and
get them installed. This will let us work towards a solution that does not
involve a custom install script.
Note that this role only works if the file is called
``tools/tox_install.sh`` and takes three arguments
``constraints-file``, ``opts`` and ``packages``. The script must allow
invocation with the single ``constraints-file`` argument as well.
**Role Variables**
.. zuul:rolevar:: constraints_file
Optional path to a constraints file to use.
.. zuul:rolevar:: zuul_work_virtualenv
:default: ~/.venv
Virtualenv that sphinx is installed in.
.. zuul:rolevar:: zuul_work_dir
:default: {{ zuul.project.src_dir }}
Directory to operate in.