Skip to content

docs: explain editable installs from source #5298

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
aryansk wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: explain editable installs from source #5298

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/development/developer-guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,22 @@ Developer's Guide for Setuptools
If you want to know more about contributing on Setuptools, this is the place.


-----------------------
Using the latest source
-----------------------

To work on the latest version from a checkout, create a virtual environment
and install the checkout in editable mode::

$ python -m venv .venv
$ . .venv/bin/activate
$ python -m pip install --editable .

The editable installation makes the working tree importable, so source changes
are immediately available while you develop. Use a fresh virtual environment
for each checkout to keep its dependencies isolated.


-------------------
Recommended Reading
-------------------
Expand Down
1 change: 1 addition & 0 deletions newsfragments/2532.doc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Documented how to install a checkout in editable mode when developing the latest source.