From e6ef96412e7a2cfa1c3b8796c8ed852c909fc527 Mon Sep 17 00:00:00 2001 From: Patrice Peterson Date: Fri, 1 Mar 2013 15:42:31 +0100 Subject: [PATCH] Add vimdoc documentation For now, this is just the README.rst file with appropriate sections. The content of the file itself is completely unchanged. Section name suggestions are taken from Steve Losh's Learn Vimscript the Hard Way [1]. Formatting suggestions are taken from Vim's own documentation on writing help files (:help help-writing). The spiffy header was created using the figlet program [2] and the starwars.flf font found in the figlet fonts database [3]. [1] http://learnvimscriptthehardway.stevelosh.com/chapters/54.html [2] http://www.figlet.org [3] http://www.figlet.org/fonts/starwars.flf --- doc/jedi-vim.txt | 167 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 167 insertions(+) create mode 100644 doc/jedi-vim.txt diff --git a/doc/jedi-vim.txt b/doc/jedi-vim.txt new file mode 100644 index 0000000..aa22352 --- /dev/null +++ b/doc/jedi-vim.txt @@ -0,0 +1,167 @@ +*jedi-vim.txt* - For Vim version 7.3 - Last change: 2013/3/1 + __ _______ _______ __ ____ ____ __ .___ ___.~ + | | | ____|| \ | | \ \ / / | | | \/ |~ + | | | |__ | .--. || | _____\ \/ / | | | \ / |~ +.--. | | | __| | | | || | |______\ / | | | |\/| |~ +| `--' | | |____ | '--' || | \ / | | | | | |~ + \______/ |_______||_______/ |__| \__/ |__| |__| |__|~ + + jedi-vim - awesome Python autocompletion with VIM + **now in beta testing phase** + +============================================================================== +CONTENTS *jedi-vim-contents* + + 1. Introduction |jedi-vim-introduction| + 2. Installation |jedi-vim-installation| + 3. Support |jedi-vim-support| + 4. Usage |jedi-vim-usage| + 5. Mappings |jedi-vim-mappings| + 6. Configuration |jedi-vim-configuration| + 7. Contributing |jedi-vim-contributing| + + +============================================================================== +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. + + + +============================================================================== +2. Installation *jedi-vim-installation* + +Get the latest from `github `_. + +You can get the Jedi library `here `_. + +You might want to use `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. + +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`` +in your jedi-vim repository. + +On Arch Linux, you can also install jedi-vim from AUR: `vim-jedi +`__. + +============================================================================== +3. Support *jedi-vim-support* + +The Jedi library supports most of Python's core features. From decorators to +generators, there is broad support. + +============================================================================== +4. Usage *jedi-vim-usage* + +The autocompletion can be used with , if you want it to work with + you can use `supertab `_. + +============================================================================== +5. Mappings *jedi-vim-mappings* + +============================================================================== +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 + + 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 + + let g:jedi#auto_vim_configuration = 0 + +The goto is by default on . If you want to change that: + +.. code-block:: vim + + let g:jedi#goto_command = "g" + +``get_definition`` is by default on . If you want to change that: + +.. code-block:: vim + + let g:jedi#get_definition_command = "d" + +Showing the pydoc is by default on ``K`` If you want to change that: + +.. code-block:: vim + + 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 + + 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 + + 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 + + let g:jedi#popup_select_first = 0 + +There's some support for refactoring: + +.. code-block:: vim + + let g:jedi#rename_command = "r" + +And you can list all names that are related (have the same origin): + +.. code-block:: vim + + let g:jedi#related_names_command = "n" + +If you want to change the default autocompletion command: + +.. code-block:: vim + + let g:jedi#autocompletion_command = "" + +By default you get a window that displays the function definition you're +currently in. If you don't want that: + +.. code-block:: vim + + let g:jedi#show_function_definition = "0" + +============================================================================== +7. Contributing *jedi-vim-contributing* + +If you have any comments or feature requests, please tell me! I really want +to know, what you think about Jedi and jedi-vim. + + vim: textwidth=78 tabstop=8 filetype=help:norightleft: