diff options
author | Seth M Morton <seth.m.morton@gmail.com> | 2018-11-18 12:37:17 -0800 |
---|---|---|
committer | Seth M Morton <seth.m.morton@gmail.com> | 2018-11-18 18:34:50 -0800 |
commit | 56cc8a24efd577e0ddb124026da1aa46033389ab (patch) | |
tree | 4cdeed4284d043046c31a00f76d275841a80ede0 | |
parent | 7cef30ad873b3bda7c7e990eb1cf329c3430ecec (diff) | |
download | natsort-56cc8a24efd577e0ddb124026da1aa46033389ab.tar.gz |
Update documentation to not mention pipenv
-rw-r--r-- | README.rst | 11 | ||||
-rw-r--r-- | docs/intro.rst | 13 |
2 files changed, 11 insertions, 13 deletions
@@ -393,15 +393,14 @@ needed testing requirements for you. You can specify a particular python versio with the ``-e`` flag, e.g. ``tox -e py36``. Static analysis is done with ``tox -e flake8``. You can see all available testing environments with ``tox --listenvs``. -If you do not wish to use ``tox``, you can install the testing dependencies and run the -tests manually using `pytest <https://docs.pytest.org/en/latest/>`_ - ``natsort`` -contains a ``Pipfile`` for use with `pipenv <https://github.com/pypa/pipenv>`_ that -makes it easy for you to install the testing dependencies: +If you do not wish to use ``tox``, you can install the testing dependencies with the +``dev-requirements.txt`` file and then run the tests manually using +`pytest <https://docs.pytest.org/en/latest/>`_. .. code-block:: console - $ pipenv install --skip-lock --dev - $ pipenv run python -m pytest + $ pip install -r dev-requirements.txt + $ python -m pytest Note that above I invoked ``python -m pytest`` instead of just ``pytest`` - this is because `the former puts the CWD on sys.path <https://docs.pytest.org/en/latest/usage.html#calling-pytest-through-python-m-pytest>`_. diff --git a/docs/intro.rst b/docs/intro.rst index 8f9dba2..03db062 100644 --- a/docs/intro.rst +++ b/docs/intro.rst @@ -388,15 +388,14 @@ needed testing requirements for you. You can specify a particular python versio with the ``-e`` flag, e.g. ``tox -e py36``. Static analysis is done with ``tox -e flake8``. You can see all available testing environments with ``tox --listenvs``. -If you do not wish to use ``tox``, you can install the testing dependencies and run the -tests manually using `pytest <https://docs.pytest.org/en/latest/>`_ - ``natsort`` -contains a ``Pipfile`` for use with `pipenv <https://github.com/pypa/pipenv>`_ that -makes it easy for you to install the testing dependencies: +If you do not wish to use ``tox``, you can install the testing dependencies with the +``dev-requirements.txt`` file and then run the tests manually using +`pytest <https://docs.pytest.org/en/latest/>`_. -.. code-block:: sh +.. code-block:: console - $ pipenv install --skip-lock --dev - $ pipenv run python -m pytest + $ pip install -r dev-requirements.txt + $ python -m pytest Note that above I invoked ``python -m pytest`` instead of just ``pytest`` - this is because `the former puts the CWD on sys.path <https://docs.pytest.org/en/latest/usage.html#calling-pytest-through-python-m-pytest>`_. |