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

Add a new docs section "Building a package" #686

Open
rgommers opened this issue Oct 19, 2024 · 0 comments
Open

Add a new docs section "Building a package" #686

rgommers opened this issue Oct 19, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@rgommers
Copy link
Contributor

From #634 (comment):

@dnicolodi suggested:
I wonder whether it is time to have a Building a package top sections in the documentation with the details about build isolation, venv and some hints about cibuildwheel and co for building redistributable wheels.

@rgommers replied:

Yes, I agree. This is the cause of a lot of the questions/issues we are receiving. I also just searched for auditwheel and it's not in our docs (except in the non-public explanations/design-old.rst).

I won't be able to work on that in the next few days though, since it'll take a few hours at least to do it right. Should we open a new issue for that first, and scope it? I think I'd prefer to address your one comment here, and then have a new PR for the new docs page, containing:

We do indeed get lots of variations of the same questions that are conceptual issues with how Python packaging works and how meson-python fits in. I'm under no illusion that all users are going to understand build isolation and the difference between local and redistributable wheels, but it'd be nice if we could reply with a one-liner linking to the docs.

@rgommers rgommers added the documentation Improvements or additions to documentation label Oct 19, 2024
@dnicolodi dnicolodi changed the title And a new docs section "Building a package" Add a new docs section "Building a package" Nov 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant