diff options
author | Seth Morton <seth.m.morton@gmail.com> | 2021-11-02 20:02:11 -0700 |
---|---|---|
committer | Seth Morton <seth.m.morton@gmail.com> | 2021-11-02 20:02:26 -0700 |
commit | acc11e7264b52805876a5dcad53ec45b53417f6a (patch) | |
tree | 8025e0c9b803d5ea95d62ae279bc77e52359a099 | |
parent | 15b5d628498743cafb74e4eb3a816d4e3e7c4b62 (diff) | |
download | natsort-acc11e7264b52805876a5dcad53ec45b53417f6a.tar.gz |
Remove unsupported testing mechanisms from docs
-rw-r--r-- | README.rst | 20 |
1 files changed, 1 insertions, 19 deletions
@@ -434,18 +434,6 @@ python version 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 with the -``dev/requirements.txt`` file and then run the tests manually using -`pytest <https://docs.pytest.org/en/latest/>`_. - -.. code-block:: console - - $ 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>`_. - How to Build Documentation -------------------------- @@ -456,13 +444,7 @@ use ``tox``: $ tox -e docs -This will place the documentation in ``build/sphinx/html``. If you do not -which to use ``tox``, you can do the following: - -.. code-block:: console - - $ pip install sphinx sphinx_rtd_theme - $ python setup.py build_sphinx +This will place the documentation in ``build/sphinx/html``. Deprecation Schedule -------------------- |