diff --git a/docs/source/install/install.txt b/docs/source/install/install.txt index 19f50fe..a49da21 100644 --- a/docs/source/install/install.txt +++ b/docs/source/install/install.txt @@ -41,14 +41,15 @@ optional dependencies: .. code-block:: bash - $ easy_install ipython[zmq,qtconsole,notebook,test] + $ easy_install ipython[all] This will get: - jinja2, needed for the notebook +- sphinx, needed for nbconvert - pyzmq, needed for IPython's parallel computing features, qt console and notebook. -- pygments, used by the Qt console for syntax highlighting. +- pygments, used by nbconvert and the Qt console for syntax highlighting. - tornado, needed by the web-based notebook - nose, used by the test suite. @@ -275,7 +276,7 @@ and OSX clients will use the shell ssh command, but on Windows, we also support tunneling with paramiko_. Dependencies for IPython.kernel.zmq -============================ +=================================== pyzmq ----- @@ -396,11 +397,29 @@ There are some early reports that the Notebook works on Internet Explorer 10, bu expect there will be some CSS issues related to the flexible box model. +Dependencies for nbconvert (converting notebooks to various formats) +==================================================================== + +pandoc +------ + +The most important dependency of nbconvert is Pandoc_, a document format translation program. +This is not a Python package, so it cannot be expressed as a regular IPython dependency with setuptools. + +To install pandoc on Linux, you can generally use your package manager:: + + sudo apt-get install pandoc + +On other platforms, you can get pandoc from `their website `_. + + .. _ZeroMQ: http://www.zeromq.org .. _PyZMQ: https://github.com/zeromq/pyzmq .. _paramiko: https://github.com/robey/paramiko .. _pygments: http://pygments.org .. _pexpect: http://www.noah.org/wiki/Pexpect .. _Jinja: http://jinja.pocoo.org +.. _Sphinx: http://sphinx-doc.org +.. _pandoc: http://johnmacfarlane.net/pandoc .. _Tornado: http://www.tornadoweb.org .. _MathJax: http://www.mathjax.org diff --git a/setup.py b/setup.py index 8f5535b..48e2b00 100755 --- a/setup.py +++ b/setup.py @@ -280,6 +280,14 @@ if 'setuptools' in sys.modules: notebook = ['tornado>=2.0', 'pyzmq>=2.1.11', 'jinja2'], nbconvert = ['pygments', 'jinja2', 'Sphinx>=0.3'] ) + everything = set() + for deps in setup_args['extras_require'].values(): + if not isinstance(deps, list): + deps = [deps] + for dep in deps: + everything.add(dep) + setup_args['extras_require']['all'] = everything + requires = setup_args.setdefault('install_requires', []) setupext.display_status = False if not setupext.check_for_readline():