diff --git a/docs/config/README.md b/docs/config/README.md index a3cb8254..d6d159cd 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` |