##// END OF EJS Templates
upstream » ipython
RSS

Clone from https://github.com/ipython/ipython.git

Edit doc on color details.
Carol Willing -
Show More
Show file before | Show file after | Hide comments
@@ -36,34 +36,34 b' These have shown problems:'
36 WinXP/2k command prompt works perfectly.
36 WinXP/2k command prompt works perfectly.
37
37
38 IPython uses colors for various groups of things that may be
38 IPython uses colors for various groups of things that may be
39 controlled by different configuration options: prompts, tracebacks, as
39 controlled by different configuration options: prompts, tracebacks, "as
40 you type in the terminal and the object introspection system which
40 you type" in the terminal, and the object introspection system which
41 passes large sets of data through a pager. There are various way to
41 passes large sets of data through a pager. There are various way to
42 change the colors.
42 change the colors.
43
43
44 We can distinguish the coloration into 2 main categories:
44 We can distinguish the coloration into 2 main categories:
45
45
46 - The one that affect only the terminal client.
46 - The one that affects only the terminal client.
47 - The ones that also affect client connected through the Jupyter
47 - The ones that also affect clients connected through the Jupyter
48 protocol.
48 protocol.
49
49
50 Traceback, debugger, and pager are highlighted kernel-side so fall
50 Traceback, debugger, and pager are highlighted kernel-side so they fall
51 into the second category, for historical reasons they are often
51 into the second category. For historical reasons they are often
52 governed by a ``colors`` attribute or configuration option that can
52 governed by a ``colors`` attribute or configuration option that can
53 take one of 3 case insensitive values: ``NoColors``, ``Linux`` and
53 take one of 3 case insensitive values: ``NoColors``, ``Linux`` and
54 ``LightBG``.
54 ``LightBG``.
55
55
56 Colors that affect only the terminal client are governed mainly by
56 Colors that affect only the terminal client are governed mainly by
57 ``TerminalInteractiveShell.highlight_style`` taking the name of a
57 ``TerminalInteractiveShell.highlight_style`` taking the name of a
58 ``Pygments`` style.
58 ``Pygments`` style.
59
59
60 As of IPython 5.0 the color configuration works as follows:
60 As of IPython 5.0 the color configuration works as follows:
61
61
62 - by default, ``TerminalInteractiveShell.highlight_style`` is set to
62 - by default, ``TerminalInteractiveShell.highlight_style`` is set to
63 ``legacy`` which **try to** emulate the colors of IPython pre 5.0,
63 ``legacy`` which **trys to** emulate the colors of IPython pre 5.0
64 and respect the ``.color`` configuration option.
64 and respect the ``.color`` configuration option.
65 The emulation is approximative as the current version of Pygments
65 The emulation is an approximation of the current version of Pygments
66 (2.1) does only support extended ANSI escape sequence, hence the
66 (2.1) and only supports extended ANSI escape sequence, hence the
67 theme cannot adapt to your terminal custom mapping if you have
67 theme cannot adapt to your terminal custom mapping if you have
68 one.
68 one.
69
69
General Comments 0
You need to be logged in to leave comments. Login now