Show More
@@ -2,6 +2,11 b'' | |||
|
2 | 2 | """ |
|
3 | 3 | A base class for objects that are configurable. |
|
4 | 4 | |
|
5 | Inheritance diagram: | |
|
6 | ||
|
7 | .. inheritance-diagram:: IPython.config.configurable | |
|
8 | :parts: 3 | |
|
9 | ||
|
5 | 10 | Authors: |
|
6 | 11 | |
|
7 | 12 | * Brian Granger |
@@ -1,5 +1,10 b'' | |||
|
1 | 1 | """A simple configuration system. |
|
2 | 2 | |
|
3 | Inheritance diagram: | |
|
4 | ||
|
5 | .. inheritance-diagram:: IPython.config.loader | |
|
6 | :parts: 3 | |
|
7 | ||
|
3 | 8 | Authors |
|
4 | 9 | ------- |
|
5 | 10 | * Brian Granger |
@@ -1,6 +1,10 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """Display formatters. |
|
3 | 3 | |
|
4 | Inheritance diagram: | |
|
5 | ||
|
6 | .. inheritance-diagram:: IPython.core.formatters | |
|
7 | :parts: 3 | |
|
4 | 8 | |
|
5 | 9 | Authors: |
|
6 | 10 |
@@ -37,6 +37,11 b' arguments::' | |||
|
37 | 37 | -o OPTION, --option OPTION |
|
38 | 38 | An optional argument. |
|
39 | 39 | |
|
40 | Inheritance diagram: | |
|
41 | ||
|
42 | .. inheritance-diagram:: IPython.core.magic_arguments | |
|
43 | :parts: 3 | |
|
44 | ||
|
40 | 45 | ''' |
|
41 | 46 | #----------------------------------------------------------------------------- |
|
42 | 47 | # Copyright (C) 2010-2011, IPython Development Team. |
@@ -59,6 +59,11 b' ColorSchemeTable class. Currently the following exist:' | |||
|
59 | 59 | You can implement other color schemes easily, the syntax is fairly |
|
60 | 60 | self-explanatory. Please send back new schemes you develop to the author for |
|
61 | 61 | possible inclusion in future releases. |
|
62 | ||
|
63 | Inheritance diagram: | |
|
64 | ||
|
65 | .. inheritance-diagram:: IPython.core.ultratb | |
|
66 | :parts: 3 | |
|
62 | 67 | """ |
|
63 | 68 | |
|
64 | 69 | #***************************************************************************** |
@@ -1,6 +1,3 b'' | |||
|
1 | from __future__ import unicode_literals | |
|
2 | ||
|
3 | ||
|
4 | 1 |
|
|
5 | 2 | |
|
6 | 3 | This module implements a few classes for running Python scripts interactively |
@@ -10,7 +7,7 b' control to IPython.' | |||
|
10 | 7 | |
|
11 | 8 | |
|
12 | 9 | Provided classes |
|
13 | ================ | |
|
10 | ---------------- | |
|
14 | 11 | |
|
15 | 12 | The classes are (see their docstrings for further details): |
|
16 | 13 | |
@@ -33,9 +30,13 b' The classes are (see their docstrings for further details):' | |||
|
33 | 30 | - ClearDemo, ClearIPDemo: mixin-enabled versions of the Demo and IPythonDemo |
|
34 | 31 | classes. |
|
35 | 32 | |
|
33 | Inheritance diagram: | |
|
34 | ||
|
35 | .. inheritance-diagram:: IPython.lib.demo | |
|
36 | :parts: 3 | |
|
36 | 37 | |
|
37 | 38 | Subclassing |
|
38 | =========== | |
|
39 | ----------- | |
|
39 | 40 | |
|
40 | 41 | The classes here all include a few methods meant to make customization by |
|
41 | 42 | subclassing more convenient. Their docstrings below have some more details: |
@@ -50,7 +51,7 b' subclassing more convenient. Their docstrings below have some more details:' | |||
|
50 | 51 | |
|
51 | 52 | |
|
52 | 53 | Operation |
|
53 | ========= | |
|
54 | --------- | |
|
54 | 55 | |
|
55 | 56 | The file is run in its own empty namespace (though you can pass it a string of |
|
56 | 57 | arguments as if in a command line environment, and it will see those as |
@@ -123,10 +124,12 b' an IPython session, and type::' | |||
|
123 | 124 | and then follow the directions. |
|
124 | 125 | |
|
125 | 126 | Example |
|
126 | ======= | |
|
127 | ------- | |
|
127 | 128 | |
|
128 | 129 | The following is a very simple example of a valid demo file. |
|
129 | 130 | |
|
131 | :: | |
|
132 | ||
|
130 | 133 | #################### EXAMPLE DEMO <ex_demo.py> ############################### |
|
131 | 134 | '''A simple interactive demo to illustrate the use of IPython's Demo class.''' |
|
132 | 135 | |
@@ -164,6 +167,8 b" print 'bye!'" | |||
|
164 | 167 | ################### END EXAMPLE DEMO <ex_demo.py> ############################ |
|
165 | 168 | """ |
|
166 | 169 | |
|
170 | from __future__ import unicode_literals | |
|
171 | ||
|
167 | 172 | #***************************************************************************** |
|
168 | 173 | # Copyright (C) 2005-2006 Fernando Perez. <Fernando.Perez@colorado.edu> |
|
169 | 174 | # |
@@ -18,13 +18,11 b' contributed on the ipython-user list:' | |||
|
18 | 18 | |
|
19 | 19 | http://mail.scipy.org/pipermail/ipython-user/2006-May/003539.html |
|
20 | 20 | |
|
21 | ||
|
22 | NOTES: | |
|
21 | Notes | |
|
22 | ----- | |
|
23 | 23 | |
|
24 | 24 | - This module requires pexpect, available in most linux distros, or which can |
|
25 | be downloaded from | |
|
26 | ||
|
27 | http://pexpect.sourceforge.net | |
|
25 | be downloaded from http://pexpect.sourceforge.net | |
|
28 | 26 | |
|
29 | 27 | - Because pexpect only works under Unix or Windows-Cygwin, this has the same |
|
30 | 28 | limitations. This means that it will NOT work under native windows Python. |
@@ -1,8 +1,5 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """ |
|
3 | pretty | |
|
4 | ~~ | |
|
5 | ||
|
6 | 3 |
|
|
7 | 4 |
|
|
8 | 5 |
|
@@ -11,7 +8,7 b'' | |||
|
11 | 8 | |
|
12 | 9 | |
|
13 | 10 |
|
|
14 | ============= | |
|
11 | ------------- | |
|
15 | 12 | |
|
16 | 13 |
|
|
17 | 14 | |
@@ -25,7 +22,7 b'' | |||
|
25 | 22 | |
|
26 | 23 | |
|
27 | 24 |
|
|
28 | ========= | |
|
25 | --------- | |
|
29 | 26 | |
|
30 | 27 |
|
|
31 | 28 |
|
@@ -97,6 +94,11 b'' | |||
|
97 | 94 |
|
|
98 | 95 |
|
|
99 | 96 | |
|
97 | Inheritance diagram: | |
|
98 | ||
|
99 | .. inheritance-diagram:: IPython.lib.pretty | |
|
100 | :parts: 3 | |
|
101 | ||
|
100 | 102 |
|
|
101 | 103 |
|
|
102 | 104 |
|
@@ -2,6 +2,11 b'' | |||
|
2 | 2 | |
|
3 | 3 | """Classes and functions for kernel related errors and exceptions. |
|
4 | 4 | |
|
5 | Inheritance diagram: | |
|
6 | ||
|
7 | .. inheritance-diagram:: IPython.parallel.error | |
|
8 | :parts: 3 | |
|
9 | ||
|
5 | 10 | Authors: |
|
6 | 11 | |
|
7 | 12 | * Brian Granger |
@@ -1,6 +1,11 b'' | |||
|
1 | 1 | # encoding: utf-8 |
|
2 | 2 | """ |
|
3 | 3 | Utilities for working with strings and text. |
|
4 | ||
|
5 | Inheritance diagram: | |
|
6 | ||
|
7 | .. inheritance-diagram:: IPython.utils.text | |
|
8 | :parts: 3 | |
|
4 | 9 | """ |
|
5 | 10 | |
|
6 | 11 | #----------------------------------------------------------------------------- |
@@ -28,6 +28,11 b' We choose to create this module because we need these capabilities, but' | |||
|
28 | 28 | we need them to be pure Python so they work in all Python implementations, |
|
29 | 29 | including Jython and IronPython. |
|
30 | 30 | |
|
31 | Inheritance diagram: | |
|
32 | ||
|
33 | .. inheritance-diagram:: IPython.utils.traitlets | |
|
34 | :parts: 3 | |
|
35 | ||
|
31 | 36 | Authors: |
|
32 | 37 | |
|
33 | 38 | * Brian Granger |
@@ -219,11 +219,6 b' class ApiDocWriter(object):' | |||
|
219 | 219 | chap_title = ':mod:`' + uri_short + '`' |
|
220 | 220 | ad += chap_title + '\n' + self.rst_section_levels[1] * len(chap_title) |
|
221 | 221 | |
|
222 | if len(classes): | |
|
223 | ad += '\nInheritance diagram for ``%s``:\n\n' % uri | |
|
224 | ad += '.. inheritance-diagram:: %s \n' % uri | |
|
225 | ad += ' :parts: 3\n' | |
|
226 | ||
|
227 | 222 | ad += '\n.. automodule:: ' + uri + '\n' |
|
228 | 223 | ad += '\n.. currentmodule:: ' + uri + '\n' |
|
229 | 224 | multi_class = len(classes) > 1 |
General Comments 0
You need to be logged in to leave comments.
Login now