add repl stuff to usage docs

This commit is contained in:
David Halter
2013-08-31 18:38:28 +04:30
parent d9b4218ca6
commit 3baf4a1711
2 changed files with 22 additions and 20 deletions

View File

@@ -1,18 +0,0 @@
.. include:: ../global.rst
Tab completion in the Python Shell
==================================
There are two different options how you can use Jedi autocompletion in
your Python interpreter. One with your custom ``$HOME/.pythonrc.py`` file
and one that uses ``PYTHONSTARTUP``.
Using ``PYTHONSTARTUP``
-----------------------
.. automodule:: jedi.replstartup
Using a custom ``$HOME/.pythonrc.py``
-------------------------------------
.. autofunction:: jedi.utils.setup_readline

View File

@@ -4,8 +4,8 @@ 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!
want to use |jedi| as a browser plugin or in the shell. Yes that's :ref:`also
possible <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
@@ -38,3 +38,23 @@ Other Software Using Jedi
-------------------------
- `wdb <https://github.com/Kozea/wdb>`_
.. _repl-completion:
Tab completion in the Python Shell
----------------------------------
There are two different options how you can use Jedi autocompletion in
your Python interpreter. One with your custom ``$HOME/.pythonrc.py`` file
and one that uses ``PYTHONSTARTUP``.
Using ``PYTHONSTARTUP``
~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: jedi.replstartup
Using a custom ``$HOME/.pythonrc.py``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autofunction:: jedi.utils.setup_readline