summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSeth M Morton <seth.m.morton@gmail.com>2018-11-18 12:37:17 -0800
committerSeth M Morton <seth.m.morton@gmail.com>2018-11-18 12:37:17 -0800
commitea0279757d63f12636f490316ab688319acc342d (patch)
treee01ca76bcd3c6f15eb472b63b131886d6cd6435d
parentfe71dfc8bc39a3666e2bc98db9b2998b9b53cf79 (diff)
downloadnatsort-remove-pipenv-dependency.tar.gz
Update documentation to not mention pipenvremove-pipenv-dependency
-rw-r--r--README.rst11
-rw-r--r--docs/intro.rst13
2 files changed, 11 insertions, 13 deletions
diff --git a/README.rst b/README.rst
index c33104e..b2b8720 100644
--- a/README.rst
+++ b/README.rst
@@ -393,15 +393,14 @@ After installing ``tox``, running tests is as simple as executing the following
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 <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 b52b43a..7e80e76 100644
--- a/docs/intro.rst
+++ b/docs/intro.rst
@@ -388,15 +388,14 @@ After installing ``tox``, running tests is as simple as executing the following
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 <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>`_.