Show More
@@ -1,12 +1,12 b'' | |||||
1 | .. _api-index: |
|
1 | .. _api-index: | |
2 |
|
2 | |||
3 | ################### |
|
3 | ################### | |
4 | The IPython API |
|
4 | The IPython API | |
5 | ################### |
|
5 | ################### | |
6 |
|
6 | |||
7 |
.. |
|
7 | .. only:: html | |
8 |
|
8 | |||
9 | :Release: |version| |
|
9 | :Release: |version| | |
10 | :Date: |today| |
|
10 | :Date: |today| | |
11 |
|
11 | |||
12 | .. include:: generated/gen.txt |
|
12 | .. include:: generated/gen.txt |
@@ -1,284 +1,276 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | # |
|
2 | # | |
3 | # IPython documentation build configuration file. |
|
3 | # IPython documentation build configuration file. | |
4 |
|
4 | |||
5 | # NOTE: This file has been edited manually from the auto-generated one from |
|
5 | # NOTE: This file has been edited manually from the auto-generated one from | |
6 | # sphinx. Do NOT delete and re-generate. If any changes from sphinx are |
|
6 | # sphinx. Do NOT delete and re-generate. If any changes from sphinx are | |
7 | # needed, generate a scratch one and merge by hand any new fields needed. |
|
7 | # needed, generate a scratch one and merge by hand any new fields needed. | |
8 |
|
8 | |||
9 | # |
|
9 | # | |
10 | # This file is execfile()d with the current directory set to its containing dir. |
|
10 | # This file is execfile()d with the current directory set to its containing dir. | |
11 | # |
|
11 | # | |
12 | # The contents of this file are pickled, so don't put values in the namespace |
|
12 | # The contents of this file are pickled, so don't put values in the namespace | |
13 | # that aren't pickleable (module imports are okay, they're removed automatically). |
|
13 | # that aren't pickleable (module imports are okay, they're removed automatically). | |
14 | # |
|
14 | # | |
15 | # All configuration values have a default value; values that are commented out |
|
15 | # All configuration values have a default value; values that are commented out | |
16 | # serve to show the default value. |
|
16 | # serve to show the default value. | |
17 |
|
17 | |||
18 | import sys, os |
|
18 | import sys, os | |
19 |
|
19 | |||
|
20 | # http://read-the-docs.readthedocs.io/en/latest/faq.html | |||
20 | ON_RTD = os.environ.get('READTHEDOCS', None) == 'True' |
|
21 | ON_RTD = os.environ.get('READTHEDOCS', None) == 'True' | |
21 |
|
22 | |||
22 | if ON_RTD: |
|
23 | if ON_RTD: | |
23 | # Mock the presence of matplotlib, which we don't have on RTD |
|
|||
24 | # see |
|
|||
25 | # http://read-the-docs.readthedocs.io/en/latest/faq.html |
|
|||
26 | tags.add('rtd') |
|
24 | tags.add('rtd') | |
27 |
|
25 | |||
28 | # RTD doesn't use the Makefile, so re-run autogen_{things}.py here. |
|
26 | # RTD doesn't use the Makefile, so re-run autogen_{things}.py here. | |
29 | for name in ('config', 'api', 'magics', 'shortcuts'): |
|
27 | for name in ('config', 'api', 'magics', 'shortcuts'): | |
30 | fname = 'autogen_{}.py'.format(name) |
|
28 | fname = 'autogen_{}.py'.format(name) | |
31 | fpath = os.path.abspath(os.path.join('..', fname)) |
|
29 | fpath = os.path.abspath(os.path.join('..', fname)) | |
32 | with open(fpath) as f: |
|
30 | with open(fpath) as f: | |
33 | exec(compile(f.read(), fname, 'exec'), { |
|
31 | exec(compile(f.read(), fname, 'exec'), { | |
34 | '__file__': fpath, |
|
32 | '__file__': fpath, | |
35 | '__name__': '__main__', |
|
33 | '__name__': '__main__', | |
36 | }) |
|
34 | }) | |
37 | else: |
|
35 | else: | |
38 | import sphinx_rtd_theme |
|
36 | import sphinx_rtd_theme | |
39 | html_theme = "sphinx_rtd_theme" |
|
37 | html_theme = "sphinx_rtd_theme" | |
40 | html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] |
|
38 | html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] | |
41 |
|
39 | |||
42 | # If your extensions are in another directory, add it here. If the directory |
|
40 | # If your extensions are in another directory, add it here. If the directory | |
43 | # is relative to the documentation root, use os.path.abspath to make it |
|
41 | # is relative to the documentation root, use os.path.abspath to make it | |
44 | # absolute, like shown here. |
|
42 | # absolute, like shown here. | |
45 | sys.path.insert(0, os.path.abspath('../sphinxext')) |
|
43 | sys.path.insert(0, os.path.abspath('../sphinxext')) | |
46 |
|
44 | |||
47 | # We load the ipython release info into a dict by explicit execution |
|
45 | # We load the ipython release info into a dict by explicit execution | |
48 | iprelease = {} |
|
46 | iprelease = {} | |
49 | exec(compile(open('../../IPython/core/release.py').read(), '../../IPython/core/release.py', 'exec'),iprelease) |
|
47 | exec(compile(open('../../IPython/core/release.py').read(), '../../IPython/core/release.py', 'exec'),iprelease) | |
50 |
|
48 | |||
51 | # General configuration |
|
49 | # General configuration | |
52 | # --------------------- |
|
50 | # --------------------- | |
53 |
|
51 | |||
54 | # Add any Sphinx extension module names here, as strings. They can be extensions |
|
52 | # Add any Sphinx extension module names here, as strings. They can be extensions | |
55 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
|
53 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. | |
56 | extensions = [ |
|
54 | extensions = [ | |
57 | 'matplotlib.sphinxext.mathmpl', |
|
|||
58 | 'matplotlib.sphinxext.only_directives', |
|
|||
59 | 'matplotlib.sphinxext.plot_directive', |
|
|||
60 | 'sphinx.ext.autodoc', |
|
55 | 'sphinx.ext.autodoc', | |
61 | 'sphinx.ext.autosummary', |
|
56 | 'sphinx.ext.autosummary', | |
62 | 'sphinx.ext.doctest', |
|
57 | 'sphinx.ext.doctest', | |
63 | 'sphinx.ext.inheritance_diagram', |
|
58 | 'sphinx.ext.inheritance_diagram', | |
64 | 'sphinx.ext.intersphinx', |
|
59 | 'sphinx.ext.intersphinx', | |
65 | 'IPython.sphinxext.ipython_console_highlighting', |
|
60 | 'IPython.sphinxext.ipython_console_highlighting', | |
66 | 'IPython.sphinxext.ipython_directive', |
|
61 | 'IPython.sphinxext.ipython_directive', | |
67 | 'sphinx.ext.napoleon', # to preprocess docstrings |
|
62 | 'sphinx.ext.napoleon', # to preprocess docstrings | |
68 | 'github', # for easy GitHub links |
|
63 | 'github', # for easy GitHub links | |
69 | 'magics', |
|
64 | 'magics', | |
70 | ] |
|
65 | ] | |
71 |
|
66 | |||
72 | if ON_RTD: |
|
67 | if ON_RTD: | |
73 | # Remove extensions not currently supported on RTD |
|
68 | # Remove extensions not currently supported on RTD | |
74 | extensions.remove('matplotlib.sphinxext.only_directives') |
|
|||
75 | extensions.remove('matplotlib.sphinxext.mathmpl') |
|
|||
76 | extensions.remove('matplotlib.sphinxext.plot_directive') |
|
|||
77 | extensions.remove('IPython.sphinxext.ipython_directive') |
|
69 | extensions.remove('IPython.sphinxext.ipython_directive') | |
78 | extensions.remove('IPython.sphinxext.ipython_console_highlighting') |
|
70 | extensions.remove('IPython.sphinxext.ipython_console_highlighting') | |
79 |
|
71 | |||
80 | # Add any paths that contain templates here, relative to this directory. |
|
72 | # Add any paths that contain templates here, relative to this directory. | |
81 | templates_path = ['_templates'] |
|
73 | templates_path = ['_templates'] | |
82 |
|
74 | |||
83 | # The suffix of source filenames. |
|
75 | # The suffix of source filenames. | |
84 | source_suffix = '.rst' |
|
76 | source_suffix = '.rst' | |
85 |
|
77 | |||
86 | def is_stable(extra): |
|
78 | def is_stable(extra): | |
87 | for ext in {'dev', 'b', 'rc'}: |
|
79 | for ext in {'dev', 'b', 'rc'}: | |
88 | if ext in extra: |
|
80 | if ext in extra: | |
89 | return False |
|
81 | return False | |
90 | return True |
|
82 | return True | |
91 |
|
83 | |||
92 | if is_stable(iprelease['_version_extra']): |
|
84 | if is_stable(iprelease['_version_extra']): | |
93 | tags.add('ipystable') |
|
85 | tags.add('ipystable') | |
94 | else: |
|
86 | else: | |
95 | tags.add('ipydev') |
|
87 | tags.add('ipydev') | |
96 | rst_prolog = """ |
|
88 | rst_prolog = """ | |
97 | .. warning:: |
|
89 | .. warning:: | |
98 |
|
90 | |||
99 | This documentation is for a development version of IPython. There may be |
|
91 | This documentation is for a development version of IPython. There may be | |
100 | significant differences from the latest stable release. |
|
92 | significant differences from the latest stable release. | |
101 |
|
93 | |||
102 | """ |
|
94 | """ | |
103 |
|
95 | |||
104 | # The master toctree document. |
|
96 | # The master toctree document. | |
105 | master_doc = 'index' |
|
97 | master_doc = 'index' | |
106 |
|
98 | |||
107 | # General substitutions. |
|
99 | # General substitutions. | |
108 | project = 'IPython' |
|
100 | project = 'IPython' | |
109 | copyright = 'The IPython Development Team' |
|
101 | copyright = 'The IPython Development Team' | |
110 |
|
102 | |||
111 | # ghissue config |
|
103 | # ghissue config | |
112 | github_project_url = "https://github.com/ipython/ipython" |
|
104 | github_project_url = "https://github.com/ipython/ipython" | |
113 |
|
105 | |||
114 | # numpydoc config |
|
106 | # numpydoc config | |
115 | numpydoc_show_class_members = False # Otherwise Sphinx emits thousands of warnings |
|
107 | numpydoc_show_class_members = False # Otherwise Sphinx emits thousands of warnings | |
116 | numpydoc_class_members_toctree = False |
|
108 | numpydoc_class_members_toctree = False | |
117 |
|
109 | |||
118 | # The default replacements for |version| and |release|, also used in various |
|
110 | # The default replacements for |version| and |release|, also used in various | |
119 | # other places throughout the built documents. |
|
111 | # other places throughout the built documents. | |
120 | # |
|
112 | # | |
121 | # The full version, including alpha/beta/rc tags. |
|
113 | # The full version, including alpha/beta/rc tags. | |
122 | release = "%s" % iprelease['version'] |
|
114 | release = "%s" % iprelease['version'] | |
123 | # Just the X.Y.Z part, no '-dev' |
|
115 | # Just the X.Y.Z part, no '-dev' | |
124 | version = iprelease['version'].split('-', 1)[0] |
|
116 | version = iprelease['version'].split('-', 1)[0] | |
125 |
|
117 | |||
126 |
|
118 | |||
127 | # There are two options for replacing |today|: either, you set today to some |
|
119 | # There are two options for replacing |today|: either, you set today to some | |
128 | # non-false value, then it is used: |
|
120 | # non-false value, then it is used: | |
129 | #today = '' |
|
121 | #today = '' | |
130 | # Else, today_fmt is used as the format for a strftime call. |
|
122 | # Else, today_fmt is used as the format for a strftime call. | |
131 | today_fmt = '%B %d, %Y' |
|
123 | today_fmt = '%B %d, %Y' | |
132 |
|
124 | |||
133 | # List of documents that shouldn't be included in the build. |
|
125 | # List of documents that shouldn't be included in the build. | |
134 | #unused_docs = [] |
|
126 | #unused_docs = [] | |
135 |
|
127 | |||
136 | # Exclude these glob-style patterns when looking for source files. They are |
|
128 | # Exclude these glob-style patterns when looking for source files. They are | |
137 | # relative to the source/ directory. |
|
129 | # relative to the source/ directory. | |
138 | exclude_patterns = ['whatsnew/pr'] |
|
130 | exclude_patterns = ['whatsnew/pr'] | |
139 |
|
131 | |||
140 |
|
132 | |||
141 | # If true, '()' will be appended to :func: etc. cross-reference text. |
|
133 | # If true, '()' will be appended to :func: etc. cross-reference text. | |
142 | #add_function_parentheses = True |
|
134 | #add_function_parentheses = True | |
143 |
|
135 | |||
144 | # If true, the current module name will be prepended to all description |
|
136 | # If true, the current module name will be prepended to all description | |
145 | # unit titles (such as .. function::). |
|
137 | # unit titles (such as .. function::). | |
146 | #add_module_names = True |
|
138 | #add_module_names = True | |
147 |
|
139 | |||
148 | # If true, sectionauthor and moduleauthor directives will be shown in the |
|
140 | # If true, sectionauthor and moduleauthor directives will be shown in the | |
149 | # output. They are ignored by default. |
|
141 | # output. They are ignored by default. | |
150 | #show_authors = False |
|
142 | #show_authors = False | |
151 |
|
143 | |||
152 | # The name of the Pygments (syntax highlighting) style to use. |
|
144 | # The name of the Pygments (syntax highlighting) style to use. | |
153 | pygments_style = 'sphinx' |
|
145 | pygments_style = 'sphinx' | |
154 |
|
146 | |||
155 | # Set the default role so we can use `foo` instead of ``foo`` |
|
147 | # Set the default role so we can use `foo` instead of ``foo`` | |
156 | default_role = 'literal' |
|
148 | default_role = 'literal' | |
157 |
|
149 | |||
158 | # Options for HTML output |
|
150 | # Options for HTML output | |
159 | # ----------------------- |
|
151 | # ----------------------- | |
160 |
|
152 | |||
161 | # The style sheet to use for HTML and HTML Help pages. A file of that name |
|
153 | # The style sheet to use for HTML and HTML Help pages. A file of that name | |
162 | # must exist either in Sphinx' static/ path, or in one of the custom paths |
|
154 | # must exist either in Sphinx' static/ path, or in one of the custom paths | |
163 | # given in html_static_path. |
|
155 | # given in html_static_path. | |
164 | # html_style = 'default.css' |
|
156 | # html_style = 'default.css' | |
165 |
|
157 | |||
166 |
|
158 | |||
167 | # The name for this set of Sphinx documents. If None, it defaults to |
|
159 | # The name for this set of Sphinx documents. If None, it defaults to | |
168 | # "<project> v<release> documentation". |
|
160 | # "<project> v<release> documentation". | |
169 | #html_title = None |
|
161 | #html_title = None | |
170 |
|
162 | |||
171 | # The name of an image file (within the static path) to place at the top of |
|
163 | # The name of an image file (within the static path) to place at the top of | |
172 | # the sidebar. |
|
164 | # the sidebar. | |
173 | #html_logo = None |
|
165 | #html_logo = None | |
174 |
|
166 | |||
175 | # Add any paths that contain custom static files (such as style sheets) here, |
|
167 | # Add any paths that contain custom static files (such as style sheets) here, | |
176 | # relative to this directory. They are copied after the builtin static files, |
|
168 | # relative to this directory. They are copied after the builtin static files, | |
177 | # so a file named "default.css" will overwrite the builtin "default.css". |
|
169 | # so a file named "default.css" will overwrite the builtin "default.css". | |
178 | html_static_path = ['_static'] |
|
170 | html_static_path = ['_static'] | |
179 |
|
171 | |||
180 | # Favicon needs the directory name |
|
172 | # Favicon needs the directory name | |
181 | html_favicon = '_static/favicon.ico' |
|
173 | html_favicon = '_static/favicon.ico' | |
182 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
|
174 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, | |
183 | # using the given strftime format. |
|
175 | # using the given strftime format. | |
184 | html_last_updated_fmt = '%b %d, %Y' |
|
176 | html_last_updated_fmt = '%b %d, %Y' | |
185 |
|
177 | |||
186 | # If true, SmartyPants will be used to convert quotes and dashes to |
|
178 | # If true, SmartyPants will be used to convert quotes and dashes to | |
187 | # typographically correct entities. |
|
179 | # typographically correct entities. | |
188 | #html_use_smartypants = True |
|
180 | #html_use_smartypants = True | |
189 |
|
181 | |||
190 | # Custom sidebar templates, maps document names to template names. |
|
182 | # Custom sidebar templates, maps document names to template names. | |
191 | #html_sidebars = {} |
|
183 | #html_sidebars = {} | |
192 |
|
184 | |||
193 | # Additional templates that should be rendered to pages, maps page names to |
|
185 | # Additional templates that should be rendered to pages, maps page names to | |
194 | # template names. |
|
186 | # template names. | |
195 | html_additional_pages = { |
|
187 | html_additional_pages = { | |
196 | 'interactive/htmlnotebook': 'notebook_redirect.html', |
|
188 | 'interactive/htmlnotebook': 'notebook_redirect.html', | |
197 | 'interactive/notebook': 'notebook_redirect.html', |
|
189 | 'interactive/notebook': 'notebook_redirect.html', | |
198 | 'interactive/nbconvert': 'notebook_redirect.html', |
|
190 | 'interactive/nbconvert': 'notebook_redirect.html', | |
199 | 'interactive/public_server': 'notebook_redirect.html', |
|
191 | 'interactive/public_server': 'notebook_redirect.html', | |
200 | } |
|
192 | } | |
201 |
|
193 | |||
202 | # If false, no module index is generated. |
|
194 | # If false, no module index is generated. | |
203 | #html_use_modindex = True |
|
195 | #html_use_modindex = True | |
204 |
|
196 | |||
205 | # If true, the reST sources are included in the HTML build as _sources/<name>. |
|
197 | # If true, the reST sources are included in the HTML build as _sources/<name>. | |
206 | #html_copy_source = True |
|
198 | #html_copy_source = True | |
207 |
|
199 | |||
208 | # If true, an OpenSearch description file will be output, and all pages will |
|
200 | # If true, an OpenSearch description file will be output, and all pages will | |
209 | # contain a <link> tag referring to it. The value of this option must be the |
|
201 | # contain a <link> tag referring to it. The value of this option must be the | |
210 | # base URL from which the finished HTML is served. |
|
202 | # base URL from which the finished HTML is served. | |
211 | #html_use_opensearch = '' |
|
203 | #html_use_opensearch = '' | |
212 |
|
204 | |||
213 | # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). |
|
205 | # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). | |
214 | #html_file_suffix = '' |
|
206 | #html_file_suffix = '' | |
215 |
|
207 | |||
216 | # Output file base name for HTML help builder. |
|
208 | # Output file base name for HTML help builder. | |
217 | htmlhelp_basename = 'ipythondoc' |
|
209 | htmlhelp_basename = 'ipythondoc' | |
218 |
|
210 | |||
219 | intersphinx_mapping = {'python': ('https://docs.python.org/3/', None), |
|
211 | intersphinx_mapping = {'python': ('https://docs.python.org/3/', None), | |
220 | 'rpy2': ('https://rpy2.readthedocs.io/en/version_2.8.x/', None), |
|
212 | 'rpy2': ('https://rpy2.readthedocs.io/en/version_2.8.x/', None), | |
221 | 'traitlets': ('https://traitlets.readthedocs.io/en/latest/', None), |
|
213 | 'traitlets': ('https://traitlets.readthedocs.io/en/latest/', None), | |
222 | 'jupyterclient': ('https://jupyter-client.readthedocs.io/en/latest/', None), |
|
214 | 'jupyterclient': ('https://jupyter-client.readthedocs.io/en/latest/', None), | |
223 | 'ipyparallel': ('https://ipyparallel.readthedocs.io/en/latest/', None), |
|
215 | 'ipyparallel': ('https://ipyparallel.readthedocs.io/en/latest/', None), | |
224 | 'jupyter': ('https://jupyter.readthedocs.io/en/latest/', None), |
|
216 | 'jupyter': ('https://jupyter.readthedocs.io/en/latest/', None), | |
225 | } |
|
217 | } | |
226 |
|
218 | |||
227 | # Options for LaTeX output |
|
219 | # Options for LaTeX output | |
228 | # ------------------------ |
|
220 | # ------------------------ | |
229 |
|
221 | |||
230 | # The paper size ('letter' or 'a4'). |
|
222 | # The paper size ('letter' or 'a4'). | |
231 | latex_paper_size = 'letter' |
|
223 | latex_paper_size = 'letter' | |
232 |
|
224 | |||
233 | # The font size ('10pt', '11pt' or '12pt'). |
|
225 | # The font size ('10pt', '11pt' or '12pt'). | |
234 | latex_font_size = '11pt' |
|
226 | latex_font_size = '11pt' | |
235 |
|
227 | |||
236 | # Grouping the document tree into LaTeX files. List of tuples |
|
228 | # Grouping the document tree into LaTeX files. List of tuples | |
237 | # (source start file, target name, title, author, document class [howto/manual]). |
|
229 | # (source start file, target name, title, author, document class [howto/manual]). | |
238 |
|
230 | |||
239 | latex_documents = [ |
|
231 | latex_documents = [ | |
240 | ('index', 'ipython.tex', 'IPython Documentation', |
|
232 | ('index', 'ipython.tex', 'IPython Documentation', | |
241 | u"""The IPython Development Team""", 'manual', True), |
|
233 | u"""The IPython Development Team""", 'manual', True), | |
242 | ('parallel/winhpc_index', 'winhpc_whitepaper.tex', |
|
234 | ('parallel/winhpc_index', 'winhpc_whitepaper.tex', | |
243 | 'Using IPython on Windows HPC Server 2008', |
|
235 | 'Using IPython on Windows HPC Server 2008', | |
244 | u"Brian E. Granger", 'manual', True) |
|
236 | u"Brian E. Granger", 'manual', True) | |
245 | ] |
|
237 | ] | |
246 |
|
238 | |||
247 | # The name of an image file (relative to this directory) to place at the top of |
|
239 | # The name of an image file (relative to this directory) to place at the top of | |
248 | # the title page. |
|
240 | # the title page. | |
249 | #latex_logo = None |
|
241 | #latex_logo = None | |
250 |
|
242 | |||
251 | # For "manual" documents, if this is true, then toplevel headings are parts, |
|
243 | # For "manual" documents, if this is true, then toplevel headings are parts, | |
252 | # not chapters. |
|
244 | # not chapters. | |
253 | #latex_use_parts = False |
|
245 | #latex_use_parts = False | |
254 |
|
246 | |||
255 | # Additional stuff for the LaTeX preamble. |
|
247 | # Additional stuff for the LaTeX preamble. | |
256 | #latex_preamble = '' |
|
248 | #latex_preamble = '' | |
257 |
|
249 | |||
258 | # Documents to append as an appendix to all manuals. |
|
250 | # Documents to append as an appendix to all manuals. | |
259 | #latex_appendices = [] |
|
251 | #latex_appendices = [] | |
260 |
|
252 | |||
261 | # If false, no module index is generated. |
|
253 | # If false, no module index is generated. | |
262 | latex_use_modindex = True |
|
254 | latex_use_modindex = True | |
263 |
|
255 | |||
264 |
|
256 | |||
265 | # Options for texinfo output |
|
257 | # Options for texinfo output | |
266 | # -------------------------- |
|
258 | # -------------------------- | |
267 |
|
259 | |||
268 | texinfo_documents = [ |
|
260 | texinfo_documents = [ | |
269 | (master_doc, 'ipython', 'IPython Documentation', |
|
261 | (master_doc, 'ipython', 'IPython Documentation', | |
270 | 'The IPython Development Team', |
|
262 | 'The IPython Development Team', | |
271 | 'IPython', |
|
263 | 'IPython', | |
272 | 'IPython Documentation', |
|
264 | 'IPython Documentation', | |
273 | 'Programming', |
|
265 | 'Programming', | |
274 | 1), |
|
266 | 1), | |
275 | ] |
|
267 | ] | |
276 |
|
268 | |||
277 | modindex_common_prefix = ['IPython.'] |
|
269 | modindex_common_prefix = ['IPython.'] | |
278 |
|
270 | |||
279 |
|
271 | |||
280 | # Cleanup |
|
272 | # Cleanup | |
281 | # ------- |
|
273 | # ------- | |
282 | # delete release info to avoid pickling errors from sphinx |
|
274 | # delete release info to avoid pickling errors from sphinx | |
283 |
|
275 | |||
284 | del iprelease |
|
276 | del iprelease |
@@ -1,111 +1,111 b'' | |||||
1 | .. _introduction: |
|
1 | .. _introduction: | |
2 |
|
2 | |||
3 | ===================== |
|
3 | ===================== | |
4 | IPython Documentation |
|
4 | IPython Documentation | |
5 | ===================== |
|
5 | ===================== | |
6 |
|
6 | |||
7 |
.. |
|
7 | .. only:: html | |
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 inherit 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 |
.. |
|
107 | .. only:: html | |
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