Code Monkey home page Code Monkey logo

vim-jedipydoc's Introduction

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

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

vim-jedipydoc's People

Contributors

jamescherti avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.