Get rid of documentation about pip install jedi

pip install jedi doesn't work with properly with virtualenvs, if jedi-vim is
used.
This commit is contained in:
Dave Halter
2019-06-20 23:15:07 +02:00
parent d32962f3b2
commit 636ad08d32
2 changed files with 11 additions and 20 deletions

View File

@@ -82,9 +82,8 @@ Manual installation
You might want to use `pathogen <https://github.com/tpope/vim-pathogen>`_ or You might want to use `pathogen <https://github.com/tpope/vim-pathogen>`_ or
`Vundle <https://github.com/gmarik/vundle>`_ to install jedi-vim. `Vundle <https://github.com/gmarik/vundle>`_ to install jedi-vim.
The first thing you need after that is an up-to-date version of Jedi. You can The first thing you need after that is an up-to-date version of Jedi. Install
either install it via ``pip install jedi`` or with ``git submodule update --init --recursive`` in your jedi-vim repository.
``git submodule update --init`` in your jedi-vim repository.
Example installation command using Pathogen: Example installation command using Pathogen:
@@ -100,6 +99,9 @@ Add the following line in your `~/.vimrc`
Plugin 'davidhalter/jedi-vim' Plugin 'davidhalter/jedi-vim'
For installing Jedi, ``pip install jedi`` will also work, but you might run
into issues when working in virtual environments. Please use git submodules.
Installation with your distribution Installation with your distribution
----------------------------------- -----------------------------------

View File

@@ -78,15 +78,6 @@ By leveraging this library, jedi-vim adds the following capabilities to Vim:
First of all, jedi-vim requires Vim to be compiled with the `+python` option. First of all, jedi-vim requires Vim to be compiled with the `+python` option.
The jedi library has to be installed for jedi-vim to work properly. You can
install it first, by using e.g. your distribution's package manager, or by
using pip: >
pip install jedi
However, you can also install it as a git submodule if you don't want to use
jedi for anything but this plugin. How to do this is detailed below.
It is best if you have VIM >= 7.3, compiled with the `+conceal` option. With It is best if you have VIM >= 7.3, compiled with the `+conceal` option. With
older versions, you will probably not see the parameter recommendation list older versions, you will probably not see the parameter recommendation list
for functions after typing the open bracket. Some platforms (including OS X for functions after typing the open bracket. Some platforms (including OS X
@@ -107,11 +98,7 @@ feature (such as MacVim on OS X, which also contains a console binary).
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
2.1. Installing manually *jedi-vim-installation-manually* 2.1. Installing manually *jedi-vim-installation-manually*
1a. Get the latest repository from Github: > 1. If you want to install jedi as a submodule instead, issue this command: >
git clone http://github.com/davidhalter/jedi-vim path/to/bundles/jedi-vim
1b. If you want to install jedi as a submodule instead, issue this command: >
git clone --recursive http://github.com/davidhalter/jedi-vim git clone --recursive http://github.com/davidhalter/jedi-vim
@@ -161,8 +148,8 @@ repositories. On Arch Linux, install vim-jedi. On Debian (8+) or Ubuntu
============================================================================== ==============================================================================
3. Supported Python features *jedi-vim-support* 3. Supported Python features *jedi-vim-support*
The Jedi library does all the hard work behind the scenes. It supports The Jedi library does all the hard work behind the scenes. It understands most
completion of a large number of Python features, among them: Python features, among them:
- Builtins - Builtins
- Multiple `return`s or `yield`s - Multiple `return`s or `yield`s
@@ -185,10 +172,12 @@ completion of a large number of Python features, among them:
- Simple/usual `sys.path` modifications - Simple/usual `sys.path` modifications
- `isinstance` checks for `if`/`while`/`assert` case, that doesnt work with - `isinstance` checks for `if`/`while`/`assert` case, that doesnt work with
Jedi Jedi
- Stubs
- And more... - And more...
Note: This list is not necessarily up to date. For a complete list of Note: This list is not necessarily up to date. For a complete list of
features, please refer to the Jedi documentation at http://jedi.jedidjah.ch. features, please refer to the Jedi documentation at
http://jedi.readthedocs.io.
============================================================================== ==============================================================================
4. Usage *jedi-vim-usage* 4. Usage *jedi-vim-usage*