aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2019-03-21 12:22:35 +0100
committerJustin M. Keyes <justinkz@gmail.com>2019-03-26 21:17:12 +0100
commiteeb19a346a6afac2672b47f5d15e4ea0cf7737aa (patch)
tree8fec2a3734926aa85ce2a7d5ce0dac8c8c382740
parentd614c7932ca599cb482cd87f9731e1f839dbe295 (diff)
downloadrneovim-eeb19a346a6afac2672b47f5d15e4ea0cf7737aa.tar.gz
rneovim-eeb19a346a6afac2672b47f5d15e4ea0cf7737aa.tar.bz2
rneovim-eeb19a346a6afac2672b47f5d15e4ea0cf7737aa.zip
doc: mention "pynvim" module rename
closes #9764
-rw-r--r--runtime/doc/provider.txt46
1 files changed, 28 insertions, 18 deletions
diff --git a/runtime/doc/provider.txt b/runtime/doc/provider.txt
index 09fdc6872b..070c72a77e 100644
--- a/runtime/doc/provider.txt
+++ b/runtime/doc/provider.txt
@@ -26,29 +26,34 @@ Nvim supports Python |remote-plugin|s and the Vim legacy |python2| and
Note: Only the Vim 7.3 legacy interface is supported, not later features such
as |python-bindeval| (Vim 7.4); use the Nvim API instead.
+
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*
@@ -69,8 +74,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
@@ -93,6 +99,7 @@ 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: >
@@ -100,6 +107,7 @@ To use Ruby plugins with Nvim, install the latest "neovim" RubyGem: >
Run |:checkhealth| to see if your system is up-to-date.
+
RUBY PROVIDER CONFIGURATION ~
*g:loaded_ruby_provider*
To disable Ruby support: >
@@ -122,6 +130,7 @@ 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: >
@@ -129,6 +138,7 @@ To use javascript remote-plugins with Nvim, install the "neovim" npm package: >
Run |:checkhealth| to see if your system is up-to-date.
+
NODEJS PROVIDER CONFIGURATION~
*g:loaded_node_provider*
To disable Node.js support: >