index.rst
112 lines
| 2.9 KiB
| text/x-rst
|
RstLexer
|
r22588 | .. _introduction: | ||
|
r1258 | ===================== | ||
|
r1256 | IPython Documentation | ||
===================== | ||||
|
r23145 | .. only:: html | ||
|
r1673 | |||
|
r1725 | :Release: |release| | ||
|
r1673 | :Date: |today| | ||
|
r22588 | Welcome to the official IPython documentation | ||
IPython provides a rich toolkit to help you make the most out of using Python | ||||
interactively. Its main components are: | ||||
* A powerful interactive Python shell | ||||
|
r22594 | |||
|
r22588 | * A `Jupyter <http://jupyter.org/>`_ kernel to work with Python code in Jupyter | ||
notebooks and other interactive frontends. | ||||
The enhanced interactive Python shells and kernel have the following main | ||||
features: | ||||
* Comprehensive object introspection. | ||||
* Input history, persistent across sessions. | ||||
* Caching of output results during a session with automatically generated | ||||
references. | ||||
* Extensible tab completion, with support by default for completion of python | ||||
variables and keywords, filenames and function keywords. | ||||
* Extensible system of 'magic' commands for controlling the environment and | ||||
performing many tasks related either to IPython or the operating system. | ||||
* A rich configuration system with easy switching between different setups | ||||
(simpler than changing $PYTHONSTARTUP environment variables every time). | ||||
* Session logging and reloading. | ||||
* Extensible syntax processing for special purpose situations. | ||||
* Access to the system shell with user-extensible alias system. | ||||
* Easily embeddable in other Python programs and GUIs. | ||||
* Integrated access to the pdb debugger and the Python profiler. | ||||
The Command line interface inherit all the above functionality and posses | ||||
|
r22594 | * real multi-line editing. | ||
|
r22588 | |||
* syntax highlighting as you type | ||||
|
r22594 | * integration with command line editor for a better workflow. | ||
|
r22588 | |||
The kernel also have its share of feature, when used with a compatible frontend | ||||
it allows for: | ||||
* rich display system for object allowing to display Html, Images, Latex,Sounds | ||||
Video. | ||||
|
r22594 | * interactive widgets with the use of the ``ipywidgets`` package. | ||
|
r22588 | |||
This documentation will walk through most of the features of the IPython | ||||
command line and kernel, as well as describe the internals mechanisms in order | ||||
to improve your Python workflow. | ||||
You can always find the table of content for this documentation in the left | ||||
sidebar, allowing you to come back on previous section if needed, or skip ahead. | ||||
The latest development version is always available from IPython's `GitHub | ||||
repository <http://github.com/ipython/ipython>`_. | ||||
|
r2275 | |||
|
r1258 | |||
|
r1256 | .. toctree:: | ||
|
r2275 | :maxdepth: 1 | ||
|
r22588 | :hidden: | ||
|
r1256 | |||
|
r22588 | self | ||
|
r11730 | overview | ||
whatsnew/index | ||||
install/index | ||||
interactive/index | ||||
config/index | ||||
development/index | ||||
|
r22029 | coredev/index | ||
|
r11730 | api/index | ||
|
r24017 | sphinxext | ||
|
r11730 | about/index | ||
|
r1256 | |||
|
r21570 | .. seealso:: | ||
|
r22288 | `Jupyter documentation <http://jupyter.readthedocs.io/en/latest/>`__ | ||
|
r21570 | The Notebook code and many other pieces formerly in IPython are now parts | ||
of Project Jupyter. | ||||
|
r22288 | `ipyparallel documentation <http://ipyparallel.readthedocs.io/en/latest/>`__ | ||
|
r21570 | Formerly ``IPython.parallel``. | ||
|
r23145 | .. only:: html | ||
|
r1788 | * :ref:`genindex` | ||
* :ref:`modindex` | ||||
* :ref:`search` | ||||
|
r2275 | |||