Permalink
Browse files

Merge pull request #802 from pv/enh/extension-docs

Lists the extensions that are bundled with IPython in our docs.
  • Loading branch information...
2 parents 9b088e7 + 1326c3f commit a28aa56c7031c7029b90269f49bf8e344eeb83b5 @fperez fperez committed Oct 9, 2011
@@ -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 @@ def pxrun_code(self, code_obj):
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
@@ -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
@@ -0,0 +1,7 @@
+.. _extensions_autoreload:
+
+==========
+autoreload
+==========
+
+.. automodule:: IPython.extensions.autoreload
@@ -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
@@ -0,0 +1,7 @@
+.. _extensions_parallelmagic:
+
+=============
+parallelmagic
+=============
+
+.. automodule:: IPython.extensions.parallelmagic
@@ -0,0 +1,7 @@
+.. _extensions_sympyprinting:
+
+=============
+sympyprinting
+=============
+
+.. automodule:: IPython.extensions.sympyprinting
@@ -8,7 +8,7 @@ Configuration and customization
:maxdepth: 2
overview.txt
- extensions.txt
+ extensions/index.txt
plugins.txt
ipython.txt
editors.txt

0 comments on commit a28aa56

Please sign in to comment.