-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Added documentation for build_meta #2051
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me. Thanks for the contrib.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was about to accept this change when I realize there are two major issues:
- This new document isn't linked from anywhere else in the documentation.
- The main documentation still recommends
setup()
for building a package.
What we really want is to present the simplest, best practices first, not tell the wrong story, then give a sordid history, then tell the right story.
For now, I'm going to accept these changes as they are, but we'll want to iterate on them to integrate them into the documentation as first-class behaviors.
Hi, thanks for accepting the PR! I'm just a little confused because I thought this documentation was to explain how to use the functions provided in |
Hi alvyjudy. Indeed, the fact that setuptools exposes its PEP 517 build functionality through a module named |
#1698 Summary of changes
Added documentation for build_meta. It is not fully completed but with enough content to get started with the module. (This is my first time contributing and I'm trying my best to follow the guidelines and beginner docs, hopefully I didn't miss anything:)
I have made the simplification that it is a
setup.cfg
only package. But I can definitely change this later!Pull Request Checklist