##// END OF EJS Templates
Update docs with Tornado info.
Fernando Perez -
Show More
@@ -265,9 +265,9 b' iptest command:'
265 265 pexpect
266 266 -------
267 267
268 The pexpect package is used in IPython's :command:`irunner` script, as well as
269 for managing subprocesses [pexpect]_. IPython now includes a version of pexpect
270 in :mod:`IPython.external`, but if you have installed pexpect, IPython will use
268 The pexpect_ package is used in IPython's :command:`irunner` script, as well as
269 for managing subprocesses. IPython now includes a version of pexpect in
270 :mod:`IPython.external`, but if you have installed pexpect, IPython will use
271 271 that instead. On Unix platforms (including OS X), just do:
272 272
273 273 .. code-block:: bash
@@ -296,7 +296,7 b' On a Unix style platform (including OS X), if you want to use'
296 296
297 297 Security in IPython.parallel is provided by SSH tunnels. By default, Linux
298 298 and OSX clients will use the shell ssh command, but on Windows, we also
299 support tunneling with paramiko [paramiko]_.
299 support tunneling with paramiko_.
300 300
301 301 Dependencies for IPython.zmq
302 302 ============================
@@ -305,9 +305,9 b' pyzmq'
305 305 -----
306 306
307 307 IPython 0.11 introduced some new functionality, including a two-process
308 execution model using ZeroMQ for communication [ZeroMQ]_. The Python bindings
309 to ZeroMQ are found in the pyzmq project [PyZMQ]_, which is easy_install-able once you
310 have ZeroMQ installed. If you are on Python 2.6 or 2.7 on OSX, or 2.7 on Windows,
308 execution model using ZeroMQ_ for communication. The Python bindings to ZeroMQ
309 are found in the PyZMQ_ project, which is easy_install-able once you have
310 ZeroMQ installed. If you are on Python 2.6 or 2.7 on OSX, or 2.7 on Windows,
311 311 pyzmq has eggs that include ZeroMQ itself.
312 312
313 313 IPython.zmq depends on pyzmq >= 2.1.4.
@@ -318,23 +318,24 b' Dependencies for the IPython QT console'
318 318 pyzmq
319 319 -----
320 320
321 Like the :mod:`IPython.parallel` package,
322 the QT Console requires ZeroMQ and PyZMQ.
321 Like the :mod:`IPython.parallel` package, the QT Console requires ZeroMQ and
322 PyZMQ.
323 323
324 324 Qt
325 325 --
326 326
327 Also with 0.11, a new GUI was added using the work in :mod:`IPython.zmq`,
328 which can be launched with ``ipython qtconsole``. The GUI is built on Qt, and works
329 with either PyQt, which can be installed from the
330 `PyQt website <http://www.riverbankcomputing.co.uk/>`_, or
331 `PySide <http://www.pyside.org/>`_, from Nokia.
327 Also with 0.11, a new GUI was added using the work in :mod:`IPython.zmq`, which
328 can be launched with ``ipython qtconsole``. The GUI is built on Qt, and works
329 with either PyQt, which can be installed from the `PyQt website
330 <http://www.riverbankcomputing.co.uk/>`_, or `PySide
331 <http://www.pyside.org/>`_, from Nokia.
332 332
333 333 pygments
334 334 --------
335 335
336 The syntax-highlighting in ``ipython qtconsole`` is done with the pygments project,
337 which is easy_install-able [pygments]_.
336 The syntax-highlighting in ``ipython qtconsole`` is done with the pygments_
337 project, which is easy_install-able.
338
338 339
339 340 Dependencies for the IPython HTML notebook
340 341 ==========================================
@@ -351,17 +352,23 b' the HTML notebook requires ZeroMQ and PyZMQ.'
351 352 Tornado
352 353 -------
353 354
354 The IPython notebook uses the Tornado project [Tornado]_ for its HTTP server and requires
355 version 2.0 or greater. Tornado can be installed with ``easy_install tornado``.
355 The IPython notebook uses the Tornado_ project for its HTTP server. As of this
356 writing, we require a development version from github, as version 2.0 is *not
357 sufficient*. You can either clone their git repository yourself and install it
358 manually, or install directly from github with::
359
360 easy_install https://github.com/facebook/tornado/tarball/master
356 361
362
357 363 MathJax
358 364 -------
359 365
360 The IPython notebook uses the MathJax [MathJax]_ Javascript library for rendering LaTeX
361 in web browsers. Because MathJax is large, we don't include it with IPython. Normally
362 IPython will load MathJax from a CDN, but if you have a slow network connection, or
363 want to use LaTeX without an internet connection at all, we do
364 include a utility to aid in downloading MathJax and installing it into the proper location::
366 The IPython notebook uses the MathJax_ Javascript library for rendering LaTeX
367 in web browsers. Because MathJax is large, we don't include it with
368 IPython. Normally IPython will load MathJax from a CDN, but if you have a slow
369 network connection, or want to use LaTeX without an internet connection at all,
370 we do include a utility to aid in downloading MathJax and installing it into
371 the proper location::
365 372
366 373 from IPython.external.mathjax import install_mathjax
367 374 install_mathjax()
@@ -387,11 +394,10 b' Internet Explorer 9 does not support WebSockets or the flexible box model, but'
387 394 these features should appear in Internet Explorer 10.
388 395
389 396
390 .. [ZeroMQ] ZeroMQ. http://www.zeromq.org
391 .. [PyZMQ] PyZMQ. https://github.com/zeromq/pyzmq
392 .. [paramiko] paramiko. https://github.com/robey/paramiko
393 .. [pygments] Pygments syntax highlighting. http://pygments.org
394 .. [pexpect] Pexpect. http://www.noah.org/wiki/Pexpect
395 .. [Tornado] Tornado. http://www.tornadoweb.org/
396 .. [MathJax] MathJax. http://www.mathjax.org/
397
397 .. _ZeroMQ: http://www.zeromq.org
398 .. _PyZMQ: https://github.com/zeromq/pyzmq
399 .. _paramiko: https://github.com/robey/paramiko
400 .. _pygments: http://pygments.org
401 .. _pexpect: http://www.noah.org/wiki/Pexpect
402 .. _Tornado: http://www.tornadoweb.org
403 .. _MathJax: http://www.mathjax.org
General Comments 0
You need to be logged in to leave comments. Login now