aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/nvim_python.txt
diff options
context:
space:
mode:
authorThiago de Arruda <tpadilha84@gmail.com>2014-09-13 21:49:18 -0300
committerThiago de Arruda <tpadilha84@gmail.com>2014-09-13 21:49:18 -0300
commit06390208f3480f108591988602c46d4926a2e9ae (patch)
tree423b21b9426174218360d4f30c69bf5b58fc2f4d /runtime/doc/nvim_python.txt
parent5778c25c019f01c3e0249da18398abdca3f9b002 (diff)
parent84aff1da6ad8607f67156a810028cdfb0ffedc9f (diff)
downloadrneovim-06390208f3480f108591988602c46d4926a2e9ae.tar.gz
rneovim-06390208f3480f108591988602c46d4926a2e9ae.tar.bz2
rneovim-06390208f3480f108591988602c46d4926a2e9ae.zip
Merge PR #1163 'Initial documentation of nvim features'
Diffstat (limited to 'runtime/doc/nvim_python.txt')
-rw-r--r--runtime/doc/nvim_python.txt40
1 files changed, 40 insertions, 0 deletions
diff --git a/runtime/doc/nvim_python.txt b/runtime/doc/nvim_python.txt
new file mode 100644
index 0000000000..bb644507f7
--- /dev/null
+++ b/runtime/doc/nvim_python.txt
@@ -0,0 +1,40 @@
+*nvim_python.txt* For Nvim. {Nvim}
+
+
+ NVIM REFERENCE MANUAL by Thiago de Arruda
+
+
+Python plugins and scripting in Nvim *nvim-python*
+
+1. Introduction |nvim-python-intro|
+2. Quickstart |nvim-python-quickstart|
+
+==============================================================================
+1. Introduction *nvim-python-intro*
+
+Through an external python interpreter connected via |msgpack-rpc|, Nvim
+offers some support for the classic |python-vim| interface. For now only the
+old Vim 7.3 API is supported.
+
+==============================================================================
+2. Quickstart *nvim-python-quickstart*
+
+If you just want to start using python plugins with Nvim quickly, here's a
+simple step-by-step:
+
+- Make sure python 2.6 or 2.7 is available on your `$PATH`
+- Install the `neovim` python package:
+ >
+ $ pip install neovim
+<
+- Add the following snippet to your `vimrc`, before any python plugins are
+ loaded:
+>
+ if has('neovim')
+ runtime! plugin/python_setup.vim
+ endif
+<
+Most python plugins created for Vim 7.3 should work after these steps.
+
+==============================================================================
+ vim:tw=78:ts=8:noet:ft=help:norl: