VimPlug/jedi
1
0
Fork 1
mirror of https://github.com/davidhalter/jedi.git synced 2025-12-08 23:04:48 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Docs: End user usage improvements

Browse Source
This commit is contained in:
Dave Halter
2020-03-19 00:25:27 +01:00
parent 97117bfaf2
commit b1aef26464
2 changed files with 28 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
docs/docs/usage.rst
View File

@@ -3,13 +3,8 @@
End User Usage End User Usage
============== ==============
If you are a not an IDE Developer, the odds are that you just want to use |jedi| is can be used in a variety of plugins and software. It is also possible
|jedi| as a browser plugin or in the shell. Yes that's :ref:`also possible to use |jedi| in the :ref:`Python shell or with IPython <repl-completion>`.
<repl-completion>`!
|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:
@@ -17,60 +12,72 @@ developers.
Editor Plugins Editor Plugins
-------------- --------------
Vim: Vim
~~~
- jedi-vim_ - jedi-vim_
- YouCompleteMe_ - YouCompleteMe_
- deoplete-jedi_ - deoplete-jedi_
Visual Studio Code: Visual Studio Code
~~~~~~~~~~~~~~~~~~
- `Python Extension`_ - `Python Extension`_
Emacs: Emacs
~~~~~
- Jedi.el_ - Jedi.el_
- elpy_ - elpy_
- anaconda-mode_ - anaconda-mode_
Sublime Text 2/3: Sublime Text 2/3
~~~~~~~~~~~~~~~~
- SublimeJEDI_ (ST2 & ST3) - SublimeJEDI_ (ST2 & ST3)
- anaconda_ (only ST3) - anaconda_ (only ST3)
SynWrite: SynWrite
~~~~~~~~
- SynJedi_ - SynJedi_
TextMate: TextMate
~~~~~~~~
- Textmate_ (Not sure if it's actually working) - Textmate_ (Not sure if it's actually working)
Kate: Kate
~~~~
- Kate_ version 4.13+ `supports it natively - Kate_ version 4.13+ `supports it natively
<https://projects.kde.org/projects/kde/applications/kate/repository/entry/addons/kate/pate/src/plugins/python_autocomplete_jedi.py?rev=KDE%2F4.13>`__, <https://projects.kde.org/projects/kde/applications/kate/repository/entry/addons/kate/pate/src/plugins/python_autocomplete_jedi.py?rev=KDE%2F4.13>`__,
you have to enable it, though. you have to enable it, though.
Atom: Atom
~~~~
- autocomplete-python-jedi_ - autocomplete-python-jedi_
GNOME Builder: GNOME Builder
~~~~~~~~~~~~~
- `GNOME Builder`_ `supports it natively - `GNOME Builder`_ `supports it natively
<https://git.gnome.org/browse/gnome-builder/tree/plugins/jedi>`__, <https://git.gnome.org/browse/gnome-builder/tree/plugins/jedi>`__,
and is enabled by default. and is enabled by default.
Gedit: Gedit
~~~~~
- gedi_ - gedi_
Eric IDE: Eric IDE
~~~~~~~~
- `Eric IDE`_ (Available as a plugin) - `Eric IDE`_ (Available as a plugin)
Web Debugger: Web Debugger
~~~~~~~~~~~~
- wdb_ - wdb_
@@ -93,7 +100,7 @@ Using ``PYTHONSTARTUP``
.. automodule:: jedi.api.replstartup .. automodule:: jedi.api.replstartup
Using a custom ``$HOME/.pythonrc.py`` Using a Custom ``$HOME/.pythonrc.py``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autofunction:: jedi.utils.setup_readline .. autofunction:: jedi.utils.setup_readline

2
docs/global.rst
View File

@@ -1,3 +1,3 @@
:orphan: :orphan:
.. |jedi| replace:: *Jedi* .. |jedi| replace:: Jedi