aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEmil Melnikov <emilmelnikov@gmail.com>2024-06-10 22:56:40 +0200
committerEli Schwartz <eschwartz93@gmail.com>2024-06-10 18:12:56 -0400
commit141100e482e440dd08ea8b5b042927cac968f112 (patch)
tree44bcdee9e90cdb8a3d60992bf102940b7518445c
parent9694f9fefeee6ac7c729c3a520c43902e6fb76f1 (diff)
downloadmeson-141100e482e440dd08ea8b5b042927cac968f112.zip
meson-141100e482e440dd08ea8b5b042927cac968f112.tar.gz
meson-141100e482e440dd08ea8b5b042927cac968f112.tar.bz2
Add note about meson-python and installation path
New people that want to use Meson for building Python extensions most probably will read Python module docs first. Direct them to meson-python and suggest to set `python.install_env=auto`.
-rw-r--r--docs/markdown/Builtin-options.md3
-rw-r--r--docs/markdown/Python-module.md9
2 files changed, 11 insertions, 1 deletions
diff --git a/docs/markdown/Builtin-options.md b/docs/markdown/Builtin-options.md
index b4039d6..6adc421 100644
--- a/docs/markdown/Builtin-options.md
+++ b/docs/markdown/Builtin-options.md
@@ -408,7 +408,8 @@ interpreter directly, even if it is a venv. Setting to `venv` will instead use
the paths for the virtualenv the python found installation comes from (or fail
if it is not a virtualenv). Setting to `auto` will check if the found
installation is a virtualenv, and use `venv` or `system` as appropriate (but
-never `prefix`). This option is mutually exclusive with the `platlibdir`/`purelibdir`.
+never `prefix`). Note that Conda environments are treated as `system`.
+This option is mutually exclusive with the `platlibdir`/`purelibdir`.
For backwards compatibility purposes, the default `install_env` is `prefix`.
diff --git a/docs/markdown/Python-module.md b/docs/markdown/Python-module.md
index 05ae57d..c02eed9 100644
--- a/docs/markdown/Python-module.md
+++ b/docs/markdown/Python-module.md
@@ -12,6 +12,15 @@ authors:
This module provides support for finding and building extensions against
python installations, be they python 2 or 3.
+If you want to build and package Python extension modules using tools
+compatible with [PEP-517](https://peps.python.org/pep-0517/), check out
+[meson-python](https://mesonbuild.com/meson-python/index.html).
+
+If you are building Python extension modules against a Python interpreter
+located in a venv or Conda environment, you probably want to set
+`python.install_venv=auto`;
+see [Python module options](Builtin-options.md#python-module) for details.
+
*Added 0.46.0*
## Functions