DOC: add a brief explanation of build isolation to the tutorial #634
Conversation
docs/tutorials/introduction.rst
Outdated
| If you disable build isolation, you are responsible for ensuring that | ||
| ``meson-python`` and all other build dependencies for the package are installed | ||
| already in the Python environment. Note that if you use a virtual environment | ||
| to build in, it must be activated. |
There was a problem hiding this comment.
Having a short explanation of the reason why the virtual environment needs to be activated would be beneficial IMO.
There was a problem hiding this comment.
How about adding: (otherwise meson or another executable may not be found).
There was a problem hiding this comment.
This fell through the cracks. I have made the suggested edit now. This should be good to go.
|
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 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:
|
Sure. I didn't want to suggest that it should be done as part of this PR. |
rgommers
force-pushed
the
doc-venv-activation
branch
from
627976e
to
08cf53d
Compare
|
@dnicolodi this is still mergeable I think - mind if I hit the merge button? I'll open the follow-up issue for the separate docs section now. |
|
I would like to find the time for some substantial improvements to the tutorial: I think that now it focuses on the wrong things. But this PR adds useful information and does not hinder future edits. I'm merging it. |
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
venvdocs are confusing here, as gh-630 shows. Closes gh-630