python - 在 sphinx 文档中嵌入 ipython notebook

Question

我正在为自己的项目编写 API 文档。我发现这很酷 documentation (yt项目)直接用ipython notebook来举例。当我查看他们在 bitbucket 上的文档 repo 时，一个相关的 rst 似乎很简单:

.. notebook:: An_example_notebook.ipynb

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

如果我可以直接使用我的笔记本(无需转换)来举例，那将使生活变得更加轻松。但我无法弄清楚如何实现这一目标。

Answer 1

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

安装 nbsphinx:

pip install nbsphinx --user

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

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

关注此 Link在你做了上面的事情之后

运行狮身人面像!