-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Document available settings for poetry config (#232)
- Loading branch information
Showing
3 changed files
with
35 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# Configuration | ||
|
||
Poetry can be configured via the `config` command ([see more about its usage here](/cli/#config)) | ||
or directly in the `config.toml` file that will be automatically be created when you first run that command. | ||
This file can typically be found in one of the following directories: | ||
|
||
- macOS: `~/Library/Application Support/pypoetry` | ||
- Windows: `C:\Users\<username>\AppData\Roaming\pypoetry` | ||
|
||
For Unix, we follow the XDG spec and support `$XDG_CONFIG_HOME`. | ||
That means, by default `~/.config/pypoetry` | ||
|
||
|
||
## Available settings | ||
|
||
### `settings.virtualenvs.create`: boolean | ||
Create a new virtualenv if one doesn't already exist. | ||
Defaults to `true`. | ||
|
||
### `settings.virtualenvs.in-project`: boolean | ||
Create the virtualenv inside the project's root directory. | ||
Defaults to `false`. | ||
|
||
### `settings.virtualenvs.path`: string | ||
Directory where virtualenvs will be created. | ||
Defaults to one of the following directories: | ||
|
||
- macOS: `~/Library/Caches/pypoetry/virtualenvs` | ||
- Windows: `C:\Users\<username>\AppData\Local\pypoetry\Cache/virtualenvs` | ||
- Unix: `~/.cache/pypoetry/virtualenvs` | ||
|
||
### `repository.<name>`: string | ||
Set a new alternative repository. See [Repositories](/repositories/) for more information. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters