seblabbe / rst-to-ipynb

Convert .rst to .ipynb

rst-to-ipynb

This project converts between a standalone reStructuredText file and a IPython Notebook file.

This is currently achieved by converting to markdown with pandoc and then to IPython notebook using notedown, plus some configuration and tweaks.

Usage

To produce xxx.ipynb from xxx.rst:

python convert.py xxx.rst -o xxx.ipynb

Example

• all.rst
• all.ipynb

TODO:

• Handle Sage's doctests
• Fenced code blocks: fix incompatibility between pandoc output and notedown input.
  Fixed in notedown; see: aaren/notedown#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 aaren/notedown#33