Skip to content

Commit

Permalink
DOC: add a brief explanation of build isolation to the tutorial
Browse files Browse the repository at this point in the history
Closes gh-630
  • Loading branch information
rgommers committed Aug 2, 2024
1 parent 9df4ffd commit 08cf53d
Showing 1 changed file with 13 additions and 0 deletions.
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

0 comments on commit 08cf53d

Please sign in to comment.