Note
This documentation is for a development version of IPython. There may be significant differences from the latest stable release (1.2.1).
Any of the IPython kernel options can also be used.
Default: u’/Users/minrk/dev/ip/mine/docs’
The directory to use for notebooks.
Default: ‘IPython.kernel.ioloop.IOLoopKernelManager’
The kernel manager class. This is configurable to allow subclassing of the KernelManager for customized behavior.
Default: False
Should we autorestart the kernel if it dies.
Default: u’‘
Set the kernel’s IP address [default localhost]. If the IP address is something other than localhost, then Consoles on other machines will be able to connect to the Kernel, so be careful!
Default: []
The Popen Command to launch the kernel. Override this if you have a custom
Default: ‘tcp’
No description
Default: ‘/’
The base URL for the notebook server.
Leading and trailing slashes can be omitted, and will automatically be added.
Default: u’‘
Specify what command to use to invoke a web browser when opening the notebook. If not specified, the default browser will be determined by the webbrowser standard library module, which allows setting of the BROWSER environment variable to override it.
Default: u’‘
The full path to an SSL/TLS certificate file.
Default: ‘’
The random bytes used to secure cookies. By default this is a new random number every time you start the Notebook. Set it to a value in a config file to enable logins to persist across server sessions.
Note: Cookie secrets should be kept private, do not share config files with cookie_secret stored in plaintext (you can read the value from a file).
Default: False
Whether to install the default config files into the profile dir. If a new profile is being created, and IPython contains config files for that profile, then they will be staged into the new directory. Otherwise, default config files will be automatically generated.
Default: True
Whether to enable MathJax for typesetting math/TeX
MathJax is the javascript library IPython uses to render math/LaTeX. It is very large, so you may want to disable it if you have a slow internet connection, or for offline use of the notebook.
When disabled, equations etc. will appear as their untransformed TeX source.
Default: u’‘
Path to an extra config file to load.
If specified, load this config file in addition to any other IPython config.
Default: []
Extra paths to search for serving static files.
This allows adding javascript/css to be available from the notebook server machine, or overriding individual files in the IPython
Default: u’‘
The IP address the notebook server will listen on.
Default: u’‘
The name of the IPython directory. This directory is used for logging configuration (through profiles), history storage, etc. The default is usually $HOME/.ipython. This options can also be specified through the environment variable IPYTHONDIR.
Default: u’‘
The full path to a private key file for usage with SSL/TLS.
Default: ‘%Y-%m-%d %H:%M:%S’
The date format used by logging formatters for %(asctime)s
Default: ‘[%(name)s]%(highlevel)s %(message)s’
The Logging format template
Default: 30
Set the log level by value or name.
Default: ‘’
The url for MathJax.js.
Default: []
paths for Javascript extensions. By default, this is just IPYTHONDIR/nbextensions
Default: ‘IPython.html.services.notebooks.filenbmanager.FileNotebookMa...
The notebook manager class to use.
Default: True
Whether to open in a browser after starting. The specific browser used is platform dependent and determined by the python standard library webbrowser module, unless it is overridden using the –browser (NotebookApp.browser) configuration option.
Default: False
Whether to overwrite existing config files when copying
Default: u’‘
Hashed password to use for web authentication.
To generate, type in a python/IPython shell:
from IPython.lib import passwd; passwd()
The string should be of the form type:salt:hashed-password.
Default: 8888
The port the notebook server will listen on.
Default: 50
The number of additional ports to try if the specified port is not available.
Default: u’default’
The IPython profile to use.
Default: False
Whether to trust or not X-Scheme/X-Forwarded-Proto and X-Real-Ip/X -Forwarded-For headerssent by the upstream reverse proxy. Necessary if the proxy handles SSL
Default: False
Wether to use Browser Side less-css parsing instead of compiled css version in templates that allows it. This is mainly convenient when working on the less file to avoid a build step, or if user want to overwrite some of the less variables without having to recompile everything.
You will need to install the less.js component in the static directory either in the source tree or in your profile folder.
Default: False
Create a massive crash report when IPython encounters what may be an internal error. The default is to append a short message to the usual traceback
Default: {}
Supply overrides for the tornado.web.Application that the IPython notebook uses.
Default: ‘’
The base URL for the websocket server, if it differs from the HTTP server (hint: it almost certainly doesn’t).
Should be in the form of an HTTP origin: ws[s]://hostname[:port]
Default: True
Close all figures at the end of each cell.
When True, ensures that each cell starts with no active figures, but it also means that one must keep track of references in order to edit or redraw figures in subsequent cells. This mode is ideal for the notebook, where residual plots from other cells might be surprising.
When False, one must call figure() to create new figures. This means that gcf() and getfigs() can reference figures created in other cells, and the active figure can continue to be edited with pylab/pyplot methods that reference the current active figure. This mode facilitates iterative editing of figures, and behaves most consistently with other matplotlib backends, but figure barriers between cells must be explicit.
Default: ‘png’
The image format for figures with the inline backend.
Default: {‘font.size’: 10, ‘figure.figsize’: (6.0, 4.0), ‘figure.facec...
Subset of matplotlib rcParams that should be different for the inline backend.
Default: u’‘
The location in which to keep notebook checkpoints
By default, it is notebook-dir/.ipynb_checkpoints
Default: u’/Users/minrk/dev/ip/mine/docs’
The directory to use for notebooks.
Default: False
Automatically create a Python script when saving the notebook.
For easier use of import, %run and %load across notebooks, a <notebook- name>.py script will be created next to any <notebook-name>.ipynb on each save. This can also be set with the short –script flag.