Show More
@@ -83,7 +83,7 b' def embed_kernel(module=None, local_ns=None, **kwargs):' | |||||
83 | **kwargs : various, optional |
|
83 | **kwargs : various, optional | |
84 | Further keyword args are relayed to the IPKernelApp constructor, |
|
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 | such as `config`, a traitlets :class:`Config` object (see :ref:`configure_start_ipython`), | |
86 |
allowing configuration of the |
|
86 | allowing configuration of the kernel (see :ref:`kernel_options`). Will only have an effect | |
87 | on the first embed_kernel call for a given process. |
|
87 | on the first embed_kernel call for a given process. | |
88 | """ |
|
88 | """ | |
89 |
|
89 | |||
@@ -119,7 +119,8 b' def start_ipython(argv=None, **kwargs):' | |||||
119 | specify this dictionary to initialize the IPython user namespace with particular values. |
|
119 | specify this dictionary to initialize the IPython user namespace with particular values. | |
120 | **kwargs : various, optional |
|
120 | **kwargs : various, optional | |
121 | Any other kwargs will be passed to the Application constructor, |
|
121 | Any other kwargs will be passed to the Application constructor, | |
122 |
such as `config`, a traitlets :class:`Config` object (see :ref:`configure_start_ipython`) |
|
122 | such as `config`, a traitlets :class:`Config` object (see :ref:`configure_start_ipython`), | |
|
123 | allowing configuration of the instance (see :ref:`terminal_options`). | |||
123 | """ |
|
124 | """ | |
124 | from IPython.terminal.ipapp import launch_new_instance |
|
125 | from IPython.terminal.ipapp import launch_new_instance | |
125 | return launch_new_instance(argv=argv, **kwargs) |
|
126 | return launch_new_instance(argv=argv, **kwargs) | |
@@ -144,7 +145,8 b' def start_kernel(argv=None, **kwargs):' | |||||
144 | specify this dictionary to initialize the IPython user namespace with particular values. |
|
145 | specify this dictionary to initialize the IPython user namespace with particular values. | |
145 | **kwargs : various, optional |
|
146 | **kwargs : various, optional | |
146 | Any other kwargs will be passed to the Application constructor, |
|
147 | Any other kwargs will be passed to the Application constructor, | |
147 |
such as `config`, a traitlets :class:`Config` object (see :ref:`configure_start_ipython`) |
|
148 | such as `config`, a traitlets :class:`Config` object (see :ref:`configure_start_ipython`), | |
|
149 | allowing configuration of the kernel (see :ref:`kernel_options`). | |||
148 | """ |
|
150 | """ | |
149 | import warnings |
|
151 | import warnings | |
150 |
|
152 |
@@ -380,7 +380,7 b' def embed(*, header="", compile_flags=None, **kwargs):' | |||||
380 | **kwargs : various, optional |
|
380 | **kwargs : various, optional | |
381 | Any other kwargs will be passed to the :class:`InteractiveShellEmbed` constructor. |
|
381 | Any other kwargs will be passed to the :class:`InteractiveShellEmbed` constructor. | |
382 | Full customization can be done by passing a traitlets :class:`Config` in as the |
|
382 | Full customization can be done by passing a traitlets :class:`Config` in as the | |
383 | `config` argument (see :ref:`configure_start_ipython`). |
|
383 | `config` argument (see :ref:`configure_start_ipython` and :ref:`terminal_options`). | |
384 | """ |
|
384 | """ | |
385 | config = kwargs.get('config') |
|
385 | config = kwargs.get('config') | |
386 | if config is None: |
|
386 | if config is None: |
@@ -103,6 +103,7 b' def write_doc(name, title, app, preamble=None):' | |||||
103 | trait_aliases = reverse_aliases(app) |
|
103 | trait_aliases = reverse_aliases(app) | |
104 | filename = options / (name + ".rst") |
|
104 | filename = options / (name + ".rst") | |
105 | with open(filename, "w", encoding="utf-8") as f: |
|
105 | with open(filename, "w", encoding="utf-8") as f: | |
|
106 | f.write(".. _" + name + "_options:" + "\n\n") | |||
106 | f.write(title + "\n") |
|
107 | f.write(title + "\n") | |
107 | f.write(("=" * len(title)) + "\n") |
|
108 | f.write(("=" * len(title)) + "\n") | |
108 | f.write("\n") |
|
109 | f.write("\n") |
General Comments 0
You need to be logged in to leave comments.
Login now