From 1f04b02c8afff359b345105587ce7d35471f7154 2013-02-21 18:03:53 From: Jonathan Frederic Date: 2013-02-21 18:03:53 Subject: [PATCH] Updated README to reflect package requirements. --- diff --git a/README.rst b/README.rst index d50d78b..dce0256 100644 --- a/README.rst +++ b/README.rst @@ -19,44 +19,14 @@ As these tools mature, these utilities will be merged into IPython. Requirements ============ -You will need the `python markdown module -`_ :: +Sphinx-Latex: - $ pip install markdown - -as well as the latest development version of docutils. This can be installed -via :: - - $ curl http://docutils.svn.sourceforge.net/viewvc/docutils/trunk/docutils/?view=tar > docutils.tgz - $ pip install -U docutils.tgz - -Nbconvert also needs the `pandoc multiformat converter -`_ to do the actual text conversions. Pandoc -is included in most linux distributions package managers, and the author's -website contains links to Mac OS X and Windows installers. - -For conversion to HTML, pygments is also required -:: - - $ pip install pygments - - - + $ #see http://jimmyg.org/blog/2009/sphinx-pdf-generation-with-latex.html + $ sudo apt-get install texlive-full + Running Tests ============= -:: - - $ pip install nose - $ nosetests - Using nbconvert =============== -You will need to either put the source repository in your ``$PATH`` or symlink -the ``nbconvert.py`` script, as well as the ``css`` and ``js`` subdirectories -to a directory in your ``$PATH``. Once this is done, you can call it as:: - - nbconvert -f notebook.ipynb - -Use ``nbconvert -h`` for up to date help on the available formats.