Skip to content

Fix documentation on when setup.py clean is run #10536

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

Merged
merged 1 commit into from
Oct 18, 2021
Merged

Fix documentation on when setup.py clean is run #10536

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
9 changes: 3 additions & 6 deletions docs/html/reference/build-system/setup-py.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,9 @@ depending on the package), the generated wheel is added to pip's wheel cache
and will be used for this installation. The built wheel is cached locally
by pip to avoid repeated identical builds.

If this wheel generation fails, pip will attempt a direct installation instead.
If this wheel generation fails, pip runs `setup.py clean` to clean up any build
artifacts that may have been generated. After that, pip will attempt a direct
installation.

### Direct Installation

Expand All @@ -70,11 +72,6 @@ For installing packages in "editable" mode
`setup.py develop`, which will use setuptools' mechanisms to perform an
editable/development installation.

### Cleanup

After attempting installation, pip may run `setup.py clean` to clean up build
artifacts from that setuptools has generated.

## Setuptools Injection

To support projects that directly use `distutils`, pip injects `setuptools` into
Expand Down