将ipython笔记本嵌入sphinx文档

Question

我正在为自己的项目编写API文档。而且我发现这个很酷的文档（yt项目）直接使用ipython notebook给出了示例。当我查看他们关于bitbucket的文档存储库时，一个相关的rst看起来很简单：

.. notebook:: An_example_notebook.ipynb

但是，当然，它对我不起作用。我不确定“笔记本”是否为固有块类型。也许“笔记本”块需要外部包装。实际上，当我在sphinx文档中搜索“ notebook”时，结果为零。

如果我可以直接使用笔记本（不进行转换）给出示例，那将使生活更加轻松。但是我不知道该如何实现。

Answer 1

nbsphinx是一个 Sphinx 扩展，为*.ipynb文件提供源解析器。

安装 nbsphinx：

pip install nbsphinx --user

编辑您的conf.py并添加'nbsphinx'到扩展程序。

编辑您index.rst的*.ipynb文件并将其添加到toctree.

在您执行上述操作后点击此链接

运行斯芬克斯！