From 3baf4a17114d0ac08934e3430d7aa9caba896aea Mon Sep 17 00:00:00 2001 From: David Halter Date: Sat, 31 Aug 2013 18:38:28 +0430 Subject: [PATCH] add repl stuff to usage docs --- docs/docs/repl.rst | 18 ------------------ docs/docs/usage.rst | 24 ++++++++++++++++++++++-- 2 files changed, 22 insertions(+), 20 deletions(-) delete mode 100644 docs/docs/repl.rst diff --git a/docs/docs/repl.rst b/docs/docs/repl.rst deleted file mode 100644 index aabba9ac..00000000 --- a/docs/docs/repl.rst +++ /dev/null @@ -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 diff --git a/docs/docs/usage.rst b/docs/docs/usage.rst index 2f548c9b..1834e4c7 100644 --- a/docs/docs/usage.rst +++ b/docs/docs/usage.rst @@ -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 ``! |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 `_ + + +.. _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