##// END OF EJS Templates
add some detail in rst and markdown output
MinRK -
Show More
@@ -31,25 +31,31 b' The currently supported export formats are:'
31 * ``--to html``
31 * ``--to html``
32
32
33 - ``--template full`` (default)
33 - ``--template full`` (default)
34
34 A full static HTML render of the notebook.
35 A full static HTML render of the notebook.
35 This looks very similar to the interactive view.
36 This looks very similar to the interactive view.
36
37
37 - ``--template basic``
38 - ``--template basic``
39
38 Simplified HTML, useful for embedding in webpages, blogs, etc.
40 Simplified HTML, useful for embedding in webpages, blogs, etc.
39 This excludes HTML headers.
41 This excludes HTML headers.
40
42
41 * ``--to latex``
43 * ``--to latex``
44
42 Latex export. This generates ``NOTEBOOK_NAME.tex`` file,
45 Latex export. This generates ``NOTEBOOK_NAME.tex`` file,
43 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
44 by adding ``--post PDF``.
47 by adding ``--post PDF``.
45
48
46 - ``--template article`` (default)
49 - ``--template article`` (default)
50
47 Latex article, derived from Sphinx's howto template.
51 Latex article, derived from Sphinx's howto template.
48
52
49 - ``--template book``
53 - ``--template book``
54
50 Latex book, derived from Sphinx's manual template.
55 Latex book, derived from Sphinx's manual template.
51
56
52 - ``--template basic``
57 - ``--template basic``
58
53 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.
54
60
55 * ``--to slides``
61 * ``--to slides``
@@ -58,15 +64,24 b' The currently supported export formats are:'
58 It must be served by an HTTP server. The easiest way to get this is to add
64 It must be served by an HTTP server. The easiest way to get this is to add
59 ``--post serve`` on the command-line.
65 ``--post serve`` on the command-line.
60
66
61 * ``--to markdown`` Simple markdown
67 * ``--to markdown``
68
69 Simple markdown output. Markdown cells are unaffected,
70 and code cells are placed in triple-backtick (``\`\`\```) blocks.
71
72 * ``--to rst``
62
73
63 * ``--to rst`` reStructuredText
74 Basic reStructuredText output. Useful as a starting point for embedding notebooks
75 in Sphinx docs.
64
76
65 * ``--to python`` Convert a notebook to an executable Python script.
77 * ``--to python``
78
79 Convert a notebook to an executable Python script.
66 This is the simplest way to get a Python script out of a notebook.
80 This is the simplest way to get a Python script out of a notebook.
67 If there were any magics in the notebook, this may only be executable from
81 If there were any magics in the notebook, this may only be executable from
68 an IPython session.
82 an IPython session.
69
83
84
70 The output file created by ``nbconvert`` will have the same base name as
85 The output file created by ``nbconvert`` will have the same base name as
71 the notebook and will be placed in the current working directory. Any
86 the notebook and will be placed in the current working directory. Any
72 supporting files (graphics, etc) will be placed in a new directory with the
87 supporting files (graphics, etc) will be placed in a new directory with the
General Comments 0
You need to be logged in to leave comments. Login now