Metadata-Version: 1.1
Name: rst2ipynb
Version: 0.2.3
Summary: A reST to Jupyter notebook converter
Home-page: https://github.com/nthiery/rst-to-ipynb
Author: Scott Sievert, Nicolas M. Thiéry
Author-email: nthiery@users.sf.net
License: BSD
Description: rst2ipynb
        =========
        
        This project provides a way to convert standalone
        `reStructuredText <http://docutils.sourceforge.net/rst.html>`_ files
        to `Jupyter notebook <http://jupyter.org/>`_ files.
        
        This is currently achieved by converting to markdown using
        `pandoc <http://pandoc.org>`_ and then to a Jupyter notebook using
        `notedown <https://github.com/aaren/notedown/>`_, plus some
        configuration and tweaks.
        
        Requirements
        ------------
        
        Python 3 (for proper UTF-8 support in notedown), pandoc, notedown
        
        Installation
        ------------
        
        Install `pandoc <http://pandoc.org>`_ and then this module as usual::
        
            git clone https://github.com/nthiery/rst-to-ipynb.git
            cd rst-to-ipynb
            pip3 install .
        
        pip3 will install the other dependencies as needed.
        
        Caveat: the notedown package on pipy (1.5.0, 2015-10-07) is somewhat
        outdated; for better conversion, it is recommended to install the
        latest version from the github repo.
        
        Usage
        -----
        
        To convert a reST file ``xxx.rst`` to a Jupyter notebook ``xxx.ipynb``, run::
        
            rst2ipynb xxx.rst -o xxx.ipynb
        
        Example
        -------
        
        - reST document: `all.rst <tests/all.rst>`_
        - Produced Jupyter notebook: `all.ipynb <http://nbviewer.ipython.org/github/nthiery/rst-to-ipynb/blob/master/tests/all.ipynb>`_
        
        TODO
        ----
        
        - [X] Handle Sage's doctests
        - [X] Fenced code blocks: fix incompatibility between pandoc output and notedown input.
              Fixed in notedown; see: https://github.com/aaren/notedown/issues/29.
        - [ ] Configurability of the default ReST role, in particular to handle maths in Sage's ReST dialect.
              Current status: hardcoded for Sage.
        - [ ] Configurability of custom ReST roles, in particular to handle Sage's custom roles
        - [ ] Proper argument parsing; escape characters, spaces, ... are not
              yet supported
        - [ ] Handle input/output blocks within itemize and other indented constructions
              See https://github.com/aaren/notedown/issues/33
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
