summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDustin Ingram <di@users.noreply.github.com>2020-09-24 12:11:47 -0500
committerGitHub <noreply@github.com>2020-09-24 20:11:47 +0300
commit2e90eef2e52dab03cff1f71bcb8931ce141e320d (patch)
tree26d78ee52b05806a0ab7425e425798c3e7d5aed4 /docs
parent9cdf053333f521a549d564b64f9d12a1a1d58a57 (diff)
downloadwheel-git-2e90eef2e52dab03cff1f71bcb8931ce141e320d.tar.gz
Removed 'wheel install' from docs (#377)
Diffstat (limited to 'docs')
-rw-r--r--docs/user_guide.rst18
1 files changed, 2 insertions, 16 deletions
diff --git a/docs/user_guide.rst b/docs/user_guide.rst
index 121b86d..6517258 100644
--- a/docs/user_guide.rst
+++ b/docs/user_guide.rst
@@ -79,22 +79,8 @@ This can be changed with the ``--dest-dir`` option::
Installing Wheels
-----------------
-.. note:: The ``wheel install`` command is merely a Proof-Of-Concept
- implementation and lacks many features provided by pip_. It is meant only
- as an example for implementors of packaging tools. End users should use
- ``pip install`` instead.
+To install a wheel file, use pip_::
-To install a wheel file in ``site-packages``::
-
- $ wheel install someproject-1.5.0-py2-py3-none.whl
-
-This will unpack the archive in your current site packages directory and
-install any console scripts contained in the wheel.
-
-You can accomplish the same in two separate steps (with ``<site-packages-dir>``
-being the path to your ``site-packages`` directory::
-
- $ wheel unpack -d <site-packages-dir> someproject-X.Y.Z-py2-py3-none.whl
- $ wheel install-scripts someproject
+ $ pip install someproject-1.5.0-py2-py3-none.whl
.. _pip: https://pypi.org/project/pip/