From 3f64b4577b402f1f733d264e3f1a8448a1a0b0f9 Mon Sep 17 00:00:00 2001 From: Andrey Kurilin <akurilin@mirantis.com> Date: Mon, 13 Oct 2014 17:26:40 +0300 Subject: [PATCH] Propose 'tox' as tests launcher Since ``tox`` is used as launcher in gates, it should be mentioned in docs instead of ``python setup.py test``. Change-Id: Ie5fcd9da755e1146b2b042fa5906aa28748980a6 --- doc/source/index.rst | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index c17d19aac..a7d547d1e 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,5 +1,5 @@ Python bindings to the OpenStack Nova API -================================================== +========================================= This is a client for OpenStack Nova API. There's :doc:`a Python API <api>` (the :mod:`novaclient` module), and a :doc:`command-line script @@ -40,7 +40,14 @@ Code is hosted at `git.openstack.org`_. Submit bugs to the Nova project on .. _Launchpad: https://launchpad.net/nova .. _Gerrit: http://wiki.openstack.org/GerritWorkflow -Run tests with ``python setup.py test``. +Testing +------- + +The preferred way to run the unit tests is using ``tox``. + +See `Consistent Testing Interface`_ for more details. + +.. _Consistent Testing Interface: http://git.openstack.org/cgit/openstack/governance/tree/reference/project-testing-interface.rst Indices and tables ==================