mirror of
https://github.com/dcarrillo/prezto.git
synced 2025-07-01 02:19:25 +00:00
general: Update documentation better qualifying runcom paths
Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
This commit is contained in:
committed by
Indrajit Raychaudhuri
parent
424d4cb779
commit
1ff9421f7b
@ -5,14 +5,16 @@ Enables local Python and local Python package installation.
|
||||
## Settings
|
||||
|
||||
This module supports virtual environments from conda and
|
||||
[*virtualenvwrapper*][2]. By default, only *virtualenvwrapper* is enabled. To
|
||||
disable *virtualenvwrapper*, add the following to *~/.zpreztorc*.
|
||||
[_virtualenvwrapper_][2]. By default, only _virtualenvwrapper_ is enabled. To
|
||||
disable _virtualenvwrapper_, add the following to
|
||||
_`${ZDOTDIR:-$HOME}/.zpreztorc`_.
|
||||
|
||||
```sh
|
||||
zstyle ':prezto:module:python' skip-virtualenvwrapper-init 'on'
|
||||
```
|
||||
|
||||
Conda support is enabled by adding the following to *~/.zpreztorc*.
|
||||
Conda support can be enabled by adding the following to
|
||||
_`${ZDOTDIR:-$HOME}/.zpreztorc`_.
|
||||
|
||||
```sh
|
||||
zstyle ':prezto:module:python' conda-init 'on'
|
||||
@ -22,18 +24,18 @@ Caution: using conda and virtualenvwrapper at the same time may cause conflicts.
|
||||
|
||||
## Local Python Installation
|
||||
|
||||
[*pyenv*][4] builds and installs multiple Python versions locally in the home
|
||||
[_pyenv_][4] builds and installs multiple Python versions locally in the home
|
||||
directory.
|
||||
|
||||
This module prepends the *pyenv* directory to the path variable to enable the
|
||||
This module prepends the _pyenv_ directory to the path variable to enable the
|
||||
execution of `pyenv`.
|
||||
|
||||
### Usage
|
||||
|
||||
Install Python versions with `pyenv install` into *~/.pyenv/versions*.
|
||||
Install Python versions with `pyenv install` into _`~/.pyenv/versions`_.
|
||||
|
||||
This will be loaded automatically if pyenv is installed to `$PYENV_ROOT`,
|
||||
*~/.pyenv*, or if the `pyenv` command is on the path.
|
||||
_`~/.pyenv`_, or if the `pyenv` command is on the path.
|
||||
|
||||
## Local Package Installation
|
||||
|
||||
@ -50,7 +52,7 @@ Install packages into the per user site directory with `pip install --user`.
|
||||
|
||||
## virtualenvwrapper
|
||||
|
||||
[*virtualenvwrapper*][2] is a frontend to the popular [*virtualenv*][3] utility.
|
||||
[_virtualenvwrapper_][2] is a frontend to the popular [_virtualenv_][3] utility.
|
||||
|
||||
`virtualenv` creates isolated Python environments and `virtualenvwrapper`
|
||||
provides convenient shell functions to create, switch, and manage them.
|
||||
@ -59,14 +61,15 @@ provides convenient shell functions to create, switch, and manage them.
|
||||
|
||||
Install `virtualenvwrapper`.
|
||||
|
||||
Virtual environments are stored in *~/.virtualenvs*.
|
||||
Virtual environments are stored in _`~/.virtualenvs`_.
|
||||
|
||||
There are configuration variables that have to be set to enable certain features.
|
||||
If you wish to use these features, export the variables in [`zshenv`][6].
|
||||
There are configuration variables that have to be set to enable certain
|
||||
features. If you wish to use these features, export the variables in
|
||||
[_`${ZDOTDIR:-$HOME}/.zshenv`_][6].
|
||||
|
||||
The variable `$PROJECT_HOME` tells `virtualenvwrapper` where to place project
|
||||
working directories. It must be set and the directory created before `mkproject`
|
||||
is used. Replace *Developer* with your projects directory.
|
||||
is used. Replace _Developer_ with your projects directory.
|
||||
|
||||
```sh
|
||||
export PROJECT_HOME="$HOME/Developer"
|
||||
@ -144,7 +147,7 @@ python version/
|
||||
|
||||
## Authors
|
||||
|
||||
*The authors of this module should be contacted via the [issue tracker][5].*
|
||||
_The authors of this module should be contacted via the [issue tracker][5]._
|
||||
|
||||
- [Sorin Ionescu](https://github.com/sorin-ionescu)
|
||||
- [Sebastian Wiesner](https://github.com/lunaryorn)
|
||||
@ -154,4 +157,4 @@ python version/
|
||||
[3]: https://pypi.org/project/virtualenv/
|
||||
[4]: https://github.com/yyuu/pyenv
|
||||
[5]: https://github.com/sorin-ionescu/prezto/issues
|
||||
[6]: https://github.com/sorin-ionescu/prezto/blob/master/runcoms/zshenv
|
||||
[6]: ../../runcoms#zshenv
|
||||
|
Reference in New Issue
Block a user