From 636ad08d32075548c33f520f52dce1db8f7753fc Mon Sep 17 00:00:00 2001 From: Dave Halter Date: Thu, 20 Jun 2019 23:15:07 +0200 Subject: [PATCH] Get rid of documentation about pip install jedi pip install jedi doesn't work with properly with virtualenvs, if jedi-vim is used. --- README.rst | 8 +++++--- doc/jedi-vim.txt | 23 ++++++----------------- 2 files changed, 11 insertions(+), 20 deletions(-) diff --git a/README.rst b/README.rst index ec8188d..bb16b4a 100644 --- a/README.rst +++ b/README.rst @@ -82,9 +82,8 @@ Manual installation You might want to use `pathogen `_ or `Vundle `_ to install jedi-vim. -The first thing you need after that is an up-to-date version of Jedi. You can -either install it via ``pip install jedi`` or with -``git submodule update --init`` in your jedi-vim repository. +The first thing you need after that is an up-to-date version of Jedi. Install +``git submodule update --init --recursive`` in your jedi-vim repository. Example installation command using Pathogen: @@ -100,6 +99,9 @@ Add the following line in your `~/.vimrc` 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 ----------------------------------- diff --git a/doc/jedi-vim.txt b/doc/jedi-vim.txt index 9c5d83a..d13d86f 100644 --- a/doc/jedi-vim.txt +++ b/doc/jedi-vim.txt @@ -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. -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 older versions, you will probably not see the parameter recommendation list 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* -1a. Get the latest repository from Github: > - - 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: > +1. If you want to install jedi as a submodule instead, issue this command: > 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* -The Jedi library does all the hard work behind the scenes. It supports -completion of a large number of Python features, among them: +The Jedi library does all the hard work behind the scenes. It understands most +Python features, among them: - Builtins - 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 - `isinstance` checks for `if`/`while`/`assert` case, that doesn’t work with Jedi +- Stubs - And more... 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*