在狮身人面像文件中嵌入ipython笔记本

Question

我正在为我自己的项目编写API文档。 而我发现这个很酷的documentation（yt项目）直接使用ipython notebook来举例。当我看着就到位桶的文档回购，一个相关的第一个似乎是很简单的：

.. notebook:: An_example_notebook.ipynb 

但是，当然，它并没有为我工作。我不确定“笔记本”是否是固有的块类型。也许“笔记本”模块需要外部封装。实际上，当我在狮身人面像文档中搜索“笔记本”时，结果为零。

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

Answer 1

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

安装nbsphinx：

pip install nbsphinx --user 

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

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

按照这Link上述事情之后，你做

运行狮身人面像！