##// END OF EJS Templates
documentation update
Paul Ivanov -
Show More
@@ -69,6 +69,9 b' ipython --profile=foo # start with profile foo'
69 ipython qtconsole # start the qtconsole GUI application
69 ipython qtconsole # start the qtconsole GUI application
70 ipython qtconsole -h # show the help string for the qtconsole subcmd
70 ipython qtconsole -h # show the help string for the qtconsole subcmd
71
71
72 ipython console # start the terminal-based console application
73 ipython console -h # show the help string for the console subcmd
74
72 ipython profile create foo # create profile foo w/ default config files
75 ipython profile create foo # create profile foo w/ default config files
73 ipython profile -h # show the help string for the profile subcmd
76 ipython profile -h # show the help string for the profile subcmd
74 """
77 """
@@ -209,7 +212,7 b' class TerminalIPythonApp(BaseIPythonApplication, InteractiveShellApp):'
209 """Launch the IPython Qt Console."""
212 """Launch the IPython Qt Console."""
210 ),
213 ),
211 notebook=('IPython.frontend.html.notebook.notebookapp.NotebookApp',
214 notebook=('IPython.frontend.html.notebook.notebookapp.NotebookApp',
212 """Launch the IPython HTML Notebook Server"""
215 """Launch the IPython HTML Notebook Server."""
213 ),
216 ),
214 profile = ("IPython.core.profileapp.ProfileApp",
217 profile = ("IPython.core.profileapp.ProfileApp",
215 "Create and manage IPython profiles."
218 "Create and manage IPython profiles."
@@ -217,8 +220,8 b' class TerminalIPythonApp(BaseIPythonApplication, InteractiveShellApp):'
217 kernel = ("IPython.zmq.ipkernel.IPKernelApp",
220 kernel = ("IPython.zmq.ipkernel.IPKernelApp",
218 "Start a kernel without an attached frontend."
221 "Start a kernel without an attached frontend."
219 ),
222 ),
220 zmq=('IPython.frontend.zmqterminal.app.ZMQTerminalIPythonApp',
223 console=('IPython.frontend.zmqterminal.app.ZMQTerminalIPythonApp',
221 """Launch two-process Terminal session with 0MQ."""
224 """Launch the IPython terminal-based Console."""
222 ),
225 ),
223 ))
226 ))
224
227
@@ -37,7 +37,7 b' from IPython.frontend.zmqterminal.interactiveshell import ZMQTerminalInteractive'
37
37
38 _examples = """
38 _examples = """
39 ipython console # start the ZMQ-based console
39 ipython console # start the ZMQ-based console
40 ipython console --pylab # start with pylab plotting mode
40 ipython console --existing # connect to an existing ipython session
41 """
41 """
42
42
43 #-----------------------------------------------------------------------------
43 #-----------------------------------------------------------------------------
@@ -63,11 +63,30 b' aliases.update(frontend_aliases)'
63
63
64
64
65 class ZMQTerminalIPythonApp(TerminalIPythonApp, IPythonMixinConsoleApp):
65 class ZMQTerminalIPythonApp(TerminalIPythonApp, IPythonMixinConsoleApp):
66 name = "ipython console"
66 """Start a terminal frontend to the IPython zmq kernel."""
67 """Start a terminal frontend to the IPython zmq kernel."""
67
68
69 description = """
70 The IPython terminal-based Console.
71
72 This launches a Console application inside a terminal.
73
74 The Console supports various extra features beyond the traditional
75 single-process Terminal IPython shell, such as connecting to an
76 existing ipython session, via:
77
78 ipython console --existing
79
80 where the previous session could have been created by another ipython
81 console, an ipython qtconsole, or by opening an ipython notebook.
82
83 """
84 examples = _examples
85
68 classes = List([IPKernelApp, ZMQTerminalInteractiveShell])
86 classes = List([IPKernelApp, ZMQTerminalInteractiveShell])
69 flags = Dict(flags)
87 flags = Dict(flags)
70 aliases = Dict(aliases)
88 aliases = Dict(aliases)
89 subcommands = Dict()
71 def parse_command_line(self, argv=None):
90 def parse_command_line(self, argv=None):
72 super(ZMQTerminalIPythonApp, self).parse_command_line(argv)
91 super(ZMQTerminalIPythonApp, self).parse_command_line(argv)
73 IPythonMixinConsoleApp.parse_command_line(self,argv)
92 IPythonMixinConsoleApp.parse_command_line(self,argv)
General Comments 0
You need to be logged in to leave comments. Login now