From d4733e131f43e3f81817135b7f7477fd38c50c3c Mon Sep 17 00:00:00 2001 From: zejian Zhuang Date: Fri, 2 Jun 2017 10:14:04 +0800 Subject: [PATCH] Add description about tox in dev_env.rst Change-Id: I6e3650ef78efa5973de5d6f89a1ae25f33836aa8 --- doc/source/devref/development.environment.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/source/devref/development.environment.rst b/doc/source/devref/development.environment.rst index 64cc799a0f1..c0338dc74ad 100644 --- a/doc/source/devref/development.environment.rst +++ b/doc/source/devref/development.environment.rst @@ -94,6 +94,13 @@ Grab the code:: Running unit tests ------------------ +The preferred way to run the unit tests is using ``tox``. It executes tests in +isolated environment, by creating separate virtualenv and installing +dependencies from the ``requirements.txt`` and ``test-requirements.txt`` files, +so the only package you install is ``tox`` itself:: + + sudo pip install tox + Run the unit tests by doing:: tox -e py35