Improved docs

This commit is contained in:
Danilo Bargen
2012-12-30 01:45:12 +01:00
parent beba40e920
commit a215171750
4 changed files with 32 additions and 27 deletions

View File

@@ -185,7 +185,6 @@ a.headerlink {
a.headerlink:hover { a.headerlink:hover {
color: #444; color: #444;
background: #eaeaea;
} }
div.body p, div.body dd, div.body li { div.body p, div.body dd, div.body li {

View File

@@ -1,9 +1,7 @@
Jedi Python autocompletion that works! Jedi
======================================== ====
Release v\ |version|. (:doc:`Installation <installation>`)
About Jedi
----------
.. automodule:: jedi .. automodule:: jedi
:members: :members:
@@ -12,10 +10,10 @@ About Jedi
Autocompletion can look like this (e.g. VIM plugin): Autocompletion can look like this (e.g. VIM plugin):
.. figure:: screenshot_complete.png .. figure:: screenshot_complete.png
:align: center
Contents
-------- Docs
----
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
@@ -23,16 +21,24 @@ Contents
installation installation
plugin-api plugin-api
Resources 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>`_ Text Editor Plugins
- `Sublime-Plugin <https://github.com/svaiter/SublimeJEDI>`_ **Under construction** -------------------
- `wdb (web debugger) <https://github.com/Kozea/wdb>`_
- `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>`_

View File

@@ -1,4 +1,4 @@
The plugin API The Plugin API
============== ==============
.. currentmodule:: jedi .. currentmodule:: jedi
@@ -19,6 +19,7 @@ API Interface
.. automodule:: api .. automodule:: api
:undoc-members: :undoc-members:
API Return Classes API Return Classes
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~

View File

@@ -1,10 +1,10 @@
""" """
Jedi is an autocompletion library for Python. It offers additonal Jedi is an autocompletion library for Python. It offers additional services
services such as goto / get_definition / pydoc support / such as goto / get_definition / pydoc support / get_in_function_call / related
get_in_function_call / related names. names.
To give you a simple exmple how you can use the jedi library, To give you a simple example how you can use the jedi library, here is an
here is an exmple for the autocompletion feature: example for the autocompletion feature:
>>> import jedi >>> import jedi
>>> source = '''import json; json.l''' >>> source = '''import json; json.l'''
@@ -19,9 +19,8 @@ here is an exmple for the autocompletion feature:
>>> completions[0].word >>> completions[0].word
'load' 'load'
As you see Jedi is pretty simple and allows you to concentrate As you see Jedi is pretty simple and allows you to concentrate writing a good
writing a good text editor, while still having very good IDE features text editor, while still having very good IDE features for Python.
for Python.
""" """
import sys import sys