mesonbuild / meson-python

Meson PEP 517 Python build backend
https://mesonbuild.com/meson-python/
MIT License
118 stars 59 forks source link

DOC: add a brief explanation of build isolation to the tutorial #634

Open rgommers opened 1 month ago

rgommers commented 1 month ago

Build isolation is a regular cause of confusion for many users, so a brief explanation can't hurt.

Also add a very brief note that the build venv must be activated - the venv docs are confusing here, as gh-630 shows. Closes gh-630

dnicolodi commented 1 month ago

Thanks @rgommers. 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 commented 1 month ago

Thanks @rgommers. 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.

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:

dnicolodi commented 1 month ago

I'd prefer to address your one comment here, and then have a new PR for the new docs page

Sure. I didn't want to suggest that it should be done as part of this PR.