Skip to content

Commit f1659ec

Browse files
committed
update docs
1 parent 434fecb commit f1659ec

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

Diff for: docs/configuration.md

+8
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ virtualenvs.in-project = null
4848
virtualenvs.options.always-copy = true
4949
virtualenvs.options.system-site-packages = false
5050
virtualenvs.path = "{cache-dir}/virtualenvs" # /path/to/cache/directory/virtualenvs
51+
virtualenvs.prefer-shell-python = false
5152
```
5253

5354
## Displaying a single configuration setting
@@ -188,6 +189,13 @@ Give the virtual environment access to the system site-packages directory.
188189
Applies on virtualenv creation.
189190
Defaults to `false`.
190191

192+
### `virtualenvs.prefer-shell-python`
193+
194+
**Type**: boolean
195+
196+
Use currently activated Python version to create a new venv.
197+
Defaults to `false`, which means Python version used during Poetry installation is used.
198+
191199
### `repositories.<name>`
192200

193201
**Type**: string

Diff for: docs/managing-environments.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ To achieve this, it will first check if it's currently running inside a virtual
1818
If it is, it will use it directly without creating a new one. But if it's not, it will use
1919
one that it has already created or create a brand new one for you.
2020

21-
By default, Poetry will try to use the currently activated Python version
21+
By default, Poetry will try to use the Python version used during Poetry's installation
2222
to create the virtual environment for the current project.
2323

2424
However, for various reasons, this Python version might not be compatible
@@ -38,6 +38,7 @@ pyenv install 3.9.8
3838
pyenv local 3.9.8 # Activate Python 3.9 for the current project
3939
poetry install
4040
```
41+
This requires setting the `virtualenvs.prefer-shell-python` option to `true`.
4142
{{% /note %}}
4243

4344
## Switching between environments

0 commit comments

Comments
 (0)