Mohammed Naser 9254fbb5ff ensure-tox: add prefer_python2
This patch enables the ability to set a value which prefers the
installation of tox within python2 over python3.

Change-Id: I29c9585aa9048c0e2855ec1eaf1f48041cfe46e2
2020-03-04 07:21:20 +00:00

20 lines
587 B
ReStructuredText

Ensure tox is installed
If tox is not already installed, it will be installed via pip in the
user install directory (i.e., "pip install --user").
**Role Variables**
.. zuul:rolevar:: tox_executable
:default: ``tox``
Optional path to point tox executable
.. zuul:rolevar:: tox_prefer_python2
:default: ``true``
If tox is not detected, prefer to install tox inside Python 2 instead of
Python 3. The default value is currently set to ``true`` for compatibility
reasons, it will be switched to false eventually. It's best to set this to
``false`` when using it.