forked from wesm/ipython
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding initial documentation on the notebook.
- Loading branch information
Showing
4 changed files
with
84 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
.. _htmlnotebook: | ||
|
||
========================= | ||
An HTML Notebook IPython | ||
========================= | ||
|
||
The IPython Notebook consists of two related components: | ||
|
||
* An XML/JSON based Notebook document format for recording and distributing | ||
Python code and rich text. | ||
* A web-based user interface for authoring and running notebook documents. | ||
|
||
The Notebook can be used by starting the Notebook server with the | ||
command:: | ||
|
||
$ ipython notebook | ||
|
||
This server uses the same ZeroMQ-based two process kernel architecture as | ||
the QT Console as well Tornado for serving HTTP requests. Some of the main | ||
features of the Notebook include: | ||
|
||
* Display rich data (png/html/latex/svg) in the browser as a result of | ||
computations. | ||
* Compose text cells using HTML and Markdown. | ||
* Import and export notebook documents in range of formats (.ipynb, .json, .py). | ||
* In browser syntax highlighting, tab completion and autoindentation. | ||
* Inline matplotlib plots that can be stored in Notebook documents and opened | ||
later. | ||
|
||
See :ref:`our installation documentation <install_index>` for directions on | ||
how to install the notebook and its dependencies. | ||
|
||
Basic Usage | ||
=========== | ||
|
||
Notebook document format | ||
======================== | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,5 +10,6 @@ Using IPython for interactive work | |
reference.txt | ||
shell.txt | ||
qtconsole.txt | ||
htmlnotebook.txt | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters