##// END OF EJS Templates
Updated README to reflect package requirements.
Jonathan Frederic -
Show More
@@ -19,44 +19,14 b' As these tools mature, these utilities will be merged into IPython.'
19 Requirements
19 Requirements
20 ============
20 ============
21
21
22 You will need the `python markdown module
22 Sphinx-Latex:
23 <http://pypi.python.org/pypi/Markdown>`_ ::
24
23
25 $ pip install markdown
24 $ #see http://jimmyg.org/blog/2009/sphinx-pdf-generation-with-latex.html
26
25 $ sudo apt-get install texlive-full
27 as well as the latest development version of docutils. This can be installed
26
28 via ::
29
30 $ curl http://docutils.svn.sourceforge.net/viewvc/docutils/trunk/docutils/?view=tar > docutils.tgz
31 $ pip install -U docutils.tgz
32
33 Nbconvert also needs the `pandoc multiformat converter
34 <http://johnmacfarlane.net/pandoc>`_ to do the actual text conversions. Pandoc
35 is included in most linux distributions package managers, and the author's
36 website contains links to Mac OS X and Windows installers.
37
38 For conversion to HTML, pygments is also required
39 ::
40
41 $ pip install pygments
42
43
44
45 Running Tests
27 Running Tests
46 =============
28 =============
47 ::
48
49 $ pip install nose
50 $ nosetests
51
52
29
53 Using nbconvert
30 Using nbconvert
54 ===============
31 ===============
55
32
56 You will need to either put the source repository in your ``$PATH`` or symlink
57 the ``nbconvert.py`` script, as well as the ``css`` and ``js`` subdirectories
58 to a directory in your ``$PATH``. Once this is done, you can call it as::
59
60 nbconvert -f <FORMAT> notebook.ipynb
61
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