##// END OF EJS Templates
Deleted jargon-ish reference to no-connectity.
damianavila -
Show More
@@ -1,230 +1,230 b''
1 .. _nbconvert:
1 .. _nbconvert:
2
2
3 Converting notebooks to other formats
3 Converting notebooks to other formats
4 =====================================
4 =====================================
5
5
6 Newly added in the 1.0 release of IPython is the ``nbconvert`` tool, which
6 Newly added in the 1.0 release of IPython is the ``nbconvert`` tool, which
7 allows you to convert an ``.ipynb`` notebook document file into various static
7 allows you to convert an ``.ipynb`` notebook document file into various static
8 formats.
8 formats.
9
9
10 Currently, ``nbconvert`` is provided as a command line tool, run as a script
10 Currently, ``nbconvert`` is provided as a command line tool, run as a script
11 using IPython. A direct export capability from within the
11 using IPython. A direct export capability from within the
12 IPython Notebook web app is planned.
12 IPython Notebook web app is planned.
13
13
14 The command-line syntax to run the ``nbconvert`` script is::
14 The command-line syntax to run the ``nbconvert`` script is::
15
15
16 $ ipython nbconvert --to FORMAT notebook.ipynb
16 $ ipython nbconvert --to FORMAT notebook.ipynb
17
17
18 This will convert the IPython document file ``notebook.ipynb`` into the output
18 This will convert the IPython document file ``notebook.ipynb`` into the output
19 format given by the ``FORMAT`` string.
19 format given by the ``FORMAT`` string.
20
20
21 The default output format is html, for which the ``--to`` argument may be
21 The default output format is html, for which the ``--to`` argument may be
22 omitted::
22 omitted::
23
23
24 $ ipython nbconvert notebook.ipynb
24 $ ipython nbconvert notebook.ipynb
25
25
26 IPython provides a few templates for some output formats, and these can be
26 IPython provides a few templates for some output formats, and these can be
27 specified via an additional ``--template`` argument.
27 specified via an additional ``--template`` argument.
28
28
29 The currently supported export formats are:
29 The currently supported export formats are:
30
30
31 * ``--to html``
31 * ``--to html``
32
32
33 - ``--template full`` (default)
33 - ``--template full`` (default)
34
34
35 A full static HTML render of the notebook.
35 A full static HTML render of the notebook.
36 This looks very similar to the interactive view.
36 This looks very similar to the interactive view.
37
37
38 - ``--template basic``
38 - ``--template basic``
39
39
40 Simplified HTML, useful for embedding in webpages, blogs, etc.
40 Simplified HTML, useful for embedding in webpages, blogs, etc.
41 This excludes HTML headers.
41 This excludes HTML headers.
42
42
43 * ``--to latex``
43 * ``--to latex``
44
44
45 Latex export. This generates ``NOTEBOOK_NAME.tex`` file,
45 Latex export. This generates ``NOTEBOOK_NAME.tex`` file,
46 ready for export. You can automatically run latex on it to generate a PDF
46 ready for export. You can automatically run latex on it to generate a PDF
47 by adding ``--post PDF``.
47 by adding ``--post PDF``.
48
48
49 - ``--template article`` (default)
49 - ``--template article`` (default)
50
50
51 Latex article, derived from Sphinx's howto template.
51 Latex article, derived from Sphinx's howto template.
52
52
53 - ``--template book``
53 - ``--template book``
54
54
55 Latex book, derived from Sphinx's manual template.
55 Latex book, derived from Sphinx's manual template.
56
56
57 - ``--template basic``
57 - ``--template basic``
58
58
59 Very basic latex output - mainly meant as a starting point for custom templates.
59 Very basic latex output - mainly meant as a starting point for custom templates.
60
60
61 * ``--to slides``
61 * ``--to slides``
62
62
63 This generates a Reveal.js HTML slideshow.
63 This generates a Reveal.js HTML slideshow.
64 It must be served by an HTTP server. The easiest way to do this is adding
64 It must be served by an HTTP server. The easiest way to do this is adding
65 ``--post serve`` on the command-line. The ``serve`` post-processor
65 ``--post serve`` on the command-line. The ``serve`` post-processor proxies
66 proxies Reveal.js requests to a CDN if no local Reveal.js library is present.
66 Reveal.js requests to a CDN if no local Reveal.js library is present.
67 For low connectivity environments, just place the Reveal.js library in the
67 To make slides that don't require an internet connection, just place the
68 same directory where your_talk.slides.html is located or point to another
68 Reveal.js library in the same directory where your_talk.slides.html is located,
69 directory using the ``--reveal-prefix`` alias.
69 or point to another directory using the ``--reveal-prefix`` alias.
70
70
71 * ``--to markdown``
71 * ``--to markdown``
72
72
73 Simple markdown output. Markdown cells are unaffected,
73 Simple markdown output. Markdown cells are unaffected,
74 and code cells are placed in triple-backtick (```````) blocks.
74 and code cells are placed in triple-backtick (```````) blocks.
75
75
76 * ``--to rst``
76 * ``--to rst``
77
77
78 Basic reStructuredText output. Useful as a starting point for embedding notebooks
78 Basic reStructuredText output. Useful as a starting point for embedding notebooks
79 in Sphinx docs.
79 in Sphinx docs.
80
80
81 * ``--to python``
81 * ``--to python``
82
82
83 Convert a notebook to an executable Python script.
83 Convert a notebook to an executable Python script.
84 This is the simplest way to get a Python script out of a notebook.
84 This is the simplest way to get a Python script out of a notebook.
85 If there were any magics in the notebook, this may only be executable from
85 If there were any magics in the notebook, this may only be executable from
86 an IPython session.
86 an IPython session.
87
87
88 .. note::
88 .. note::
89
89
90 nbconvert uses pandoc_ to convert between various markup languages,
90 nbconvert uses pandoc_ to convert between various markup languages,
91 so pandoc is a dependency of most nbconvert transforms,
91 so pandoc is a dependency of most nbconvert transforms,
92 excluding Markdown and Python.
92 excluding Markdown and Python.
93
93
94 .. _pandoc: http://johnmacfarlane.net/pandoc/
94 .. _pandoc: http://johnmacfarlane.net/pandoc/
95
95
96 The output file created by ``nbconvert`` will have the same base name as
96 The output file created by ``nbconvert`` will have the same base name as
97 the notebook and will be placed in the current working directory. Any
97 the notebook and will be placed in the current working directory. Any
98 supporting files (graphics, etc) will be placed in a new directory with the
98 supporting files (graphics, etc) will be placed in a new directory with the
99 same base name as the notebook, suffixed with ``_files``::
99 same base name as the notebook, suffixed with ``_files``::
100
100
101 $ ipython nbconvert notebook.ipynb
101 $ ipython nbconvert notebook.ipynb
102 $ ls
102 $ ls
103 notebook.ipynb notebook.html notebook_files/
103 notebook.ipynb notebook.html notebook_files/
104
104
105 For simple single-file output, such as html, markdown, etc.,
105 For simple single-file output, such as html, markdown, etc.,
106 the output may be sent to standard output with::
106 the output may be sent to standard output with::
107
107
108 $ ipython nbconvert --to markdown notebook.ipynb --stdout
108 $ ipython nbconvert --to markdown notebook.ipynb --stdout
109
109
110 Multiple notebooks can be specified from the command line::
110 Multiple notebooks can be specified from the command line::
111
111
112 $ ipython nbconvert notebook*.ipynb
112 $ ipython nbconvert notebook*.ipynb
113 $ ipython nbconvert notebook1.ipynb notebook2.ipynb
113 $ ipython nbconvert notebook1.ipynb notebook2.ipynb
114
114
115 or via a list in a configuration file, say ``mycfg.py``, containing the text::
115 or via a list in a configuration file, say ``mycfg.py``, containing the text::
116
116
117 c = get_config()
117 c = get_config()
118 c.NbConvertApp.notebooks = ["notebook1.ipynb", "notebook2.ipynb"]
118 c.NbConvertApp.notebooks = ["notebook1.ipynb", "notebook2.ipynb"]
119
119
120 and using the command::
120 and using the command::
121
121
122 $ ipython nbconvert --config mycfg.py
122 $ ipython nbconvert --config mycfg.py
123
123
124
124
125 .. _notebook_format:
125 .. _notebook_format:
126
126
127 LaTeX citations
127 LaTeX citations
128 ---------------
128 ---------------
129
129
130 ``nbconvert`` now has support for LaTeX citations. With this capability you
130 ``nbconvert`` now has support for LaTeX citations. With this capability you
131 can:
131 can:
132
132
133 * Manage citations using BibTeX.
133 * Manage citations using BibTeX.
134 * Cite those citations in Markdown cells using HTML data attributes.
134 * Cite those citations in Markdown cells using HTML data attributes.
135 * Have ``nbconvert`` generate proper LaTeX citations and run BibTeX.
135 * Have ``nbconvert`` generate proper LaTeX citations and run BibTeX.
136
136
137 For an example of how this works, please see the citations example in
137 For an example of how this works, please see the citations example in
138 the nbconvert-examples_ repository.
138 the nbconvert-examples_ repository.
139
139
140 .. _nbconvert-examples: https://github.com/ipython/nbconvert-examples
140 .. _nbconvert-examples: https://github.com/ipython/nbconvert-examples
141
141
142 Notebook JSON file format
142 Notebook JSON file format
143 -------------------------
143 -------------------------
144
144
145 Notebook documents are JSON files with an ``.ipynb`` extension, formatted
145 Notebook documents are JSON files with an ``.ipynb`` extension, formatted
146 as legibly as possible with minimal extra indentation and cell content broken
146 as legibly as possible with minimal extra indentation and cell content broken
147 across lines to make them reasonably friendly to use in version-control
147 across lines to make them reasonably friendly to use in version-control
148 workflows. You should be very careful if you ever manually edit this JSON
148 workflows. You should be very careful if you ever manually edit this JSON
149 data, as it is extremely easy to corrupt its internal structure and make the
149 data, as it is extremely easy to corrupt its internal structure and make the
150 file impossible to load. In general, you should consider the notebook as a
150 file impossible to load. In general, you should consider the notebook as a
151 file meant only to be edited by the IPython Notebook app itself, not for
151 file meant only to be edited by the IPython Notebook app itself, not for
152 hand-editing.
152 hand-editing.
153
153
154 .. note::
154 .. note::
155
155
156 Binary data such as figures are also saved directly in the JSON file.
156 Binary data such as figures are also saved directly in the JSON file.
157 This provides convenient single-file portability, but means that the
157 This provides convenient single-file portability, but means that the
158 files can be large; a ``diff`` of binary data is also not very
158 files can be large; a ``diff`` of binary data is also not very
159 meaningful. Since the binary blobs are encoded in a single line, they
159 meaningful. Since the binary blobs are encoded in a single line, they
160 affect only one line of the ``diff`` output, but they are typically very
160 affect only one line of the ``diff`` output, but they are typically very
161 long lines. You can use the ``Cell | All Output | Clear`` menu option to
161 long lines. You can use the ``Cell | All Output | Clear`` menu option to
162 remove all output from a notebook prior to committing it to version
162 remove all output from a notebook prior to committing it to version
163 control, if this is a concern.
163 control, if this is a concern.
164
164
165 The notebook server can also generate a pure Python version of your notebook,
165 The notebook server can also generate a pure Python version of your notebook,
166 using the ``File | Download as`` menu option. The resulting ``.py`` file will
166 using the ``File | Download as`` menu option. The resulting ``.py`` file will
167 contain all the code cells from your notebook verbatim, and all Markdown cells
167 contain all the code cells from your notebook verbatim, and all Markdown cells
168 prepended with a comment marker. The separation between code and Markdown
168 prepended with a comment marker. The separation between code and Markdown
169 cells is indicated with special comments and there is a header indicating the
169 cells is indicated with special comments and there is a header indicating the
170 format version. All output is removed when exporting to Python.
170 format version. All output is removed when exporting to Python.
171
171
172 As an example, consider a simple notebook called ``simple.ipynb`` which
172 As an example, consider a simple notebook called ``simple.ipynb`` which
173 contains one Markdown cell, with the content ``The simplest notebook.``, one
173 contains one Markdown cell, with the content ``The simplest notebook.``, one
174 code input cell with the content ``print "Hello, IPython!"``, and the
174 code input cell with the content ``print "Hello, IPython!"``, and the
175 corresponding output.
175 corresponding output.
176
176
177 The contents of the notebook document ``simple.ipynb`` is the following JSON
177 The contents of the notebook document ``simple.ipynb`` is the following JSON
178 container::
178 container::
179
179
180 {
180 {
181 "metadata": {
181 "metadata": {
182 "name": "simple"
182 "name": "simple"
183 },
183 },
184 "nbformat": 3,
184 "nbformat": 3,
185 "nbformat_minor": 0,
185 "nbformat_minor": 0,
186 "worksheets": [
186 "worksheets": [
187 {
187 {
188 "cells": [
188 "cells": [
189 {
189 {
190 "cell_type": "markdown",
190 "cell_type": "markdown",
191 "metadata": {},
191 "metadata": {},
192 "source": "The simplest notebook."
192 "source": "The simplest notebook."
193 },
193 },
194 {
194 {
195 "cell_type": "code",
195 "cell_type": "code",
196 "collapsed": false,
196 "collapsed": false,
197 "input": "print \"Hello, IPython\"",
197 "input": "print \"Hello, IPython\"",
198 "language": "python",
198 "language": "python",
199 "metadata": {},
199 "metadata": {},
200 "outputs": [
200 "outputs": [
201 {
201 {
202 "output_type": "stream",
202 "output_type": "stream",
203 "stream": "stdout",
203 "stream": "stdout",
204 "text": "Hello, IPython\n"
204 "text": "Hello, IPython\n"
205 }
205 }
206 ],
206 ],
207 "prompt_number": 1
207 "prompt_number": 1
208 }
208 }
209 ],
209 ],
210 "metadata": {}
210 "metadata": {}
211 }
211 }
212 ]
212 ]
213 }
213 }
214
214
215
215
216 The corresponding Python script is::
216 The corresponding Python script is::
217
217
218 # -*- coding: utf-8 -*-
218 # -*- coding: utf-8 -*-
219 # <nbformat>3.0</nbformat>
219 # <nbformat>3.0</nbformat>
220
220
221 # <markdowncell>
221 # <markdowncell>
222
222
223 # The simplest notebook.
223 # The simplest notebook.
224
224
225 # <codecell>
225 # <codecell>
226
226
227 print "Hello, IPython"
227 print "Hello, IPython"
228
228
229 Note that indeed the output of the code cell, which is present in the JSON
229 Note that indeed the output of the code cell, which is present in the JSON
230 container, has been removed in the ``.py`` script.
230 container, has been removed in the ``.py`` script.
General Comments 0
You need to be logged in to leave comments. Login now