From f030b145e04159468149e7fc18333980319c3946 Mon Sep 17 00:00:00 2001 From: Seth M Morton Date: Thu, 17 May 2018 22:55:49 -0400 Subject: Add skip_missing_interpreters to tox.ini. This way users will not be penalized if they do not have all python versions installed. The docs are updated to suggest just calling tox with no arguments. --- README.rst | 16 +++++----------- docs/source/intro.rst | 16 +++++----------- tox.ini | 4 ++++ 3 files changed, 14 insertions(+), 22 deletions(-) diff --git a/README.rst b/README.rst index 9c71a4f..783d109 100644 --- a/README.rst +++ b/README.rst @@ -305,22 +305,16 @@ How to Run Tests Please note that ``natsort`` is NOT set-up to support ``python setup.py test``. The recommended way to run tests is with `tox `_. -Suppose you want to run tests for Python 3.6 - you can run tests by simply executing the -following: +After installing ``tox``, running tests is as simple as executing the following in the +``natsort`` directory: .. code-block:: sh - $ tox -e py36 + $ tox ``tox`` will create virtual a virtual environment for your tests and install all the -needed testing requirements for you. - -If you want to run testing on all of Python 2.7, 3.4, 3.5, and 3.6 you can simply -execute - -.. code-block:: sh - - $ tox +needed testing requirements for you. You can specify a particular python version +with the ``-e`` flag, e.g. ``tox -e py36``. If you do not wish to use ``tox``, you can install the testing dependencies and run the tests manually using `pytest `_ - ``natsort`` diff --git a/docs/source/intro.rst b/docs/source/intro.rst index 790234b..40aaad3 100644 --- a/docs/source/intro.rst +++ b/docs/source/intro.rst @@ -308,22 +308,16 @@ How to Run Tests Please note that :mod:`natsort` is NOT set-up to support ``python setup.py test``. The recommended way to run tests is with `tox `_. -Suppose you want to run tests for Python 3.6 - you can run tests by simply executing the -following: +After installing ``tox``, running tests is as simple as executing the following in the +``natsort`` directory: .. code-block:: sh - $ tox -e py36 + $ tox ``tox`` will create virtual a virtual environment for your tests and install all the -needed testing requirements for you. - -If you want to run testing on all of Python 2.7, 3.4, 3.5, and 3.6 you can simply -execute - -.. code-block:: sh - - $ tox +needed testing requirements for you. You can specify a particular python version +with the ``-e`` flag, e.g. ``tox -e py36``. If you do not wish to use ``tox``, you can install the testing dependencies and run the tests manually using `pytest `_ - ``natsort`` diff --git a/tox.ini b/tox.ini index fc39d31..55ff47b 100644 --- a/tox.ini +++ b/tox.ini @@ -10,6 +10,10 @@ envlist = # docs # release +# Don't error out if a user hasn't installed all python versions. +skip_missing_interpreters = + true + [testenv] passenv = WITH_EXTRAS -- cgit v1.2.1