##// END OF EJS Templates
DOC: extensions: add documentation for the bundled extensions
Pauli Virtanen -
Show More
@@ -0,0 +1,7 b''
1 .. _extensions_autoreload:
2
3 ==========
4 autoreload
5 ==========
6
7 .. automodule:: IPython.extensions.autoreload
@@ -0,0 +1,7 b''
1 .. _extensions_parallelmagic:
2
3 =============
4 parallelmagic
5 =============
6
7 .. automodule:: IPython.extensions.parallelmagic
@@ -0,0 +1,7 b''
1 .. _extensions_sympyprinting:
2
3 =============
4 sympyprinting
5 =============
6
7 .. automodule:: IPython.extensions.sympyprinting
@@ -1,6 +1,27 b''
1 # encoding: utf-8
1 # encoding: utf-8
2 """
3 =============
4 parallelmagic
5 =============
6
7 Magic command interface for interactive parallel work.
8
9 Usage
10 =====
11
12 ``%autopx``
13
14 @AUTOPX_DOC@
2
15
3 """Magic command interface for interactive parallel work."""
16 ``%px``
17
18 @PX_DOC@
19
20 ``%result``
21
22 @RESULT_DOC@
23
24 """
4
25
5 #-----------------------------------------------------------------------------
26 #-----------------------------------------------------------------------------
6 # Copyright (C) 2008-2009 The IPython Development Team
27 # Copyright (C) 2008-2009 The IPython Development Team
@@ -284,6 +305,12 b' class ParalleMagic(Plugin):'
284 return False
305 return False
285
306
286
307
308 __doc__ = __doc__.replace('@AUTOPX_DOC@',
309 " " + ParalleMagic.magic_autopx.__doc__)
310 __doc__ = __doc__.replace('@PX_DOC@',
311 " " + ParalleMagic.magic_px.__doc__)
312 __doc__ = __doc__.replace('@RESULT_DOC@',
313 " " + ParalleMagic.magic_result.__doc__)
287
314
288
315
289 _loaded = False
316 _loaded = False
@@ -1,7 +1,14 b''
1 """A print function that pretty prints sympy Basic objects.
1 """
2 A print function that pretty prints sympy Basic objects.
3
4 :moduleauthor: Brian Granger
5
6 Usage
7 =====
8
9 Once the extension is loaded, Sympy Basic objects are automatically
10 pretty-printed.
2
11
3 Authors:
4 * Brian Granger
5 """
12 """
6 #-----------------------------------------------------------------------------
13 #-----------------------------------------------------------------------------
7 # Copyright (C) 2008-2011 The IPython Development Team
14 # Copyright (C) 2008-2011 The IPython Development Team
@@ -59,3 +59,13 b' To load that same extension at runtime, use the ``%load_ext`` magic:'
59 To summarize, in conjunction with configuration files and profiles, IPython
59 To summarize, in conjunction with configuration files and profiles, IPython
60 extensions give you complete and flexible control over your IPython
60 extensions give you complete and flexible control over your IPython
61 setup.
61 setup.
62
63 Extensions bundled with IPython
64 ===============================
65
66 .. toctree::
67 :maxdepth: 1
68
69 autoreload
70 parallelmagic
71 sympyprinting
@@ -8,7 +8,7 b' Configuration and customization'
8 :maxdepth: 2
8 :maxdepth: 2
9
9
10 overview.txt
10 overview.txt
11 extensions.txt
11 extensions/index.txt
12 plugins.txt
12 plugins.txt
13 ipython.txt
13 ipython.txt
14 editors.txt
14 editors.txt
General Comments 0
You need to be logged in to leave comments. Login now