Skip to content

Commit 20a12c3

Browse files
rgommersdnicolodi
authored andcommitted
DOC: add a brief explanation of build isolation to the tutorial
Closes gh-630
1 parent 391d021 commit 20a12c3

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/tutorials/introduction.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -255,6 +255,19 @@ If the build succeeded, you'll have the binary artifacts in the ``dist`` folder.
255255
easier, we recommend checking out the cibuildwheel_ project, which allows you
256256
to automate it.
257257

258+
Build isolation
259+
```````````````
260+
261+
Building with ``python -m build`` or with ``pip`` uses build isolation by
262+
default. I.e., the build frontend creates a new, temporary virtual environment
263+
with all build dependencies before calling ``meson-python`` to build a wheel.
264+
265+
If you disable build isolation, you are responsible for ensuring that
266+
``meson-python`` and all other build dependencies for the package are installed
267+
already in the Python environment. Note that if you use a virtual environment
268+
to build in, it must be activated (otherwise ``meson`` or another executable
269+
may not be found).
270+
258271

259272
Distributing the project
260273
------------------------

0 commit comments

Comments
 (0)