Skip to content
This repository

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

Merged
merged 1 commit into from over 2 years ago

2 participants

Pauli Virtanen Fernando Perez
Pauli Virtanen

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.)

Fernando Perez
Owner

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.

Pauli Virtanen
pv commented October 08, 2011

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

Fernando Perez
Owner

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

Fernando Perez fperez merged commit a28aa56 into from October 08, 2011
Fernando Perez fperez closed this October 08, 2011
Fernando Perez fperez referenced this pull request from a commit January 10, 2012
Commit has since been removed from the repository and is no longer available.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Showing 1 unique commit by 1 author.

Oct 08, 2011
Pauli Virtanen DOC: extensions: add documentation for the bundled extensions 1326c3f
This page is out of date. Refresh to see the latest.
29  IPython/extensions/parallelmagic.py
... ...
@@ -1,6 +1,27 @@
1 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 27
 #  Copyright (C) 2008-2009  The IPython Development Team
@@ -284,6 +305,12 @@ def pxrun_code(self, code_obj):
284 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 316
 _loaded = False
13  IPython/extensions/sympyprinting.py
... ...
@@ -1,7 +1,14 @@
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 14
 #  Copyright (C) 2008-2011  The IPython Development Team
7  docs/source/config/extensions/autoreload.txt
... ...
@@ -0,0 +1,7 @@
  1
+.. _extensions_autoreload:
  2
+
  3
+==========
  4
+autoreload
  5
+==========
  6
+
  7
+.. automodule:: IPython.extensions.autoreload
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:
59 59
 To summarize, in conjunction with configuration files and profiles, IPython
60 60
 extensions give you complete and flexible control over your IPython
61 61
 setup.
  62
+
  63
+Extensions bundled with IPython
  64
+===============================
  65
+
  66
+.. toctree::
  67
+   :maxdepth: 1
  68
+
  69
+   autoreload
  70
+   parallelmagic
  71
+   sympyprinting
7  docs/source/config/extensions/parallelmagic.txt
... ...
@@ -0,0 +1,7 @@
  1
+.. _extensions_parallelmagic:
  2
+
  3
+=============
  4
+parallelmagic
  5
+=============
  6
+
  7
+.. automodule:: IPython.extensions.parallelmagic
7  docs/source/config/extensions/sympyprinting.txt
... ...
@@ -0,0 +1,7 @@
  1
+.. _extensions_sympyprinting:
  2
+
  3
+=============
  4
+sympyprinting
  5
+=============
  6
+
  7
+.. automodule:: IPython.extensions.sympyprinting
2  docs/source/config/index.txt
@@ -8,7 +8,7 @@ Configuration and customization
8 8
    :maxdepth: 2
9 9
 
10 10
    overview.txt
11  
-   extensions.txt
  11
+   extensions/index.txt
12 12
    plugins.txt
13 13
    ipython.txt
14 14
    editors.txt
Commit_comment_tip

Tip: You can add notes to lines in a file. Hover to the left of a line to make a note

Something went wrong with that request. Please try again.