【问题标题】:How to convert ReStructuredText docs to ipython notebooks?如何将 ReStructuredText 文档转换为 ipython 笔记本?
【发布时间】:2014-05-11 23:40:44
【问题描述】:

如今,python 社区中的许多文档都是用 ReStructuredText 编写的。我想将其中一些文档转换为 ipython 笔记本,以便不仅可以阅读文档中的示例,还可以立即与它们进行交互。

如何将 ReStructuredTexts 转换为 ipython 笔记本?有没有办法做到这一点?也许使用 pandoc 作为中间步骤?

我已经阅读了some docs 关于如何将 ipython 笔记本转换为其他甲酸盐的内容,但我有兴趣反过来做,从 rst 到 iptyhon。有什么想法吗?

【问题讨论】:

    标签: python documentation ipython restructuredtext


    【解决方案1】:

    除了sphinxcontrib-jupyter/jupinx,谷歌还发现了rst2ipynb。它似乎使用pandoc。不过我自己还没试过。

    【讨论】:

      【解决方案2】:

      有一个用于 ipynb 的降价包。 notedown 1.0.3。您可以使用 pandoc for rst 到 md 然后 md 到 ipynb。

      【讨论】:

      • 感谢您的建议。我试过了,但它不起作用,因为 pandoc 将 rst >>>'s 变成 \>\>\> 而不是代码块。有什么建议吗?
      • 我在github.com/sympy/sympy/blob/master/doc/src/guide.rst 上运行 pandoc 1.11.1 Linux 并在 doctest 块中获得>>> 而不是\>\>\>。我不确定逃跑者是从哪里来的。即使交互提示仍然存在,代码块也会在 Ipy 中执行。我同意如果它们被剥离会更好看,但我不知道任何现成的解决方案。注意到代码块中的另一个问题。 notedown 正在拆分块,因为空行上没有缩进。事后合并单元格非常容易,但您至少必须进行一些手动编辑。
      【解决方案3】:

      如果您仍在寻找解决方案,我们正在构建一个 Sphinx 扩展,以将一组 RST 文件转换为 Jupyter 笔记本。

      sphinxcontrib-jupyter

      【讨论】:

        猜你喜欢
        • 1970-01-01
        • 2015-05-12
        • 2015-12-10
        • 2013-04-06
        • 1970-01-01
        • 1970-01-01
        • 2016-02-19
        • 1970-01-01
        • 1970-01-01
        相关资源
        最近更新 更多