##// END OF EJS Templates
docs: add more pointers to configuration of embedded IPython...
Philippe Blain -
Show More
@@ -82,6 +82,7 b' def embed_kernel(module=None, local_ns=None, **kwargs):'
82 82 The namespace to load into IPython user namespace (default: caller)
83 83 **kwargs : various, optional
84 84 Further keyword args are relayed to the IPKernelApp constructor,
85 such as `config`, a traitlets :class:`Config` object (see :ref:`configure_start_ipython`),
85 86 allowing configuration of the Kernel. Will only have an effect
86 87 on the first embed_kernel call for a given process.
87 88 """
@@ -118,7 +119,7 b' def start_ipython(argv=None, **kwargs):'
118 119 specify this dictionary to initialize the IPython user namespace with particular values.
119 120 **kwargs : various, optional
120 121 Any other kwargs will be passed to the Application constructor,
121 such as `config`.
122 such as `config`, a traitlets :class:`Config` object (see :ref:`configure_start_ipython`).
122 123 """
123 124 from IPython.terminal.ipapp import launch_new_instance
124 125 return launch_new_instance(argv=argv, **kwargs)
@@ -143,7 +144,7 b' def start_kernel(argv=None, **kwargs):'
143 144 specify this dictionary to initialize the IPython user namespace with particular values.
144 145 **kwargs : various, optional
145 146 Any other kwargs will be passed to the Application constructor,
146 such as `config`.
147 such as `config`, a traitlets :class:`Config` object (see :ref:`configure_start_ipython`).
147 148 """
148 149 import warnings
149 150
@@ -369,8 +369,8 b' def embed(*, header="", compile_flags=None, **kwargs):'
369 369 d = 40
370 370 embed()
371 371
372 Full customization can be done by passing a :class:`Config` in as the
373 config argument.
372 Full customization can be done by passing a traitlets :class:`Config` in as the
373 `config` argument (see :ref:`configure_start_ipython`).
374 374 """
375 375 config = kwargs.get('config')
376 376 if config is None:
@@ -153,7 +153,7 b' Running IPython from Python'
153 153
154 154 If you are using :ref:`embedding` to start IPython from a normal
155 155 python file, you can set configuration options the same way as in a
156 config file by creating a traitlets config object and passing it to
156 config file by creating a traitlets :class:`Config` object and passing it to
157 157 start_ipython like in the example below.
158 158
159 159 .. literalinclude:: ../../../examples/Embedding/start_ipython_config.py
@@ -3,8 +3,8 b' IPython options'
3 3 ===============
4 4
5 5 Any of the options listed here can be set in config files, at the
6 command line, or from inside IPython. See :ref:`setting_config` for
7 details.
6 command line, from inside IPython, or using a traitlets :class:`Config` object.
7 See :ref:`setting_config` for details.
8 8
9 9 .. toctree::
10 10
General Comments 0
You need to be logged in to leave comments. Login now