Merge pull request #8148 from NoahGorny/improve-dev-docs

docs: getting-started: Improve running pip from source tree section
pypa · May 31, 2020 · 549a9d1 · 549a9d1
2 parents 69a4cb3 + c38f962
commit 549a9d1
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/docs/html/development/getting-started.rst b/docs/html/development/getting-started.rst
@@ -34,12 +34,16 @@ For developing pip, you need to install :pypi:`tox`. Often, you can run
 Running pip From Source Tree
 ============================
 
-To run the pip executable from your source tree during development, run pip
-from the ``src`` directory:
+To run the pip executable from your source tree during development, install pip
+locally using editable installation (inside a virtualenv).
+You can then invoke your local source tree pip normally.
 
 .. code-block:: console
 
-    $ python src/pip --version
+    $ virtualenv venv # You can also use "python -m venv venv" from python3.3+
+    $ source venv/bin/activate
+    $ python -m pip install -e .
+    $ python -m pip --version
 
 
 Running Tests

diff --git a/news/8148.trivial b/news/8148.trivial
@@ -0,0 +1,2 @@
+Improve "Running pip from source tree" section in getting-started
+to use editable installation instead of running pip directly from source.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		Improve "Running pip from source tree" section in getting-started
		to use editable installation instead of running pip directly from source.