##// END OF EJS Templates
upstream » ipython
RSS

Clone from https://github.com/ipython/ipython.git

Merge pull request #10015 from keshavramaswamy/patch-1...
Thomas Kluyver -
r22958:6b34d356 merge
parent child Browse files
Show More
Show file before | Show file after | Hide comments
@@ -1,111 +1,111
1 .. _introduction:
1 .. _introduction:
2
2
3 =====================
3 =====================
4 IPython Documentation
4 IPython Documentation
5 =====================
5 =====================
6
6
7 .. htmlonly::
7 .. htmlonly::
8
8
9 :Release: |release|
9 :Release: |release|
10 :Date: |today|
10 :Date: |today|
11
11
12 Welcome to the official IPython documentation
12 Welcome to the official IPython documentation
13
13
14 IPython provides a rich toolkit to help you make the most out of using Python
14 IPython provides a rich toolkit to help you make the most out of using Python
15 interactively. Its main components are:
15 interactively. Its main components are:
16
16
17 * A powerful interactive Python shell
17 * A powerful interactive Python shell
18
18
19 * A `Jupyter <http://jupyter.org/>`_ kernel to work with Python code in Jupyter
19 * A `Jupyter <http://jupyter.org/>`_ kernel to work with Python code in Jupyter
20 notebooks and other interactive frontends.
20 notebooks and other interactive frontends.
21
21
22 The enhanced interactive Python shells and kernel have the following main
22 The enhanced interactive Python shells and kernel have the following main
23 features:
23 features:
24
24
25 * Comprehensive object introspection.
25 * Comprehensive object introspection.
26
26
27 * Input history, persistent across sessions.
27 * Input history, persistent across sessions.
28
28
29 * Caching of output results during a session with automatically generated
29 * Caching of output results during a session with automatically generated
30 references.
30 references.
31
31
32 * Extensible tab completion, with support by default for completion of python
32 * Extensible tab completion, with support by default for completion of python
33 variables and keywords, filenames and function keywords.
33 variables and keywords, filenames and function keywords.
34
34
35 * Extensible system of 'magic' commands for controlling the environment and
35 * Extensible system of 'magic' commands for controlling the environment and
36 performing many tasks related either to IPython or the operating system.
36 performing many tasks related either to IPython or the operating system.
37
37
38 * A rich configuration system with easy switching between different setups
38 * A rich configuration system with easy switching between different setups
39 (simpler than changing $PYTHONSTARTUP environment variables every time).
39 (simpler than changing $PYTHONSTARTUP environment variables every time).
40
40
41 * Session logging and reloading.
41 * Session logging and reloading.
42
42
43 * Extensible syntax processing for special purpose situations.
43 * Extensible syntax processing for special purpose situations.
44
44
45 * Access to the system shell with user-extensible alias system.
45 * Access to the system shell with user-extensible alias system.
46
46
47 * Easily embeddable in other Python programs and GUIs.
47 * Easily embeddable in other Python programs and GUIs.
48
48
49 * Integrated access to the pdb debugger and the Python profiler.
49 * Integrated access to the pdb debugger and the Python profiler.
50
50
51
51
52 The Command line interface inherit all the above functionality and posses
52 The Command line interface inherits all the above functionality and posses
53
53
54 * real multi-line editing.
54 * real multi-line editing.
55
55
56 * syntax highlighting as you type
56 * syntax highlighting as you type
57
57
58 * integration with command line editor for a better workflow.
58 * integration with command line editor for a better workflow.
59
59
60 The kernel also have its share of feature, when used with a compatible frontend
60 The kernel also have its share of feature, when used with a compatible frontend
61 it allows for:
61 it allows for:
62
62
63 * rich display system for object allowing to display Html, Images, Latex,Sounds
63 * rich display system for object allowing to display Html, Images, Latex,Sounds
64 Video.
64 Video.
65
65
66 * interactive widgets with the use of the ``ipywidgets`` package.
66 * interactive widgets with the use of the ``ipywidgets`` package.
67
67
68
68
69 This documentation will walk through most of the features of the IPython
69 This documentation will walk through most of the features of the IPython
70 command line and kernel, as well as describe the internals mechanisms in order
70 command line and kernel, as well as describe the internals mechanisms in order
71 to improve your Python workflow.
71 to improve your Python workflow.
72
72
73 You can always find the table of content for this documentation in the left
73 You can always find the table of content for this documentation in the left
74 sidebar, allowing you to come back on previous section if needed, or skip ahead.
74 sidebar, allowing you to come back on previous section if needed, or skip ahead.
75
75
76
76
77 The latest development version is always available from IPython's `GitHub
77 The latest development version is always available from IPython's `GitHub
78 repository <http://github.com/ipython/ipython>`_.
78 repository <http://github.com/ipython/ipython>`_.
79
79
80
80
81
81
82
82
83 .. toctree::
83 .. toctree::
84 :maxdepth: 1
84 :maxdepth: 1
85 :hidden:
85 :hidden:
86
86
87 self
87 self
88 overview
88 overview
89 whatsnew/index
89 whatsnew/index
90 install/index
90 install/index
91 interactive/index
91 interactive/index
92 config/index
92 config/index
93 development/index
93 development/index
94 coredev/index
94 coredev/index
95 api/index
95 api/index
96 about/index
96 about/index
97
97
98 .. seealso::
98 .. seealso::
99
99
100 `Jupyter documentation <http://jupyter.readthedocs.io/en/latest/>`__
100 `Jupyter documentation <http://jupyter.readthedocs.io/en/latest/>`__
101 The Notebook code and many other pieces formerly in IPython are now parts
101 The Notebook code and many other pieces formerly in IPython are now parts
102 of Project Jupyter.
102 of Project Jupyter.
103 `ipyparallel documentation <http://ipyparallel.readthedocs.io/en/latest/>`__
103 `ipyparallel documentation <http://ipyparallel.readthedocs.io/en/latest/>`__
104 Formerly ``IPython.parallel``.
104 Formerly ``IPython.parallel``.
105
105
106
106
107 .. htmlonly::
107 .. htmlonly::
108 * :ref:`genindex`
108 * :ref:`genindex`
109 * :ref:`modindex`
109 * :ref:`modindex`
110 * :ref:`search`
110 * :ref:`search`
111
111
General Comments 0
You need to be logged in to leave comments. Login now