Jedi usage chapter as a first chapter for Jedis documentation.

This commit is contained in:
David Halter
2013-08-31 18:26:45 +04:30
parent 39e766c2eb
commit d9b4218ca6
2 changed files with 41 additions and 28 deletions

40
docs/docs/usage.rst Normal file
View File

@@ -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 <http://github.com/davidhalter/jedi-vim>`_
- `YouCompleteMe <http://valloric.github.io/YouCompleteMe/>`_
Emacs:
- `Jedi.el <https://github.com/tkf/emacs-jedi>`_
Sublime Text 2/3:
- `SublimeJEDI <https://github.com/srusskih/SublimeJEDI>`_ (ST2 & ST3)
- `anaconda <https://github.com/DamnWidget/anaconda>`_ (only ST3)
.. _other-software:
Other Software Using Jedi
-------------------------
- `wdb <https://github.com/Kozea/wdb>`_

View File

@@ -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 <https://github.com/davidhalter/jedi>`_
- `Travis Testing <https://travis-ci.org/davidhalter/jedi>`_
- `Python Package Index <http://pypi.python.org/pypi/jedi/>`_
.. _editor-plugins:
Editor Plugins
--------------
Vim:
- `jedi-vim <http://github.com/davidhalter/jedi-vim>`_
- `YouCompleteMe <http://valloric.github.io/YouCompleteMe/>`_
Emacs:
- `Jedi.el <https://github.com/tkf/emacs-jedi>`_
Sublime Text 2/3:
- `SublimeJEDI <https://github.com/srusskih/SublimeJEDI>`_ (ST2 & ST3)
- `anaconda <https://github.com/DamnWidget/anaconda>`_ (only ST3)
.. _other-software:
Other Software Using Jedi
-------------------------
- `wdb <https://github.com/Kozea/wdb>`_