Skip to content

Commit 5d44206

Browse files
TravisBotTravisBot
authored andcommitted
Updated website (automated commit) – Saturday, 02. April 2016 12:11AM
1 parent 122c4b7 commit 5d44206

29 files changed

+101
-253
lines changed
Binary file not shown.

_sources/notebook.txt

Lines changed: 9 additions & 130 deletions
Original file line numberDiff line numberDiff line change
@@ -1,135 +1,14 @@
11
.. _notebook:
22

3-
======================
4-
The IPython Notebook
5-
======================
3+
The Jupyter Notebook
4+
====================
65

7-
The IPython Notebook is an interactive computational environment, in which you
8-
can combine code execution, rich text, mathematics, plots and rich media, as
9-
shown in this example session:
6+
(Formerly known as the IPython Notebook)
7+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
108

11-
.. raw:: html
12-
13-
<div align="center">
14-
15-
.. image:: _static/sloangrant/9_home_fperez_prof_grants_1207-sloan-ipython_proposal_fig_ipython-notebook-specgram.png
16-
:width: 350px
17-
:alt: The IPython notebook with embedded rich text, code, mathematics and figures.
18-
:target: _static/sloangrant/9_home_fperez_prof_grants_1207-sloan-ipython_proposal_fig_ipython-notebook-specgram.png
19-
20-
.. raw:: html
21-
22-
</div>
23-
24-
It aims to be an agile tool for both exploratory computation and data analysis,
25-
and provides a platform to support **reproducible research**, since all inputs
26-
and outputs may be stored in a one-to-one way in notebook documents.
27-
28-
29-
There are two components:
30-
31-
* The **IPython Notebook** web application, for interactive authoring of literate computations, in which explanatory text, mathematics, computations and rich media output may be combined. Input and output are stored in persistent cells that may be edited in-place.
32-
33-
* Plain text documents, called **notebooks**, for recording and distributing the results of the rich computations.
34-
35-
36-
The Notebook app automatically saves the current state of the computation in
37-
the web browser to the corresponding notebook, which is just a standard text
38-
file with the extension ``.ipynb``, stored in a working directory on your
39-
computer. This file can be easily put under version control and shared with
40-
colleagues.
41-
42-
Despite the fact that the notebook documents are plain text files, they use
43-
the JSON format in order to store a **complete**, **reproducible** copy of the
44-
current state of the computation inside the Notebook app.
45-
46-
Features of the IPython Notebook web app
47-
----------------------------------------
48-
49-
Some of the main features of the IPython Notebook app include:
50-
51-
* Display rich data representations (e.g. HTML / LaTeX / SVG) in the browser as a result of computations.
52-
* Compose rich text using Markdown_ and HTML.
53-
* Include mathematical equations, rendered directly in the browser by MathJax_.
54-
* Import standard Python scripts.
55-
* In-browser editing, syntax highlighting, tab completion and autoindentation.
56-
* Inline figures rendered by the matplotlib_ library with publication quality, in a range of formats (SVG / PDF / PNG).
57-
58-
.. _matplotlib: http://matplotlib.org
59-
.. _Markdown: http://daringfireball.net/projects/markdown/syntax
60-
.. _MathJax: http://mathjax.org
61-
62-
If you have ever used the Mathematica or SAGE notebooks (the latter is also
63-
web-based__) you should feel right at home. If you have not, you will be
64-
able to learn how to use the IPython Notebook in just a few minutes.
65-
66-
.. __: http://sagenb.org
67-
68-
69-
Notebook documents
70-
------------------
71-
72-
Notebook documents (or notebooks) are files which record all computations
73-
carried out and the results obtained in a literate way, including inputs,
74-
outputs, together with descriptive text and mathematics.
75-
76-
They are plain text files, which are thus easy to share with colleagues and
77-
place under version control. But, by using the JSON format, they can record
78-
all aspects of the computation, including embedding rich media output. The
79-
standard file extension for notebook documents is ``.ipynb``.
80-
81-
Notebooks may easily be exported_ to a range of static formats, including HTML
82-
(for example, for blog posts), PDF and slide shows. Any publicly
83-
available notebook may be shared via the `IPython Notebook Viewer
84-
<http://nbviewer.ipython.org>`_ service, which will provide it as a static web
85-
page. This makes it easy to give your colleagues a document they
86-
can read immediately without having to install anything.
87-
88-
89-
To learn more about using the IPython Notebook, you can visit our `example
90-
collection`_, and you can read the documentation_ for all the details on how
91-
to use and configure the system. The `notebook gallery`_ showcases many
92-
interesting notebooks covering a variety of topics, from basic programming to
93-
advanced scientific computing.
94-
95-
Here is a short demo of the IPython Notebook's basic features by the
96-
Pybonacci_ team:
97-
98-
.. raw:: html
99-
100-
<div align="center">
101-
<iframe title="YouTube video player2"
102-
width="550" height="350"
103-
src="http://www.youtube.com/embed/H6dLGQw9yFQ"
104-
frameborder="0" allowfullscreen>
105-
</iframe></div><br>
106-
107-
.. _Pybonacci: http://pybonacci.org
108-
109-
.. _example collection: http://nbviewer.ipython.org/github/ipython/ipython/blob/2.x/examples/Notebook/Index.ipynb
110-
111-
.. _documentation: http://ipython.org/ipython-doc/stable/interactive/notebook.html
112-
113-
.. _exported: http://ipython.org/ipython-doc/stable/interactive/nbconvert.html
114-
115-
.. _notebook gallery:
116-
https://github.com/ipython/ipython/wiki/A-gallery-of-interesting-IPython-Notebooks
117-
118-
For a thorough introduction to the IPython Notebook, you can check out the
119-
*IPython in Depth* tutorial from the `SciPy 2013`_ scientific Python
120-
conference, led by the two creators of the IPython package, Fernando Pérez
121-
and Brian Granger:
122-
123-
.. raw:: html
124-
125-
<div align="center">
126-
<iframe title="YouTube video player3"
127-
<iframe width="560" height="315"
128-
src="http://www.youtube.com/embed/xe_ATRmw0KM" frameborder="0"
129-
allowfullscreen></iframe>
130-
</div><br>
131-
132-
133-
.. _SciPy 2013:
134-
.. https://conference.scipy.org/scipy2013/
9+
The IPython Notebook is now known as the Jupyter Notebook. It is an interactive
10+
computational environment, in which you can combine code execution, rich text,
11+
mathematics, plots and rich media. For more details on the Jupyter Notebook,
12+
please see the Jupyter_ website.
13513

