##// END OF EJS Templates
Include pygments in requirements, small doc fixes.
Fernando Perez -
Show More
@@ -30,6 +30,7 b' information about :mod:`distribute` can be found on its website.'
30 30 More general information about installing Python packages can be found in
31 31 `Python's documentation <http://docs.python.org>`_.
32 32
33
33 34 Quickstart
34 35 ==========
35 36
@@ -39,10 +40,15 b' optional dependencies:'
39 40
40 41 .. code-block:: bash
41 42
42 $ easy_install ipython[zmq,test]
43 $ easy_install ipython[zmq,qtconsole,notebook,test]
44
45 This will get:
43 46
44 This will get pyzmq, which is needed for IPython's parallel computing features
45 as well as the nose package, which will enable you to run IPython's test suite.
47 - pyzmq, needed for IPython's parallel computing features, qt console and
48 notebook.
49 - pygments, used by the Qt console for syntax highlighting.
50 - tornado, needed by the web-based notebook
51 - nose, used by the test suite.
46 52
47 53 To run IPython's test suite, use the :command:`iptest` command:
48 54
@@ -50,8 +56,7 b" To run IPython's test suite, use the :command:`iptest` command:"
50 56
51 57 $ iptest
52 58
53 Read on for more specific details and instructions for Windows.
54
59
55 60 Installing IPython itself
56 61 =========================
57 62
@@ -60,9 +65,10 b' with no external dependencies. However, some Python distributions'
60 65 (particularly on Windows and OS X), don't come with a working :mod:`readline`
61 66 module. The IPython shell will work without :mod:`readline`, but will lack
62 67 many features that users depend on, such as tab completion and command line
63 editing. If you install IPython with :mod:`distribute`, (e.g. with `easy_install`),
64 then the appropriate :mod:`readline` for your platform will be installed.
65 See below for details of how to make sure you have a working :mod:`readline`.
68 editing. If you install IPython with :mod:`distribute`, (e.g. with
69 `easy_install`), then the appropriate :mod:`readline` for your platform will be
70 installed. See below for details of how to make sure you have a working
71 :mod:`readline`.
66 72
67 73 Installation using easy_install
68 74 -------------------------------
@@ -339,8 +345,9 b' the proper location::'
339 345 from IPython.external.mathjax import install_mathjax
340 346 install_mathjax()
341 347
342 This function does require write access to the IPython install directory, so if you
343 have a system-wide Python install, it may need to be done from a ``sudo python`` session.
348 This function does require write access to the IPython install directory, so if
349 you have a system-wide Python install, it may need to be done from a ``sudo
350 python`` session.
344 351
345 352 Browser Compatibility
346 353 ---------------------
General Comments 0
You need to be logged in to leave comments. Login now