From a2151717502a08441e354639c6b10da9a3be35b2 Mon Sep 17 00:00:00 2001 From: Danilo Bargen Date: Sun, 30 Dec 2012 01:45:12 +0100 Subject: [PATCH] Improved docs --- docs/source/_themes/flask/static/flasky.css_t | 1 - docs/source/index.rst | 40 +++++++++++-------- docs/source/plugin-api.rst | 3 +- jedi/__init__.py | 15 ++++--- 4 files changed, 32 insertions(+), 27 deletions(-) diff --git a/docs/source/_themes/flask/static/flasky.css_t b/docs/source/_themes/flask/static/flasky.css_t index b5ca39bc..79ab4787 100644 --- a/docs/source/_themes/flask/static/flasky.css_t +++ b/docs/source/_themes/flask/static/flasky.css_t @@ -185,7 +185,6 @@ a.headerlink { a.headerlink:hover { color: #444; - background: #eaeaea; } div.body p, div.body dd, div.body li { diff --git a/docs/source/index.rst b/docs/source/index.rst index d12298a0..4d79d3cb 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,9 +1,7 @@ -Jedi – Python autocompletion that works! -======================================== +Jedi +==== - -About Jedi ----------- +Release v\ |version|. (:doc:`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 `_ -- `Travis testing `_ -- `Current PyPi package `_ -Plugins using the Jedi library ------------------------------- +- `Source Code on Github `_ +- `Travis Testing `_ +- `Python Package Index `_ -- `VIM-Plugin `_ -- `Emacs-Plugin `_ -- `Sublime-Plugin `_ **Under construction** -- `wdb (web debugger) `_ + +Text Editor Plugins +------------------- + +- `Vim `_ +- `Emacs `_ +- `Sublime Text 2 `_ (*under construction*) + + +Other Software Using Jedi +------------------------- + +- `wdb `_ diff --git a/docs/source/plugin-api.rst b/docs/source/plugin-api.rst index eb8b1d71..f5bc1aa2 100644 --- a/docs/source/plugin-api.rst +++ b/docs/source/plugin-api.rst @@ -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 ~~~~~~~~~~~~~~~~~~ diff --git a/jedi/__init__.py b/jedi/__init__.py index a9e4a2f8..a25554e9 100644 --- a/jedi/__init__.py +++ b/jedi/__init__.py @@ -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