14+
.. _Jupyter: http://jupyter.org/

_static/basic.css

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ div.sphinxsidebar {
5252
width: 0px;
5353
margin-left: -100%;
5454
font-size: 90%;
55+
word-wrap: break-word;
56+
overflow-wrap : break-word;
5557
}
5658

5759
div.sphinxsidebar ul {
@@ -187,6 +189,13 @@ div.genindex-jumpbox {
187189

188190
/* -- general body styles --------------------------------------------------- */
189191

192+
div.body p, div.body dd, div.body li, div.body blockquote {
193+
-moz-hyphens: auto;
194+
-ms-hyphens: auto;
195+
-webkit-hyphens: auto;
196+
hyphens: auto;
197+
}
198+
190199
a.headerlink {
191200
visibility: hidden;
192201
}

_static/doctools.js

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,7 @@ var Documentation = {
124124
this.fixFirefoxAnchorBug();
125125
this.highlightSearchWords();
126126
this.initIndexTable();
127+
127128
},
128129

129130
/**
@@ -252,6 +253,29 @@ var Documentation = {
252253
});
253254
var url = parts.join('/');
254255
return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
256+
},
257+
258+
initOnKeyListeners: function() {
259+
$(document).keyup(function(event) {
260+
var activeElementType = document.activeElement.tagName;
261+
// don't navigate when in search box or textarea
262+
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') {
263+
switch (event.keyCode) {
264+
case 37: // left
265+
var prevHref = $('link[rel="prev"]').prop('href');
266+
if (prevHref) {
267+
window.location.href = prevHref;
268+
return false;
269+
}
270+
case 39: // right
271+
var nextHref = $('link[rel="next"]').prop('href');
272+
if (nextHref) {
273+
window.location.href = nextHref;
274+
return false;
275+
}
276+
}
277+
}
278+
});
255279
}
256280
};
257281

@@ -260,4 +284,4 @@ _ = Documentation.gettext;
260284

261285
$(document).ready(function() {
262286
Documentation.init();
263-
});
287+
});

_static/websupport.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* websupport.js
33
* ~~~~~~~~~~~~~
44
*
5-
* sphinx.websupport utilties for all documentation.
5+
* sphinx.websupport utilities for all documentation.
66
*
77
* :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
88
* :license: BSD, see LICENSE for details.

books.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -302,7 +302,7 @@ <h2>IPython Minibook<a class="headerlink" href="#ipython-minibook" title="Permal
302302

303303
<div class="footer" role="contentinfo">
304304
&copy; Copyright the IPython development team.
305-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.5.
305+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.
306306
</div>
307307
</div>
308308

citing.html

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -268,20 +268,20 @@ <h1>Citing IPython<a class="headerlink" href="#citing-ipython" title="Permalink
268268
please acknowledge that fact by citing the project. As of now, the canonical
269269
academic reference for IPython is <a class="reference external" href="http://fperez.org/papers/ipython07_pe-gr_cise.pdf">this paper</a>, for which here are both
270270
a BibTex and a plaintext reference you can use:</p>
271-
<div class="highlight-python"><div class="highlight"><pre><span></span>@Article{PER-GRA:2007,
272-
Author = {P\&#39;erez, Fernando and Granger, Brian E.},
273-
Title = {{IP}ython: a System for Interactive Scientific Computing},
274-
Journal = {Computing in Science and Engineering},
275-
Volume = {9},
276-
Number = {3},
277-
Pages = {21--29},
278-
month = may,
279-
year = 2007,
280-
url = &quot;http://ipython.org&quot;,
281-
ISSN = &quot;1521-9615&quot;,
282-
doi = {10.1109/MCSE.2007.53},
283-
publisher = {IEEE Computer Society},
284-
}
271+
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="nd">@Article</span><span class="p">{</span><span class="n">PER</span><span class="o">-</span><span class="n">GRA</span><span class="p">:</span><span class="mi">2007</span><span class="p">,</span>
272+
<span class="n">Author</span> <span class="o">=</span> <span class="p">{</span><span class="n">P</span>\<span class="s1">&#39;erez, Fernando and Granger, Brian E.},</span>
273+
<span class="n">Title</span> <span class="o">=</span> <span class="p">{{</span><span class="n">IP</span><span class="p">}</span><span class="n">ython</span><span class="p">:</span> <span class="n">a</span> <span class="n">System</span> <span class="k">for</span> <span class="n">Interactive</span> <span class="n">Scientific</span> <span class="n">Computing</span><span class="p">},</span>
274+
<span class="n">Journal</span> <span class="o">=</span> <span class="p">{</span><span class="n">Computing</span> <span class="ow">in</span> <span class="n">Science</span> <span class="ow">and</span> <span class="n">Engineering</span><span class="p">},</span>
275+
<span class="n">Volume</span> <span class="o">=</span> <span class="p">{</span><span class="mi">9</span><span class="p">},</span>
276+
<span class="n">Number</span> <span class="o">=</span> <span class="p">{</span><span class="mi">3</span><span class="p">},</span>
277+
<span class="n">Pages</span> <span class="o">=</span> <span class="p">{</span><span class="mi">21</span><span class="o">--</span><span class="mi">29</span><span class="p">},</span>
278+
<span class="n">month</span> <span class="o">=</span> <span class="n">may</span><span class="p">,</span>
279+
<span class="n">year</span> <span class="o">=</span> <span class="mi">2007</span><span class="p">,</span>
280+
<span class="n">url</span> <span class="o">=</span> <span class="s2">&quot;http://ipython.org&quot;</span><span class="p">,</span>
281+
<span class="n">ISSN</span> <span class="o">=</span> <span class="s2">&quot;1521-9615&quot;</span><span class="p">,</span>
282+
<span class="n">doi</span> <span class="o">=</span> <span class="p">{</span><span class="mf">10.1109</span><span class="o">/</span><span class="n">MCSE</span><span class="o">.</span><span class="mf">2007.53</span><span class="p">},</span>
283+
<span class="n">publisher</span> <span class="o">=</span> <span class="p">{</span><span class="n">IEEE</span> <span class="n">Computer</span> <span class="n">Society</span><span class="p">},</span>
284+
<span class="p">}</span>
285285
</pre></div>
286286
</div>
287287
<p>or in plaintext:</p>
@@ -305,7 +305,7 @@ <h1>Citing IPython<a class="headerlink" href="#citing-ipython" title="Permalink
305305

306306
<div class="footer" role="contentinfo">
307307
&copy; Copyright the IPython development team.
308-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.5.
308+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.
309309
</div>
310310
</div>
311311

documentation.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@ <h2>Current Documentation<a class="headerlink" href="#current-documentation" tit
312312

313313
<div class="footer" role="contentinfo">
314314
&copy; Copyright the IPython development team.
315-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.5.
315+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.
316316
</div>
317317
</div>
318318

donate.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,7 @@ <h1>Support IPython Development<a class="headerlink" href="#support-ipython-deve
313313

314314
<div class="footer" role="contentinfo">
315315
&copy; Copyright the IPython development team.
316-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.5.
316+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.
317317
</div>
318318
</div>
319319

faq.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -294,8 +294,8 @@ <h2>IPython crashes under OS X when using the arrow keys<a class="headerlink" hr
294294
<li><p class="first">Use a different Python version from Apple&#8217;s default (MacPython or Fink have been reported to work)</p>
295295
</li>
296296
<li><p class="first">You can disable in your ipythonrc file the following lines by commenting them out:</p>
297-
<div class="highlight-python"><div class="highlight"><pre><span></span>readline_parse_and_bind &quot;\e[A&quot;: history-search-backward
298-
readline_parse_and_bind &quot;\e[B&quot;: history-search-forward
297+
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">readline_parse_and_bind</span> <span class="s2">&quot;\e[A&quot;</span><span class="p">:</span> <span class="n">history</span><span class="o">-</span><span class="n">search</span><span class="o">-</span><span class="n">backward</span>
298+
<span class="n">readline_parse_and_bind</span> <span class="s2">&quot;\e[B&quot;</span><span class="p">:</span> <span class="n">history</span><span class="o">-</span><span class="n">search</span><span class="o">-</span><span class="n">forward</span>
299299
</pre></div>
300300
</div>
301301
</li>
@@ -329,7 +329,7 @@ <h2>What is the best way to install IPython?<a class="headerlink" href="#what-is
329329

330330
<div class="footer" role="contentinfo">
331331
&copy; Copyright the IPython development team.
332-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.5.
332+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.
333333
</div>
334334
</div>
335335

0 commit comments

Comments
 (0)