jamescherti / vim-jedipydoc

Vim-jedipydoc: Show the Pydoc/Python Documentation of the item under the cursor

vim-jedipydoc - Show the Pydoc/Python documentation for the item under the cursor

Jedipydoc is a Vim plugin that allows showing the Pydoc documentation of the item under the cursor: In a new tab (default) or in a horizontal split.

Default key mapping: <Leader>K.

Vim-jedipydoc Git repository: https://github.com/jamescherti/vim-jedipydoc

Author and license

• Author: James Cherti
• License: MIT

Requirements

Jedipydoc requires the Vim plugin Jedi-vim.

Change the default key mapping

Add the following lines to your ~/.vimrc if you wish to use the same key mapping as Jedi-vim:

let g:jedipydoc_documentation_command = 'K'
let g:jedi#documentation_command = '<Leader>K'

Documentation

Documentation is available in your vim: :help jedipydoc.

Installation

Installation with Vim's built-in package manager (Vim 8 and above)

bash
mkdir -p ~/.vim/pack/jamescherti/start
cd ~/.vim/pack/jamescherti/start
git clone --depth 1 https://github.com/jamescherti/vim-jedipydoc
vim -u NONE -c "helptags vim-jedipydoc/doc" -c q

Installation with a third-party plugin manager

You might want to use pathogen or Vundle to install jedipydoc.

The first thing you need after that is an up-to-date version of Jedi. Install git submodule update --init --recursive in your jedipydoc repository.

Example installation command using Pathogen:

git clone --recursive https://github.com/jamescherti/jedipydoc.git ~/.vim/bundle/jedipydoc