在斯芬克斯文档中嵌入ipython笔记本

Question

我正在为我自己的项目编写API文档。 我发现这个很酷的documentation（yt项目）直接使用ipython笔记本来举例。当我查看他们在bitbucket上的文档回购时，一个相关的rst似乎非常简单：

.. notebook:: An_example_notebook.ipynb

但是，当然，这对我没用。我不确定“笔记本”是不是一个固有的块类型。也许“笔记本”块需要一个外部包。事实上，当我在斯芬克斯的文档中搜索“笔记本”时，没有得到任何结果。在

如果我可以直接用我的笔记本来做例子的话，我会更容易地使用它。 但我不知道怎么才能做到。在

Answer 1

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

要安装nbsphinx：

pip install nbsphinx  user

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

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

在完成上述操作之后，请遵循这个Link

快跑斯芬克斯！在