diff options
| author | Thomas O'Donnell <andytom@users.noreply.github.com> | 2021-05-17 08:43:16 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-05-17 08:43:16 +0200 |
| commit | eb01e1927d540a11ae8d550eecfd8a0a3e37c748 (patch) | |
| tree | 987772f0147b8b70b17eddcc260570b71bec40ef | |
| parent | ae6c69b13bfc86ba50e3dc11ff927727f55d712f (diff) | |
docs(python): Add additional python_binary example (#2728)
Have added an additional example for the `python_binary` option to show
how to display the version of python from inside a local virtual
environment.
| -rw-r--r-- | docs/config/README.md | 21 |
1 files changed, 16 insertions, 5 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index a3cb82545..d6d159cdd 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -2274,6 +2274,17 @@ python_binary = "python3" detect_extensions = [] ``` +```toml +# ~/.config/starship.toml + +[python] +# Display the version of python from inside a local venv. +# +# Note this will only work when the venv is inside the project and it will only +# work in the directory that contains the venv dir but maybe this is ok? +python_binary = ["./venv/bin/python", "python", "python3", "python2"] +``` + ## Red By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). @@ -2287,18 +2298,18 @@ The module will be shown if any of the following conditions are met: | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🔺 "` | A format string representing the symbol of Red. | -| `detect_extensions` | `["red"]` | Which extensions should trigger this module. | -| `detect_files` | `[]` | Which filenames should trigger this module. | +| `symbol` | `"🔺 "` | A format string representing the symbol of Red. | +| `detect_extensions` | `["red"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"red bold"` | The style for the module. | -| `disabled` | `false` | Disables the `red` module. | +| `disabled` | `false` | Disables the `red` module. | ### Variables | Variable | Example | Description | | -------- | -------- | ------------------------------------ | -| version | `v2.5.1` | The version of `red` | +| version | `v2.5.1` | The version of `red` | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | |