mirror of
https://github.com/davidhalter/jedi-vim.git
synced 2025-12-06 18:54:44 +08:00
Cosmetic and formatting fixes
- Remove images in introduction - Replace all occurences of VIM with Vim - Use Vim code blocks - Surround all keybindings with <>
This commit is contained in:
Patrice Peterson
108
doc/jedi-vim.txt
108
doc/jedi-vim.txt
@@ -6,7 +6,7 @@
|
||||
| `--' | | |____ | '--' || | \ / | | | | | |~
|
||||
\______/ |_______||_______/ |__| \__/ |__| |__| |__|~
|
||||
|
||||
jedi-vim - awesome Python autocompletion with VIM
|
||||
jedi-vim - awesome Python autocompletion with Vim
|
||||
**now in beta testing phase**
|
||||
|
||||
==============================================================================
|
||||
@@ -24,43 +24,37 @@ CONTENTS *jedi-vim-contents*
|
||||
==============================================================================
|
||||
1. Introduction *jedi-vim-introduction*
|
||||
|
||||
jedi-vim is a is a VIM binding to the awesome autocompletion library *Jedi*.
|
||||
|
||||
Here are some pictures:
|
||||
|
||||
.. image:: https://github.com/davidhalter/jedi/raw/master/docs/_screenshots/screenshot_complete.png
|
||||
|
||||
Completion for almost anything (Ctrl+Space).
|
||||
|
||||
.. image:: https://github.com/davidhalter/jedi/raw/master/docs/_screenshots/screenshot_function.png
|
||||
|
||||
Display of function/class bodies, docstrings.
|
||||
|
||||
.. image:: https://github.com/davidhalter/jedi/raw/master/docs/_screenshots/screenshot_pydoc.png
|
||||
|
||||
Pydoc support (with highlighting, Shift+k).
|
||||
|
||||
There is also support for goto and renaming.
|
||||
|
||||
jedi-vim is a is a Vim binding to the awesome autocompletion library `Jedi`.
|
||||
|
||||
- Completion for almost anything.
|
||||
- Display of function/class bodies, docstrings.
|
||||
- Pydoc support with highlighting.
|
||||
- Support for goto and renaming.
|
||||
|
||||
==============================================================================
|
||||
2. Installation *jedi-vim-installation*
|
||||
|
||||
Get the latest from `github <http://github.com/davidhalter/jedi-vim>`_.
|
||||
Get the latest from http://github.com/davidhalter/jedi-vim.
|
||||
|
||||
You can get the Jedi library `here <http://github.com/davidhalter/jedi>`_.
|
||||
You can get the Jedi library at http://github.com/davidhalter/jedi.
|
||||
|
||||
You might want to use `pathogen <https://github.com/tpope/vim-pathogen>`_ to
|
||||
install jedi in Vim. Also you need a VIM version that was compiled with
|
||||
``+python``, which is typical for most distributions on Linux.
|
||||
You might want to use Pathogen http://github.com/tpope/vim-pathogen to
|
||||
install Jedi in Vim. Also you need Vim compiled with +python, which is
|
||||
typical for most distributions on Linux.
|
||||
|
||||
The first thing you need after that is an up-to-date version of Jedi. You can
|
||||
either get it via ``pip install jedi`` or with ``git submodule update --init``
|
||||
either get it via >
|
||||
|
||||
pip install jedi
|
||||
|
||||
or with >
|
||||
|
||||
git submodule update --init
|
||||
|
||||
in your jedi-vim repository.
|
||||
|
||||
On Arch Linux, you can also install jedi-vim from AUR: `vim-jedi
|
||||
<https://aur.archlinux.org/packages/vim-jedi/>`__.
|
||||
On Arch Linux, you can also install jedi-vim from AUR, with the `vim-jedi`
|
||||
package.
|
||||
|
||||
==============================================================================
|
||||
3. Support *jedi-vim-support*
|
||||
@@ -71,8 +65,8 @@ generators, there is broad support.
|
||||
==============================================================================
|
||||
4. Usage *jedi-vim-usage*
|
||||
|
||||
The autocompletion can be used with <ctrl+space>, if you want it to work with
|
||||
<tab> you can use `supertab <https://github.com/ervandew/supertab>`_.
|
||||
The autocompletion can be used with <Ctrl-Space>, if you want it to work with
|
||||
<Tab> you can use the Supertab plugin.
|
||||
|
||||
==============================================================================
|
||||
5. Mappings *jedi-vim-mappings*
|
||||
@@ -81,80 +75,56 @@ The autocompletion can be used with <ctrl+space>, if you want it to work with
|
||||
6. Configuration *jedi-vim-configuration*
|
||||
|
||||
Jedi is by default automatically initialized. If you don't want that I suggest
|
||||
you disable the auto-initialization in your ``.vimrc``:
|
||||
|
||||
.. code-block:: vim
|
||||
you disable the auto-initialization in your .vimrc: >
|
||||
|
||||
let g:jedi#auto_initialization = 0
|
||||
|
||||
There are also some VIM options (like ``completeopt``) which are automatically
|
||||
initialized, if you don't want that:
|
||||
|
||||
.. code-block:: vim
|
||||
There are also some Vim options (like completeopt) which are automatically
|
||||
initialized, if you don't want that: >
|
||||
|
||||
let g:jedi#auto_vim_configuration = 0
|
||||
|
||||
The goto is by default on <leader g>. If you want to change that:
|
||||
|
||||
.. code-block:: vim
|
||||
The goto is by default on <leader-g>. If you want to change that: >
|
||||
|
||||
let g:jedi#goto_command = "<leader>g"
|
||||
|
||||
``get_definition`` is by default on <leader d>. If you want to change that:
|
||||
|
||||
.. code-block:: vim
|
||||
get_definition is by default on <leader-d>. If you want to change that: >
|
||||
|
||||
let g:jedi#get_definition_command = "<leader>d"
|
||||
|
||||
Showing the pydoc is by default on ``K`` If you want to change that:
|
||||
|
||||
.. code-block:: vim
|
||||
Showing the pydoc is by default on <K>. If you want to change that: >
|
||||
|
||||
let g:jedi#pydoc = "K"
|
||||
|
||||
If you are a person who likes to use VIM-buffers not tabs, you might want to
|
||||
put that in your ``.vimrc``:
|
||||
|
||||
.. code-block:: vim
|
||||
If you are a person who likes to use Vim buffers not tabs, you might want to
|
||||
put that in your .vimrc: >
|
||||
|
||||
let g:jedi#use_tabs_not_buffers = 0
|
||||
|
||||
Jedi automatically starts the completion, if you type a dot, e.g. ``str.``, if
|
||||
you don't want this:
|
||||
|
||||
.. code-block:: vim
|
||||
Jedi automatically starts the completion if you type a dot, e.g. "str.", if
|
||||
you don't want this: >
|
||||
|
||||
let g:jedi#popup_on_dot = 0
|
||||
|
||||
Jedi selects the first line of the completion menu: for a better typing-flow and
|
||||
usually saves one keypress.
|
||||
|
||||
.. code-block:: vim
|
||||
usually saves one keypress. >
|
||||
|
||||
let g:jedi#popup_select_first = 0
|
||||
|
||||
There's some support for refactoring:
|
||||
|
||||
.. code-block:: vim
|
||||
There's some support for refactoring: >
|
||||
|
||||
let g:jedi#rename_command = "<leader>r"
|
||||
|
||||
And you can list all names that are related (have the same origin):
|
||||
|
||||
.. code-block:: vim
|
||||
And you can list all names that are related (have the same origin): >
|
||||
|
||||
let g:jedi#related_names_command = "<leader>n"
|
||||
|
||||
If you want to change the default autocompletion command:
|
||||
If you want to change the default autocompletion command: >
|
||||
|
||||
.. code-block:: vim
|
||||
|
||||
let g:jedi#autocompletion_command = "<C-Space>"
|
||||
let g:jedi#autocompletion_command = "<c-space>"
|
||||
|
||||
By default you get a window that displays the function definition you're
|
||||
currently in. If you don't want that:
|
||||
|
||||
.. code-block:: vim
|
||||
currently in. If you don't want that: >
|
||||
|
||||
let g:jedi#show_function_definition = "0"
|
||||
|
||||
|
||||
Reference in New Issue
Block a user