##// END OF EJS Templates
Update config docs.
Thomas Kluyver -
Show More
@@ -10,10 +10,11 b' overview <config_overview>` for a more general description of the'
10 10 configuration system and configuration file format.
11 11
12 12 The default configuration file for the :command:`ipython` command line application
13 is :file:`ipython_config.py`. By setting the attributes in this file, you
14 can configure the application. A sample is provided in
15 :mod:`IPython.config.default.ipython_config`. Simply copy this file to your
16 :ref:`IPython directory <ipython_dir>` to start using it.
13 is :file:`profile_default/ipython_config.py` in your :ref:`IPython directory
14 <ipython_dir>`. By setting the attributes in this file, you can configure the
15 application. To create the default config file, run this command::
16
17 $ ipython profile create
17 18
18 19 Most configuration attributes that this file accepts are associated with classes
19 20 that are subclasses of :class:`~IPython.config.configurable.Configurable`.
@@ -63,19 +64,8 b' them via :attr:`c.TerminalIPythonApp` and :attr:`c.IPKernelApp` respectively.'
63 64
64 65
65 66 :attr:`c.InteractiveShellApp.extensions`
66 A list of strings, each of which is an importable IPython extension. An
67 IPython extension is a regular Python module or package that has a
68 :func:`load_ipython_extension(ip)` method. This method gets called when
69 the extension is loaded with the currently running
70 :class:`~IPython.core.interactiveshell.InteractiveShell` as its only
71 argument. You can put your extensions anywhere they can be imported but we
72 add the :file:`extensions` subdirectory of the ipython directory to
73 ``sys.path`` during extension loading, so you can put them there as well.
74 Extensions are not executed in the user's interactive namespace and they
75 must be pure Python code. Extensions are the recommended way of customizing
76 :command:`ipython`. Extensions can provide an
77 :func:`unload_ipython_extension` that will be called when the extension is
78 unloaded.
67 A list of strings, each of which is an importable IPython extension. See
68 :ref:`extensions_overview` for more details about extensions.
79 69
80 70 :attr:`c.InteractiveShellApp.exec_lines`
81 71 A list of strings, each of which is Python code that is run in the user's
@@ -116,7 +106,7 b' attributes::'
116 106 # sample ipython_config.py
117 107 c = get_config()
118 108
119 c.IPythonTerminalApp.display_banner = True
109 c.TerminalIPythonApp.display_banner = True
120 110 c.InteractiveShellApp.log_level = 20
121 111 c.InteractiveShellApp.extensions = [
122 112 'myextension'
@@ -16,7 +16,10 b' met our requirements.'
16 16
17 17 If you are upgrading to version 0.11 of IPython, you will need to migrate
18 18 your old :file:`ipythonrc` or :file:`ipy_user_conf.py` configuration files
19 to the new system. Read on for information on how to do this.
19 to the new system. You may want to read the section on
20 :ref:`configuring IPython <configuring_ipython>`. There are also some ideas
21 `on the IPython wiki <http://wiki.ipython.org/Cookbook/Moving_config_to_IPython_0.11>`_
22 about this.
20 23
21 24 The discussion that follows is focused on teaching users how to configure
22 25 IPython to their liking. Developers who want to know more about how they
@@ -8,17 +8,15 b' IPython has a plugin mechanism that allows users to create new and custom'
8 8 runtime components for IPython. Plugins are different from extensions:
9 9
10 10 * Extensions are used to load plugins.
11 * Extensions are a more advanced configuration system that gives you access
11 * Plugins are a more advanced configuration system that gives you access
12 12 to the running IPython instance.
13 * Plugins add entirely new capabilities to IPython.
14 13 * Plugins are traited and configurable.
15 14
16 At this point, our plugin system is brand new and the documentation is
17 minimal. If you are interested in creating a new plugin, see the following
18 files:
15 At this point, the documentation of our plugin system is minimal. If you are
16 interested in creating a new plugin, see the following files:
19 17
20 18 * :file:`IPython/extensions/parallelmagic.py`
21 19 * :file:`IPython/extensions/autoreload.py`
22 * :file:`IPython/extensions/sympyprinting.py`
23 20
24 As well as our documentation on the configuration system and extensions.
21 As well as our documentation on the :ref:`configuration system <config_overview>`
22 and :ref:`extensions <extensions_overview>`.
General Comments 0
You need to be logged in to leave comments. Login now