https://github.com/jamescherti/vim-jedipydoc

Vim-jedipydoc: Show the Pydoc/Python Documentation of the item under the cursor
https://github.com/jamescherti/vim-jedipydoc

documentation-tool jedi python vim vim-plugin vim-plugins

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/jamescherti/vim-jedipydoc
• Owner: jamescherti
• License: mit
• Created: 2022-12-30T01:43:51.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-23T18:18:01.000Z (6 months ago)
• Last Synced: 2024-06-23T19:33:07.439Z (6 months ago)
• Topics: documentation-tool, jedi, python, vim, vim-plugin, vim-plugins
• Language: Vim Script
• Homepage:
• Size: 8.79 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
##################################################################################

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: ``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:

.. code-block:: vim

    let g:jedipydoc_documentation_command = 'K'

    let g:jedi#documentation_command = 'K'

Documentation

=============

Documentation is available in your vim: ``:help jedipydoc``.

Installation

============

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

------------------------------------------------------------------

.. code-block:: sh

    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:

.. code-block:: sh

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