From d24ebbcb242c962ff71a43af07aed6ad56edcc99 Mon Sep 17 00:00:00 2001
From: Monty Taylor <mordred@inaugust.com>
Date: Tue, 1 Aug 2017 15:59:14 -0500
Subject: [PATCH] Add README for tox role

Change-Id: I64e41fe95495208561d0ba79fce20a03227a466f
---
 roles/tox/README.rst | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 roles/tox/README.rst

diff --git a/roles/tox/README.rst b/roles/tox/README.rst
new file mode 100644
index 000000000..9c50a8df0
--- /dev/null
+++ b/roles/tox/README.rst
@@ -0,0 +1,23 @@
+Runs tox for a project.
+
+Role Variables
+
+tox_environment
+  Environment variables to pass in to the tox run.
+
+tox_environment_defaults
+  Default environment variables to pass in to the tox run. Intended to allow
+  setting a set of environment variables in a base job but to still allow
+  specific settings on a per-job or per-variant basis.
+
+tox_envlist
+  Which tox environment to run. Defaults to 'venv'.
+
+tox_executable
+  Location of the tox executable. Defaults to 'tox'.
+
+tox_extra_args
+  String of extra command line options to pass to tox. Defaults to '-vv'.
+
+zuul_work_dir
+  Directory to run tox in.