Skip to content
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.

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

Pip wheel documentation seems to be outdated #10972

Closed
1 task done
kasium opened this issue Mar 16, 2022 · 2 comments · Fixed by #10975
Closed
1 task done

Pip wheel documentation seems to be outdated #10972

kasium opened this issue Mar 16, 2022 · 2 comments · Fixed by #10975
Labels
type: bug A confirmed bug or unintended behavior type: docs Documentation related

Comments

@kasium
Copy link
Contributor

kasium commented Mar 16, 2022

Description

Current docs

 Build Wheel archives for your requirements and dependencies.
  
  Wheel is a built-package format, and offers the advantage of not
  recompiling your software during every install. For more details, see the
  wheel docs: https://wheel.readthedocs.io/en/latest/
  
  Requirements: setuptools>=0.8, and wheel.
  
  'pip wheel' uses the bdist_wheel setuptools extension from the wheel
  package to build individual wheels.

However, if PEP 517 is used, I guess this bdist_wheel is not executed. By setting the build backend to poetry, I was able to run pip wheel . without wheel and setuptools being installed.

Are the docs outdated?

Expected behavior

No response

pip version

22.0.4

Python version

3.7.1

OS

Linux

How to Reproduce

pip wheel -h

Output

No response

Code of Conduct

@kasium kasium added S: needs triage Issues/PRs that need to be triaged type: bug A confirmed bug or unintended behavior labels Mar 16, 2022
@pfmoore
Copy link
Member

pfmoore commented Mar 16, 2022

It's accurate for the setuptools backend1, but as you point out other backends have their own way of building wheels.

A PR to update the docs would be welcomed.

Footnotes

  1. The fact that you don't need setuptools installed is technically not because of PEP 517, but because pip now does the build in an isolated environment, and installs the backend there.

@pradyunsg
Copy link
Member

We should drop that line and link to the build system interface section from there.

@uranusjr uranusjr added type: docs Documentation related and removed S: needs triage Issues/PRs that need to be triaged labels Mar 18, 2022
kasium added a commit to kasium/pip that referenced this issue Mar 18, 2022
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 21, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type: bug A confirmed bug or unintended behavior type: docs Documentation related
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants