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

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

Merged
merged 1 commit into from
Oct 19, 2024

Conversation

rgommers
Copy link
Contributor

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

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Having a short explanation of the reason why the virtual environment needs to be activated would be beneficial IMO.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about adding: (otherwise meson or another executable may not be found).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This fell through the cracks. I have made the suggested edit now. This should be good to go.

@dnicolodi
Copy link
Member

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
Copy link
Contributor Author

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
Copy link
Member

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.

@rgommers
Copy link
Contributor Author

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

@dnicolodi
Copy link
Member

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.

@dnicolodi dnicolodi merged commit 20a12c3 into mesonbuild:main Oct 19, 2024
11 of 15 checks passed
@rgommers rgommers deleted the doc-venv-activation branch October 19, 2024 15:47
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

Successfully merging this pull request may close these issues.

Document that using meson installed in a virtual environment requires the venv to be activated
2 participants