diff --git a/docs/source/config/ipython.txt b/docs/source/config/ipython.txt index 88104eb..af25f28 100644 --- a/docs/source/config/ipython.txt +++ b/docs/source/config/ipython.txt @@ -10,10 +10,11 @@ overview ` for a more general description of the configuration system and configuration file format. The default configuration file for the :command:`ipython` command line application -is :file:`ipython_config.py`. By setting the attributes in this file, you -can configure the application. A sample is provided in -:mod:`IPython.config.default.ipython_config`. Simply copy this file to your -:ref:`IPython directory ` to start using it. +is :file:`profile_default/ipython_config.py` in your :ref:`IPython directory +`. By setting the attributes in this file, you can configure the +application. To create the default config file, run this command:: + + $ ipython profile create Most configuration attributes that this file accepts are associated with classes that are subclasses of :class:`~IPython.config.configurable.Configurable`. @@ -63,19 +64,8 @@ them via :attr:`c.TerminalIPythonApp` and :attr:`c.IPKernelApp` respectively. :attr:`c.InteractiveShellApp.extensions` - A list of strings, each of which is an importable IPython extension. An - IPython extension is a regular Python module or package that has a - :func:`load_ipython_extension(ip)` method. This method gets called when - the extension is loaded with the currently running - :class:`~IPython.core.interactiveshell.InteractiveShell` as its only - argument. You can put your extensions anywhere they can be imported but we - add the :file:`extensions` subdirectory of the ipython directory to - ``sys.path`` during extension loading, so you can put them there as well. - Extensions are not executed in the user's interactive namespace and they - must be pure Python code. Extensions are the recommended way of customizing - :command:`ipython`. Extensions can provide an - :func:`unload_ipython_extension` that will be called when the extension is - unloaded. + A list of strings, each of which is an importable IPython extension. See + :ref:`extensions_overview` for more details about extensions. :attr:`c.InteractiveShellApp.exec_lines` A list of strings, each of which is Python code that is run in the user's @@ -116,7 +106,7 @@ attributes:: # sample ipython_config.py c = get_config() - c.IPythonTerminalApp.display_banner = True + c.TerminalIPythonApp.display_banner = True c.InteractiveShellApp.log_level = 20 c.InteractiveShellApp.extensions = [ 'myextension' diff --git a/docs/source/config/overview.txt b/docs/source/config/overview.txt index 8b7a9e5..6837aa1 100644 --- a/docs/source/config/overview.txt +++ b/docs/source/config/overview.txt @@ -16,7 +16,10 @@ met our requirements. If you are upgrading to version 0.11 of IPython, you will need to migrate your old :file:`ipythonrc` or :file:`ipy_user_conf.py` configuration files - to the new system. Read on for information on how to do this. + to the new system. You may want to read the section on + :ref:`configuring IPython `. There are also some ideas + `on the IPython wiki `_ + about this. The discussion that follows is focused on teaching users how to configure IPython to their liking. Developers who want to know more about how they diff --git a/docs/source/config/plugins.txt b/docs/source/config/plugins.txt index 3fc7de7..491bf16 100644 --- a/docs/source/config/plugins.txt +++ b/docs/source/config/plugins.txt @@ -8,17 +8,15 @@ IPython has a plugin mechanism that allows users to create new and custom runtime components for IPython. Plugins are different from extensions: * Extensions are used to load plugins. -* Extensions are a more advanced configuration system that gives you access +* Plugins are a more advanced configuration system that gives you access to the running IPython instance. -* Plugins add entirely new capabilities to IPython. * Plugins are traited and configurable. -At this point, our plugin system is brand new and the documentation is -minimal. If you are interested in creating a new plugin, see the following -files: +At this point, the documentation of our plugin system is minimal. If you are +interested in creating a new plugin, see the following files: * :file:`IPython/extensions/parallelmagic.py` * :file:`IPython/extensions/autoreload.py` -* :file:`IPython/extensions/sympyprinting.py` -As well as our documentation on the configuration system and extensions. +As well as our documentation on the :ref:`configuration system ` +and :ref:`extensions `.