##// END OF EJS Templates
upstream » ipython
RSS

Clone from https://github.com/ipython/ipython.git

Update markdown requirement.
Fernando Perez -
Show More
Show file before | Show file after | Hide comments
@@ -1,57 +1,62 b''
1 ================================================================
1 ================================================================
2 nbconvert: conversion utilities for the IPython notebook format
2 nbconvert: conversion utilities for the IPython notebook format
3 ================================================================
3 ================================================================
4
4
5 Overview
5 Overview
6 ========
6 ========
7
7
8 nbconvert provides command line utilities to convert to and from IPython
8 nbconvert provides command line utilities to convert to and from IPython
9 notebooks and standard formats:
9 notebooks and standard formats:
10
10
11 - ReST
11 - ReST
12 - Markdown
12 - Markdown
13 - HTML
13 - HTML
14 - PDF
14 - PDF
15 - Python script
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 Requirements
19 Requirements
20 ============
20 ============
21
21
22 The latest development version of doctest is required. This can be installed
22 You will need the `python markdown module
23 <http://pypi.python.org/pypi/Markdown>`_ ::
24
25 $ pip install markdown
26
27 as well as the latest development version of docutils. This can be installed
23 via ::
28 via ::
24
29
25 $ curl http://docutils.svn.sourceforge.net/viewvc/docutils/trunk/docutils/?view=tar > docutils.tgz
30 $ curl http://docutils.svn.sourceforge.net/viewvc/docutils/trunk/docutils/?view=tar > docutils.tgz
26 $ pip install -U docutils.tgz
31 $ pip install -U docutils.tgz
27
32
28 Nbconvert also needs the `pandoc multiformat converter
33 Nbconvert also needs the `pandoc multiformat converter
29 <http://johnmacfarlane.net/pandoc>`_ to do the actual text conversions. Pandoc
34 <http://johnmacfarlane.net/pandoc>`_ to do the actual text conversions. Pandoc
30 is included in most linux distributions package managers, and the author's
35 is included in most linux distributions package managers, and the author's
31 website contains links to Mac OS X and Windows installers.
36 website contains links to Mac OS X and Windows installers.
32
37
33 For conversion to HTML, pygments is also required
38 For conversion to HTML, pygments is also required
34 ::
39 ::
35
40
36 $ pip install pygments
41 $ pip install pygments
37
42
38
43
39
44
40 Running Tests
45 Running Tests
41 =============
46 =============
42 ::
47 ::
43
48
44 $ pip install nose
49 $ pip install nose
45 $ nosetests
50 $ nosetests
46
51
47
52
48 Using nbconvert
53 Using nbconvert
49 ===============
54 ===============
50
55
51 You will need to either put the source repository in your ``$PATH`` or symlink
56 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
57 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::
58 to a directory in your ``$PATH``. Once this is done, you can call it as::
54
59
55 nbconvert -f <FORMAT> notebook.ipynb
60 nbconvert -f <FORMAT> notebook.ipynb
56
61
57 Use ``nbconvert -h`` for up to date help on the available formats.
62 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