##// END OF EJS Templates
updated IPython module organization descriptions...
Paul Ivanov -
Show More
@@ -11,16 +11,16 b' top-level IPython subpackages.'
11 11 Subpackage descriptions
12 12 =======================
13 13
14 * :mod:`IPython.config`. This package contains the configuration system of
15 IPython, as well as default configuration files for the different IPython
16 applications.
14 * :mod:`IPython.config`. This package contains the :ref:`configuration system
15 <config_index>` of IPython, as well as default configuration files for the
16 different IPython applications.
17 17
18 18 * :mod:`IPython.core`. This sub-package contains the core of the IPython
19 19 interpreter, but none of its extended capabilities.
20 20
21 21 * :mod:`IPython.deathrow`. This is for code that is outdated, untested,
22 22 rotting, or that belongs in a separate third party project. Eventually all
23 this code will either i) be revived by someone willing to maintain it with
23 this code will either 1) be revived by someone willing to maintain it with
24 24 tests and docs and re-included into IPython or 2) be removed from IPython
25 25 proper, but put into a separate third-party Python package. No new code will
26 26 be allowed here. If your favorite extension has been moved here please
@@ -39,18 +39,24 b' Subpackage descriptions'
39 39 Usually, these are short, single file modules.
40 40
41 41 * :mod:`IPython.frontend`. This package contains the various IPython
42 frontends. Currently, the code in this subpackage is very experimental and
43 may be broken.
44
45 * :mod:`IPython.gui`. Another semi-experimental wxPython based IPython GUI.
46
47 * :mod:`IPython.kernel`. This contains IPython's parallel computing system.
42 frontends which communicate with the :mod:`IPython.zmq` kernels (see
43 :ref:`Messaging in IPython <messaging>`). This includes the
44 :ref:`ipython notebook <htmlnotebook>`, :ref:`ipython qtconsole
45 <qtconsole>`, and :ref:`ipython console <two_process_console>` entry points.
48 46
49 47 * :mod:`IPython.lib`. IPython has many extended capabilities that are not part
50 48 of the IPython core. These things will go here and in. Modules in this
51 49 package are similar to extensions, but don't adhere to the official
52 50 IPython extension API.
53 51
52 * :mod:`IPython.nbformat`. This package contains code related to reading and
53 writing :ref:`IPython Notebook's <htmlnotebook>` file format (`.ipynb`
54 files).
55
56 * :mod:`IPython.parallel`. This contains :ref:`IPython's parallel computing
57 system <parallel_index>`. This previously lived under :mod:`IPython.kernel`,
58 but that module has been deprecated.
59
54 60 * :mod:`IPython.quarantine`. This is for code that doesn't meet IPython's
55 61 standards, but that we plan on keeping. To be moved out of this sub-package
56 62 a module needs to have approval of the core IPython developers, tests and
@@ -62,10 +68,18 b' Subpackage descriptions'
62 68 command line scripts. Eventually, these should be moved to the
63 69 :file:`scripts` subdirectory of the appropriate IPython subpackage.
64 70
71 * :mod:`IPython.testing`. This package contains code related to the IPython
72 test suite, which locates and executes the `tests` submodules of all
73 IPython sub-packages. It also contains decorators and utilities relevant for
74 testing.
75
65 76 * :mod:`IPython.utils`. This sub-package will contain anything that might
66 77 eventually be found in the Python standard library, like things in
67 78 :mod:`genutils`. Each sub-module in this sub-package should contain
68 79 functions and classes that serve a single purpose and that don't
69 80 depend on things in the rest of IPython.
70 81
82 * :mod:`IPython.zmq`. This sub-package contains code related to starting and
83 managing IPython kernels, which :mod:`IPython.frontend` instances can then
84 communicate with (see :ref:`Messaging in IPython <messaging>`).
71 85
@@ -100,6 +100,7 b' not need to make this decision when starting the server.'
100 100
101 101 See :ref:`the Notebook docs <htmlnotebook>` for technical details.
102 102
103 .. _two_process_console:
103 104
104 105 Two-process terminal console
105 106 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
General Comments 0
You need to be logged in to leave comments. Login now