Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 4f8c922

Browse files
committed
Include pygments in requirements, small doc fixes.
1 parent 909f4cc commit 4f8c922

File tree

2 files changed

+19
-11
lines changed

2 files changed

+19
-11
lines changed

docs/source/install/install.txt

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ information about :mod:`distribute` can be found on its website.
3030
More general information about installing Python packages can be found in
3131
`Python's documentation <http://docs.python.org>`_.
3232

33+
3334
Quickstart
3435
==========
3536

@@ -39,19 +40,23 @@ optional dependencies:
3940

4041
.. code-block:: bash
4142

42-
$ easy_install ipython[zmq,test]
43+
$ easy_install ipython[zmq,qtconsole,notebook,test]
44+
45+
This will get:
4346

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.
4652

4753
To run IPython's test suite, use the :command:`iptest` command:
4854

4955
.. code-block:: bash
5056

5157
$ iptest
5258

53-
Read on for more specific details and instructions for Windows.
54-
59+
5560
Installing IPython itself
5661
=========================
5762

@@ -60,9 +65,10 @@ with no external dependencies. However, some Python distributions
6065
(particularly on Windows and OS X), don't come with a working :mod:`readline`
6166
module. The IPython shell will work without :mod:`readline`, but will lack
6267
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`.
6672

6773
Installation using easy_install
6874
-------------------------------
@@ -339,8 +345,9 @@ the proper location::
339345
from IPython.external.mathjax import install_mathjax
340346
install_mathjax()
341347

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.
344351

345352
Browser Compatibility
346353
---------------------

setup2.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,8 @@ def cleanup():
191191
zmq = 'pyzmq>=2.1.4',
192192
doc = 'Sphinx>=0.3',
193193
test = 'nose>=0.10.1',
194-
notebook = 'tornado>=2.0'
194+
notebook = 'tornado>=2.0',
195+
qtconsole = 'pygments',
195196
)
196197
requires = setup_args.setdefault('install_requires', [])
197198
setupext.display_status = False

0 commit comments

Comments
 (0)