##// END OF EJS Templates
Add usage note.
Fernando Perez -
Show More
@@ -1,45 +1,57 b''
1 1 ================================================================
2 2 nbconvert: conversion utilities for the IPython notebook format
3 3 ================================================================
4 4
5 5 Overview
6 6 ========
7 7
8 8 nbconvert provides command line utilities to convert to and from IPython
9 9 notebooks and standard formats:
10 10
11 11 - ReST
12 12 - Markdown
13 13 - HTML
14 14 - PDF
15 15 - Python script
16 16
17 As these tools mature, these utilities will be merged into IPython
17 As these tools mature, these utilities will be merged into IPython.
18 18
19 19 Requirements
20 20 ============
21 21
22 22 The latest development version of doctest is required. This can be installed
23 23 via ::
24 24
25 25 $ curl http://docutils.svn.sourceforge.net/viewvc/docutils/trunk/docutils/?view=tar > docutils.gz
26 26 $ pip install -U docutils.gz
27 27
28 28 Nbconvert also needs the `pandoc multiformat converter
29 29 <http://johnmacfarlane.net/pandoc>`_ to do the actual text conversions. Pandoc
30 30 is included in most linux distributions package managers, and the author's
31 31 website contains links to Mac OS X and Windows installers.
32 32
33 33 For conversion to HTML, pygments is also required
34 34 ::
35 35
36 36 $ pip install pygments
37 37
38 38
39 39
40 40 Running Tests
41 41 =============
42 42 ::
43 43
44 44 $ pip install nose
45 45 $ nosetests
46
47
48 Using nbconvert
49 ===============
50
51 You will need to either put the source repository in your ``$PATH`` or symlink
52 the ``nbconvert.py`` script, as well as the ``css`` and ``js`` subdirectories
53 to a directory in your ``$PATH``. Once this is done, you can call it as::
54
55 nbconvert -f <FORMAT> notebook.ipynb
56
57 Use ``nbconvert -h`` for up to date help on the available formats.
General Comments 0
You need to be logged in to leave comments. Login now