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