Skip to content

Commit

Permalink
Merge pull request #82 from takluyver/docs-install
Browse files Browse the repository at this point in the history
Add install docs
  • Loading branch information
minrk committed Aug 6, 2015
2 parents e802c46 + 57ceced commit cfa5eaa
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 3 deletions.
4 changes: 1 addition & 3 deletions docs/source/api/preprocessors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,6 @@ Specialized preprocessors

.. autoclass:: ExtractOutputPreprocessor

.. autoclass:: RevealHelpPreprocessor

.. autoclass:: LatexPreprocessor

.. autoclass:: CSSHTMLHeaderPreprocessor
Expand All @@ -37,4 +35,4 @@ Specialized preprocessors

.. autoclass:: ExecutePreprocessor

.. autofunction:: coalesce_streams
.. autofunction:: coalesce_streams
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Contents:
.. toctree::
:maxdepth: 2

install
usage
config_options
latex_citations
Expand Down
29 changes: 29 additions & 0 deletions docs/source/install.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
Installing nbconvert
====================

.. seealso::

`Installing Jupyter <http://jupyter.readthedocs.org/en/latest/install.html>`__
Nbconvert is part of the Jupyter ecosystem.

Nbconvert is packaged for both pip and conda, so you can install it with::

pip install nbconvert
# OR
conda install nbconvert

If you're new to Python, we recommend installing `Anaconda <http://continuum.io/downloads#py34>`__,
a Python distribution which includes nbconvert and the other Jupyter components.

Pandoc
------

For converting markdown to formats other than HTML, nbconvert uses Pandoc_
(1.12.1 or later).

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 <http://johnmacfarlane.net/pandoc/installing.html>`_.

0 comments on commit cfa5eaa

Please sign in to comment.