From ec47c866c85a6677a1500d376df5897d8524b075 Mon Sep 17 00:00:00 2001 From: Omry Yadan Date: Sat, 3 Aug 2019 10:31:42 -0700 Subject: [PATCH] updated docs --- docs/html/reference/pip_install.rst | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/html/reference/pip_install.rst b/docs/html/reference/pip_install.rst index 96fd1c018..e919693b3 100644 --- a/docs/html/reference/pip_install.rst +++ b/docs/html/reference/pip_install.rst @@ -694,10 +694,21 @@ does not satisfy the ``--require-hashes`` demand that every package have a local hash. +Local project installs +++++++++++++++++++++++ +pip supports installing local project in both regular mode and editable mode. +You can install local projects by specifying the project path to pip:: + +$ pip install path/to/SomeProject + +During the installation, pip will copy the entire project directory to a temporary location and install from there. +The exception is that pip will exclude .tox and .nox directories present in the top level of the project from being copied. + + .. _`editable-installs`: "Editable" Installs -+++++++++++++++++++ +~~~~~~~~~~~~~~~~~~~ "Editable" installs are fundamentally `"setuptools develop mode" `_