diff --git a/IPython/extensions/parallelmagic.py b/IPython/extensions/parallelmagic.py index c69066c..eb30a2b 100644 --- a/IPython/extensions/parallelmagic.py +++ b/IPython/extensions/parallelmagic.py @@ -1,6 +1,27 @@ # encoding: utf-8 +""" +============= +parallelmagic +============= + +Magic command interface for interactive parallel work. + +Usage +===== + +``%autopx`` + +@AUTOPX_DOC@ -"""Magic command interface for interactive parallel work.""" +``%px`` + +@PX_DOC@ + +``%result`` + +@RESULT_DOC@ + +""" #----------------------------------------------------------------------------- # Copyright (C) 2008-2009 The IPython Development Team @@ -284,6 +305,12 @@ class ParalleMagic(Plugin): return False +__doc__ = __doc__.replace('@AUTOPX_DOC@', + " " + ParalleMagic.magic_autopx.__doc__) +__doc__ = __doc__.replace('@PX_DOC@', + " " + ParalleMagic.magic_px.__doc__) +__doc__ = __doc__.replace('@RESULT_DOC@', + " " + ParalleMagic.magic_result.__doc__) _loaded = False diff --git a/IPython/extensions/sympyprinting.py b/IPython/extensions/sympyprinting.py index ba3b51e..a7c4a43 100644 --- a/IPython/extensions/sympyprinting.py +++ b/IPython/extensions/sympyprinting.py @@ -1,7 +1,14 @@ -"""A print function that pretty prints sympy Basic objects. +""" +A print function that pretty prints sympy Basic objects. + +:moduleauthor: Brian Granger + +Usage +===== + +Once the extension is loaded, Sympy Basic objects are automatically +pretty-printed. -Authors: -* Brian Granger """ #----------------------------------------------------------------------------- # Copyright (C) 2008-2011 The IPython Development Team diff --git a/docs/source/config/extensions/autoreload.txt b/docs/source/config/extensions/autoreload.txt new file mode 100644 index 0000000..619605e --- /dev/null +++ b/docs/source/config/extensions/autoreload.txt @@ -0,0 +1,7 @@ +.. _extensions_autoreload: + +========== +autoreload +========== + +.. automodule:: IPython.extensions.autoreload diff --git a/docs/source/config/extensions.txt b/docs/source/config/extensions/index.txt similarity index 92% rename from docs/source/config/extensions.txt rename to docs/source/config/extensions/index.txt index 69284e3..561397d 100644 --- a/docs/source/config/extensions.txt +++ b/docs/source/config/extensions/index.txt @@ -59,3 +59,13 @@ To load that same extension at runtime, use the ``%load_ext`` magic: To summarize, in conjunction with configuration files and profiles, IPython extensions give you complete and flexible control over your IPython setup. + +Extensions bundled with IPython +=============================== + +.. toctree:: + :maxdepth: 1 + + autoreload + parallelmagic + sympyprinting diff --git a/docs/source/config/extensions/parallelmagic.txt b/docs/source/config/extensions/parallelmagic.txt new file mode 100644 index 0000000..10716a9 --- /dev/null +++ b/docs/source/config/extensions/parallelmagic.txt @@ -0,0 +1,7 @@ +.. _extensions_parallelmagic: + +============= +parallelmagic +============= + +.. automodule:: IPython.extensions.parallelmagic diff --git a/docs/source/config/extensions/sympyprinting.txt b/docs/source/config/extensions/sympyprinting.txt new file mode 100644 index 0000000..d32f6db --- /dev/null +++ b/docs/source/config/extensions/sympyprinting.txt @@ -0,0 +1,7 @@ +.. _extensions_sympyprinting: + +============= +sympyprinting +============= + +.. automodule:: IPython.extensions.sympyprinting diff --git a/docs/source/config/index.txt b/docs/source/config/index.txt index 0ceaf33..1d9ebed 100644 --- a/docs/source/config/index.txt +++ b/docs/source/config/index.txt @@ -8,7 +8,7 @@ Configuration and customization :maxdepth: 2 overview.txt - extensions.txt + extensions/index.txt plugins.txt ipython.txt editors.txt