forked from VimPlug/jedi
Improved docs
This commit is contained in:
@@ -185,7 +185,6 @@ a.headerlink {
|
||||
|
||||
a.headerlink:hover {
|
||||
color: #444;
|
||||
background: #eaeaea;
|
||||
}
|
||||
|
||||
div.body p, div.body dd, div.body li {
|
||||
|
||||
@@ -1,9 +1,7 @@
|
||||
Jedi – Python autocompletion that works!
|
||||
========================================
|
||||
Jedi
|
||||
====
|
||||
|
||||
|
||||
About Jedi
|
||||
----------
|
||||
Release v\ |version|. (:doc:`Installation <installation>`)
|
||||
|
||||
.. automodule:: jedi
|
||||
:members:
|
||||
@@ -12,10 +10,10 @@ About Jedi
|
||||
Autocompletion can look like this (e.g. VIM plugin):
|
||||
|
||||
.. figure:: screenshot_complete.png
|
||||
:align: center
|
||||
|
||||
Contents
|
||||
--------
|
||||
|
||||
Docs
|
||||
----
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
@@ -23,16 +21,24 @@ Contents
|
||||
installation
|
||||
plugin-api
|
||||
|
||||
|
||||
Resources
|
||||
---------
|
||||
- `Source Code on github <https://github.com/davidhalter/jedi>`_
|
||||
- `Travis testing <https://travis-ci.org/davidhalter/jedi>`_
|
||||
- `Current PyPi package <http://pypi.python.org/pypi/jedi/>`_
|
||||
|
||||
Plugins using the Jedi library
|
||||
------------------------------
|
||||
- `Source Code on Github <https://github.com/davidhalter/jedi>`_
|
||||
- `Travis Testing <https://travis-ci.org/davidhalter/jedi>`_
|
||||
- `Python Package Index <http://pypi.python.org/pypi/jedi/>`_
|
||||
|
||||
- `VIM-Plugin <http://github.com/davidhalter/jedi-vim>`_
|
||||
- `Emacs-Plugin <https://github.com/tkf/emacs-jedi>`_
|
||||
- `Sublime-Plugin <https://github.com/svaiter/SublimeJEDI>`_ **Under construction**
|
||||
- `wdb (web debugger) <https://github.com/Kozea/wdb>`_
|
||||
|
||||
Text Editor Plugins
|
||||
-------------------
|
||||
|
||||
- `Vim <http://github.com/davidhalter/jedi-vim>`_
|
||||
- `Emacs <https://github.com/tkf/emacs-jedi>`_
|
||||
- `Sublime Text 2 <https://github.com/svaiter/SublimeJEDI>`_ (*under construction*)
|
||||
|
||||
|
||||
Other Software Using Jedi
|
||||
-------------------------
|
||||
|
||||
- `wdb <https://github.com/Kozea/wdb>`_
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
The plugin API
|
||||
The Plugin API
|
||||
==============
|
||||
|
||||
.. currentmodule:: jedi
|
||||
@@ -19,6 +19,7 @@ API Interface
|
||||
.. automodule:: api
|
||||
:undoc-members:
|
||||
|
||||
|
||||
API Return Classes
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
"""
|
||||
Jedi is an autocompletion library for Python. It offers additonal
|
||||
services such as goto / get_definition / pydoc support /
|
||||
get_in_function_call / related names.
|
||||
Jedi is an autocompletion library for Python. It offers additional services
|
||||
such as goto / get_definition / pydoc support / get_in_function_call / related
|
||||
names.
|
||||
|
||||
To give you a simple exmple how you can use the jedi library,
|
||||
here is an exmple for the autocompletion feature:
|
||||
To give you a simple example how you can use the jedi library, here is an
|
||||
example for the autocompletion feature:
|
||||
|
||||
>>> import jedi
|
||||
>>> source = '''import json; json.l'''
|
||||
@@ -19,9 +19,8 @@ here is an exmple for the autocompletion feature:
|
||||
>>> completions[0].word
|
||||
'load'
|
||||
|
||||
As you see Jedi is pretty simple and allows you to concentrate
|
||||
writing a good text editor, while still having very good IDE features
|
||||
for Python.
|
||||
As you see Jedi is pretty simple and allows you to concentrate writing a good
|
||||
text editor, while still having very good IDE features for Python.
|
||||
"""
|
||||
|
||||
import sys
|
||||
|
||||
Reference in New Issue
Block a user