From d9b4218ca6c6ab9183d410a13840901c87fb35d2 Mon Sep 17 00:00:00 2001 From: David Halter Date: Sat, 31 Aug 2013 18:26:45 +0430 Subject: [PATCH] Jedi usage chapter as a first chapter for Jedis documentation. --- docs/docs/usage.rst | 40 ++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 29 +---------------------------- 2 files changed, 41 insertions(+), 28 deletions(-) create mode 100644 docs/docs/usage.rst diff --git a/docs/docs/usage.rst b/docs/docs/usage.rst new file mode 100644 index 00000000..2f548c9b --- /dev/null +++ b/docs/docs/usage.rst @@ -0,0 +1,40 @@ +.. include:: ../global.rst + +End User Usage +============== + +If you are a not an IDE Developer, than chances are pretty high, that you just +want to use |jedi| as a browser plugin or in the shell. Yes that's also +possible! + +|jedi| is relatively young and can be used in a variety of Plugins and +Software. If your Editor/IDE is not among them, recommend |jedi| to your IDE +developers. + + +.. _editor-plugins: + +Editor Plugins +-------------- + +Vim: + +- `jedi-vim `_ +- `YouCompleteMe `_ + +Emacs: + +- `Jedi.el `_ + +Sublime Text 2/3: + +- `SublimeJEDI `_ (ST2 & ST3) +- `anaconda `_ (only ST3) + + +.. _other-software: + +Other Software Using Jedi +------------------------- + +- `wdb `_ diff --git a/docs/index.rst b/docs/index.rst index 6779a860..a1c42fd6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -20,6 +20,7 @@ Docs .. toctree:: :maxdepth: 2 + docs/usage docs/installation docs/features docs/repl @@ -40,31 +41,3 @@ Resources - `Source Code on Github `_ - `Travis Testing `_ - `Python Package Index `_ - - -.. _editor-plugins: - -Editor Plugins --------------- - -Vim: - -- `jedi-vim `_ -- `YouCompleteMe `_ - -Emacs: - -- `Jedi.el `_ - -Sublime Text 2/3: - -- `SublimeJEDI `_ (ST2 & ST3) -- `anaconda `_ (only ST3) - - -.. _other-software: - -Other Software Using Jedi -------------------------- - -- `wdb `_