summaryrefslogtreecommitdiff
path: root/docs/reference
diff options
context:
space:
mode:
authorAlex Grönholm <alex.gronholm@nextday.fi>2018-05-30 20:34:33 +0300
committerAlex Grönholm <alex.gronholm@nextday.fi>2018-07-17 15:02:50 +0300
commit353217fb496d61b3c5ce287b9c61a229e2ed27fe (patch)
tree13245d5b0c891aa40860531c8b23c45e8b210265 /docs/reference
parentf211d9a8879d44c967cde866ce3da7cad3db7bf4 (diff)
downloadwheel-git-353217fb496d61b3c5ce287b9c61a229e2ed27fe.tar.gz
Removed the "wheel install" and "wheel installscripts" commands
Closes #46. Closes #48. Closes #90. Closes #197.
Diffstat (limited to 'docs/reference')
-rw-r--r--docs/reference/index.rst2
-rw-r--r--docs/reference/wheel_install.rst63
-rw-r--r--docs/reference/wheel_install_scripts.rst33
3 files changed, 0 insertions, 98 deletions
diff --git a/docs/reference/index.rst b/docs/reference/index.rst
index 660fb40..a688c63 100644
--- a/docs/reference/index.rst
+++ b/docs/reference/index.rst
@@ -5,6 +5,4 @@ Reference Guide
:maxdepth: 2
wheel_convert
- wheel_install
wheel_unpack
- wheel_install_scripts
diff --git a/docs/reference/wheel_install.rst b/docs/reference/wheel_install.rst
deleted file mode 100644
index d056078..0000000
--- a/docs/reference/wheel_install.rst
+++ /dev/null
@@ -1,63 +0,0 @@
-wheel install
-=============
-
-Usage
------
-
-::
-
- wheel install <wheel_file>
-
-
-Description
------------
-
-Install the given wheel file to ``site-packages``.
-
-This unpacks the wheel file to the site packages directory and installs
-wrappers for any console scripts defined in the wheel metadata.
-
-It also checks that the hashes and file sizes match with those in ``RECORD``
-and exits with an error if it encounters a mismatch.
-
-
-Options
--------
-
-.. option:: --force
-
- Install the wheel even if its tags indicate it is incompatible with the
- current CPU architecture, Python version or Python implementation.
-
-.. options:: -d, --wheel-dir <wheel_dir>
-
- Specify a directory containing wheels. This will be used for dependency
- lookup.
-
-.. option:: -r, --requirements-file <requirements_file>
-
- Specify a file containing requirements to install. The wheels listed here
- will be installed in addition to the wheel given as the argument.
-
-.. option:: -l, --list
-
- List wheels which would be installed, but don't actually install anything.
-
-Examples
---------
-
-* Unpack a wheel::
-
- $ wheel install someproject-1.5.0-py2-py3-none.whl
- Unpacking to: ./someproject-1.5.0
-
-* If a file's hash does not match::
-
- $ wheel install someproject-1.5.0-py2-py3-none.whl
- Unpacking to: ./someproject-1.5.0
- Traceback (most recent call last):
- ...
- wheel.install.BadWheelFile: Bad hash for file 'mypackage/module.py'
- $ echo $?
- 1
-
diff --git a/docs/reference/wheel_install_scripts.rst b/docs/reference/wheel_install_scripts.rst
deleted file mode 100644
index a55919f..0000000
--- a/docs/reference/wheel_install_scripts.rst
+++ /dev/null
@@ -1,33 +0,0 @@
-wheel install-scripts
-=====================
-
-Usage
------
-
-::
-
- wheel install-scripts <distribution>
-
-
-Description
------------
-
-Install wrappers for the ``console_scripts`` entry points for given
-distribution.
-
-This (re)generates any wrappers (``.exe`` on Windows) for any
-``console_scripts`` entry points and installs them in the current scripts
-directory.
-
-Options
--------
-
-This command has no options.
-
-
-Examples
---------
-
-::
-
- $ wheel install-scripts someproject