##// END OF EJS Templates
Update docs on editors.
Thomas Kluyver -
Show More
@@ -6,7 +6,7 b' Editor configuration'
6 6
7 7 IPython can integrate with text editors in a number of different ways:
8 8
9 * Editors (such as (X)Emacs [Emacs]_, vim [vim]_ and TextMate [TextMate]_) can
9 * Editors (such as `(X)Emacs`_, vim_ and TextMate_) can
10 10 send code to IPython for execution.
11 11
12 12 * IPython's ``%edit`` magic command can open an editor of choice to edit
@@ -20,9 +20,8 b' start (that is, something other than a new instance of Emacs). This way you'
20 20 can edit multi-line code quickly and with the power of a real editor right
21 21 inside IPython.
22 22
23 You can also control the editor via the commmand-line option '-editor' or in
24 your configuration file, by setting the :attr:`InteractiveShell.editor`
25 configuration attribute.
23 You can also control the editor by setting :attr:`TerminalInteractiveShell.editor`
24 in :file:`ipython_config.py`.
26 25
27 26 TextMate
28 27 ========
@@ -30,21 +29,17 b' TextMate'
30 29 Currently, TextMate support in IPython is broken. It used to work well,
31 30 but the code has been moved to :mod:`IPython.quarantine` until it is updated.
32 31
33 vim configuration
34 =================
32 Vim
33 ===
35 34
36 Currently, vim support in IPython is broken. Like the TextMate code,
37 the vim support code has been moved to :mod:`IPython.quarantine` until it
38 is updated.
35 Paul Ivanov's `vim-ipython <https://github.com/ivanov/vim-ipython>`_ provides
36 powerful IPython integration for vim.
39 37
40 38 .. _emacs:
41 39
42 40 (X)Emacs
43 41 ========
44 42
45 Editor
46 ======
47
48 43 If you are a dedicated Emacs user, and want to use Emacs when IPython's
49 44 ``%edit`` magic command is called you should set up the Emacs server so that
50 45 new requests are handled by the original process. This means that almost no
@@ -94,6 +89,8 b' the previous section, you may need to set also in your :file:`.emacs` file::'
94 89
95 90 Notes on emacs support:
96 91
92 .. This looks hopelessly out of date - can someone update it?
93
97 94 * There is one caveat you should be aware of: you must start the IPython shell
98 95 before attempting to execute any code regions via ``C-c |``. Simply type
99 96 ``C-c !`` to start IPython before passing any code regions to the
@@ -112,6 +109,6 b' Notes on emacs support:'
112 109 will override what :file:`ipython.el` does (because loading the customization
113 110 variables comes later).
114 111
115 .. [Emacs] Emacs. http://www.gnu.org/software/emacs/
116 .. [TextMate] TextMate: the missing editor. http://macromates.com/
117 .. [vim] vim. http://www.vim.org/
112 .. _`(X)Emacs`: http://www.gnu.org/software/emacs/
113 .. _TextMate: http://macromates.com/
114 .. _vim: http://www.vim.org/
@@ -140,7 +140,8 b' All options with a [no] prepended can be specified in negated form'
140 140 feature is off by default [which means that you have both
141 141 normal reload() and dreload()].
142 142
143 ``--editor=<name>``
143 .. this isn't currently working
144 .. ``--editor=<name>``
144 145 Which editor to use with the %edit command. By default,
145 146 IPython will honor your EDITOR environment variable (if not
146 147 set, vi is the Unix default and notepad the Windows one).
General Comments 0
You need to be logged in to leave comments. Login now