From b1aef264646c1c9321742a9effaf6b3b04f39d1f Mon Sep 17 00:00:00 2001 From: Dave Halter Date: Thu, 19 Mar 2020 00:25:27 +0100 Subject: [PATCH] Docs: End user usage improvements --- docs/docs/usage.rst | 47 ++++++++++++++++++++++++++------------------- docs/global.rst | 2 +- 2 files changed, 28 insertions(+), 21 deletions(-) diff --git a/docs/docs/usage.rst b/docs/docs/usage.rst index 3ebbb752..d9f3f7f9 100644 --- a/docs/docs/usage.rst +++ b/docs/docs/usage.rst @@ -3,13 +3,8 @@ End User Usage ============== -If you are a not an IDE Developer, the odds are that you just want to use -|jedi| as a browser plugin or in the shell. Yes that's :ref:`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. +|jedi| is can be used in a variety of plugins and software. It is also possible +to use |jedi| in the :ref:`Python shell or with IPython `. .. _editor-plugins: @@ -17,60 +12,72 @@ developers. Editor Plugins -------------- -Vim: +Vim +~~~ - jedi-vim_ - YouCompleteMe_ - deoplete-jedi_ -Visual Studio Code: +Visual Studio Code +~~~~~~~~~~~~~~~~~~ - `Python Extension`_ -Emacs: +Emacs +~~~~~ - Jedi.el_ - elpy_ - anaconda-mode_ -Sublime Text 2/3: +Sublime Text 2/3 +~~~~~~~~~~~~~~~~ - SublimeJEDI_ (ST2 & ST3) - anaconda_ (only ST3) -SynWrite: +SynWrite +~~~~~~~~ - SynJedi_ -TextMate: +TextMate +~~~~~~~~ - Textmate_ (Not sure if it's actually working) -Kate: +Kate +~~~~ - Kate_ version 4.13+ `supports it natively `__, you have to enable it, though. -Atom: +Atom +~~~~ - autocomplete-python-jedi_ -GNOME Builder: +GNOME Builder +~~~~~~~~~~~~~ - `GNOME Builder`_ `supports it natively `__, and is enabled by default. -Gedit: +Gedit +~~~~~ - gedi_ -Eric IDE: +Eric IDE +~~~~~~~~ - `Eric IDE`_ (Available as a plugin) -Web Debugger: +Web Debugger +~~~~~~~~~~~~ - wdb_ @@ -93,7 +100,7 @@ Using ``PYTHONSTARTUP`` .. automodule:: jedi.api.replstartup -Using a custom ``$HOME/.pythonrc.py`` +Using a Custom ``$HOME/.pythonrc.py`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. autofunction:: jedi.utils.setup_readline diff --git a/docs/global.rst b/docs/global.rst index 0279842a..c0c90b40 100644 --- a/docs/global.rst +++ b/docs/global.rst @@ -1,3 +1,3 @@ :orphan: -.. |jedi| replace:: *Jedi* +.. |jedi| replace:: Jedi