##// END OF EJS Templates
Merge pull request #12341 from meeseeksmachine/auto-backport-of-pr-12340-on-7.x...
Matthias Bussonnier -
r25763:7995cb28 merge
parent child Browse files
Show More
@@ -11,24 +11,24 b" Many of IPython's classes have configurable attributes (see"
11 :doc:`options/index` for the list). These can be
11 :doc:`options/index` for the list). These can be
12 configured in several ways.
12 configured in several ways.
13
13
14 Python config files
14 Python configuration files
15 -------------------
15 --------------------------
16
16
17 To create the blank config files, run::
17 To create the blank configuration files, run::
18
18
19 ipython profile create [profilename]
19 ipython profile create [profilename]
20
20
21 If you leave out the profile name, the files will be created for the
21 If you leave out the profile name, the files will be created for the
22 ``default`` profile (see :ref:`profiles`). These will typically be located in
22 ``default`` profile (see :ref:`profiles`). These will typically be located in
23 :file:`~/.ipython/profile_default/`, and will be named
23 :file:`~/.ipython/profile_default/`, and will be named
24 :file:`ipython_config.py`, for hitorical reasons you may also find fiels
24 :file:`ipython_config.py`, for historical reasons you may also find files
25 named with IPytho nprefix instead of Jupyter:
25 named with IPython prefix instead of Jupyter:
26 :file:`ipython_notebook_config.py`, etc. The settings in
26 :file:`ipython_notebook_config.py`, etc. The settings in
27 :file:`ipython_config.py` apply to all IPython commands.
27 :file:`ipython_config.py` apply to all IPython commands.
28
28
29 by default, configuration files are fully featured Python scripts that can
29 By default, configuration files are fully featured Python scripts that can
30 execute arbitrary code, the main usage is to set value on the config object
30 execute arbitrary code, the main usage is to set value on the configuration
31 ``c`` which exist in your configuration file.
31 object ``c`` which exist in your configuration file.
32
32
33 You can then configure class attributes like this::
33 You can then configure class attributes like this::
34
34
@@ -48,8 +48,8 b' sets)::'
48 .. versionadded:: 2.0
48 .. versionadded:: 2.0
49 list, dict and set methods for config values
49 list, dict and set methods for config values
50
50
51 Example config file
51 Example configuration file
52 ```````````````````
52 ``````````````````````````
53
53
54 ::
54 ::
55
55
@@ -79,15 +79,15 b' Example config file'
79 ('la', 'ls -al')
79 ('la', 'ls -al')
80 ]
80 ]
81
81
82 Json Configuration files
82 JSON Configuration files
83 ------------------------
83 ------------------------
84
84
85 in case where executability of configuration can be problematic, or
85 In case where executability of configuration can be problematic, or
86 configurations need to be modified programatically, IPython also support a
86 configurations need to be modified programmatically, IPython also support a
87 limited set of functionalities via ``.json`` config files.
87 limited set of functionalities via ``.json`` configuration files.
88
88
89 You can defined most of the configuration options via a json object which
89 You can defined most of the configuration options via a json object which
90 hierarchy represent the value you woudl normally set on the ``c`` object of
90 hierarchy represent the value you would normally set on the ``c`` object of
91 ``.py`` configuration files. The following ``ipython_config.json`` file::
91 ``.py`` configuration files. The following ``ipython_config.json`` file::
92
92
93 {
93 {
@@ -201,7 +201,7 b' To see where IPython is looking for the IPython directory, use the command'
201 Systemwide configuration
201 Systemwide configuration
202 ========================
202 ========================
203
203
204 It can be usefull to deploy systemwide ipython or ipykernel configuration
204 It can be useful to deploy systemwide ipython or ipykernel configuration
205 when managing environment for many users. At startup time IPython and
205 when managing environment for many users. At startup time IPython and
206 IPykernel will search for configuration file in multiple systemwide
206 IPykernel will search for configuration file in multiple systemwide
207 locations, mainly:
207 locations, mainly:
@@ -219,7 +219,7 b' In those locations, Terminal IPython will look for a file called'
219 ``ipython_kernel_config.py`` and ``ipython_kernel.json``.
219 ``ipython_kernel_config.py`` and ``ipython_kernel.json``.
220
220
221 Configuration files are loaded in order and merged with configuration on
221 Configuration files are loaded in order and merged with configuration on
222 later locatoin taking precedence on earlier locations (that is to say a user
222 later location taking precedence on earlier locations (that is to say a user
223 can overwrite a systemwide configuration option).
223 can overwrite a systemwide configuration option).
224
224
225 You can see all locations in which IPython is looking for configuration files
225 You can see all locations in which IPython is looking for configuration files
@@ -230,4 +230,4 b' by starting ipython in debug mode::'
230 Identically with ipykernel though the command is currently blocking until
230 Identically with ipykernel though the command is currently blocking until
231 this process is killed with ``Ctrl-\``::
231 this process is killed with ``Ctrl-\``::
232
232
233 $ python -m ipykernel --debug No newline at end of file
233 $ python -m ipykernel --debug
General Comments 0
You need to be logged in to leave comments. Login now