Skip to content

Commit

Permalink
doc: mention "pynvim" module rename
Browse files Browse the repository at this point in the history
closes #9764
  • Loading branch information
justinmk committed Mar 26, 2019
1 parent 46c7e12 commit 947069b
Showing 1 changed file with 28 additions and 18 deletions.
46 changes: 28 additions & 18 deletions runtime/doc/provider.txt
Original file line number Diff line number Diff line change
Expand Up @@ -24,29 +24,34 @@ Nvim supports Python |remote-plugin|s and the Vim legacy |python2| and
|python3| interfaces (which are implemented as remote-plugins).
Note: Only the Vim 7.3 API is supported; bindeval (Vim 7.4) is not.


PYTHON QUICKSTART ~

Install the "pynvim" Python package:
To use Python plugins, you need the "pynvim" module. Run |:checkhealth| to see
if you already have it (some package managers install the module with Nvim
itself).

For Python 3 plugins:
1. Make sure Python 3.4+ is available in your $PATH.
2. Install the module (try "pip" if "pip3" is missing): >
pip3 install --user --upgrade pynvim
For Python 2 plugins:
1. Make sure Python 2.7 is available in your $PATH.
2. Install the module (try "pip" if "pip2" is missing): >
pip2 install --user --upgrade pynvim
- Run |:checkhealth| to see if you already have the package (some package
managers install the "pynvim" Python package with Nvim itself).
The pip `--upgrade` flag ensures that you get the latest version even if
a previous version was already installed.

- For Python 2 plugins, make sure Python 2.7 is available in your $PATH, then
install the package systemwide: >
sudo pip2 install --upgrade pynvim
< or for the current user: >
pip2 install --user --upgrade pynvim
< If "pip2" is missing, try "pip".
See also |python-virtualenv|.

- For Python 3 plugins, make sure Python 3.4+ is available in your $PATH, then
install the package systemwide: >
sudo pip3 install --upgrade pynvim
< or for the current user: >
pip3 install --user --upgrade pynvim
< If "pip3" is missing, try "pip".
Note: The old "neovim" module was renamed to "pynvim".
https://github.com/neovim/neovim/wiki/Following-HEAD#20181118
If you run into problems, uninstall _both_ then install "pynvim" again: >
pip uninstall neovim pynvim
pip install pynvim
- The `--upgrade` flag ensures you have the latest version even if a previous
version was already installed.
PYTHON PROVIDER CONFIGURATION ~
*g:python_host_prog*
Expand All @@ -67,8 +72,9 @@ To disable Python 2 support: >
To disable Python 3 support: >
let g:loaded_python3_provider = 1
PYTHON VIRTUALENVS ~
PYTHON VIRTUALENVS ~
*python-virtualenv*
If you plan to use per-project virtualenvs often, you should assign one
virtualenv for Neovim and hard-code the interpreter path via
|g:python3_host_prog| (or |g:python_host_prog|) so that the "pynvim" package
Expand All @@ -91,13 +97,15 @@ Ruby integration *provider-ruby*
Nvim supports Ruby |remote-plugin|s and the Vim legacy |ruby-vim| interface
(which is itself implemented as a Nvim remote-plugin).


RUBY QUICKSTART ~

To use Ruby plugins with Nvim, install the latest "neovim" RubyGem: >
gem install neovim
Run |:checkhealth| to see if your system is up-to-date.


RUBY PROVIDER CONFIGURATION ~
*g:loaded_ruby_provider*
To disable Ruby support: >
Expand All @@ -120,13 +128,15 @@ Node.js integration *provider-nodejs*
Nvim supports Node.js |remote-plugin|s.
https://github.com/neovim/node-client/


NODEJS QUICKSTART~

To use javascript remote-plugins with Nvim, install the "neovim" npm package: >
npm install -g neovim
Run |:checkhealth| to see if your system is up-to-date.


NODEJS PROVIDER CONFIGURATION~
*g:loaded_node_provider*
To disable Node.js support: >
Expand Down

0 comments on commit 947069b

Please sign in to comment.