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
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/tutorials/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,19 @@ If the build succeeded, you'll have the binary artifacts in the ``dist`` folder.
easier, we recommend checking out the cibuildwheel_ project, which allows you
to automate it.

Build isolation
```````````````

Building with ``python -m build`` or with ``pip`` uses build isolation by
default. I.e., the build frontend creates a new, temporary virtual environment
with all build dependencies before calling ``meson-python`` to build a wheel.

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 (otherwise ``meson`` or another executable
may not be found).


Distributing the project
------------------------
Expand Down