Skip to content

Loading…

DOC: extensions: add documentation for the bundled extensions #802

Merged
merged 1 commit into from

2 participants

@pv
pv commented

The extensions bundled with IPython are not currently listed in the documentation. Such a list would probably be quite useful for the users, so it's probably a good idea to add it.

Here's one way to do this. (You might want to remove the autoreload.txt part, unless #746 is merged first.)

@fperez
IPython member

Hey @pv, I'm really sorry but it doesn't merge ATM. Would you mind doing a quick rebase before so we can proceed with the review/merge?

Big apology for having waited so long it fell out of sync; I've just been swamped and haven't had much time for ipython.

@pv
pv commented

Hi @fperez, rebased now. No problem with the delay, I'm sure you have more than enough of things to do.

@fperez
IPython member

Thanks a lot for this one, @pv. Merging now.

@fperez fperez merged commit a28aa56 into ipython:master
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Oct 8, 2011
  1. @pv
View
29 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 @@ 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
View
13 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
View
7 docs/source/config/extensions/autoreload.txt
@@ -0,0 +1,7 @@
+.. _extensions_autoreload:
+
+==========
+autoreload
+==========
+
+.. automodule:: IPython.extensions.autoreload
View
10 docs/source/config/extensions.txt → 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
View
7 docs/source/config/extensions/parallelmagic.txt
@@ -0,0 +1,7 @@
+.. _extensions_parallelmagic:
+
+=============
+parallelmagic
+=============
+
+.. automodule:: IPython.extensions.parallelmagic
View
7 docs/source/config/extensions/sympyprinting.txt
@@ -0,0 +1,7 @@
+.. _extensions_sympyprinting:
+
+=============
+sympyprinting
+=============
+
+.. automodule:: IPython.extensions.sympyprinting
View
2 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
Something went wrong with that request. Please try again.