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