Question

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

.. notebook:: An_example_notebook.ipynb

但是，当然，它对我没用。我不确定＆＃34;笔记本电脑＆＃34;是一种固有的块类型。也许＆＃39;笔记本＆＃39;块需要外部包。实际上，当我搜索＆＃34; notebook＆＃34;在sphinx文档中。

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

Answer 1

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

安装nbsphinx：

pip install nbsphinx --user

修改您的conf.py并将'nbsphinx'添加到扩展程序。

修改您的index.rst，并将*.ipynb个文件的名称添加到toctree。

完成上述操作后，请按照Link进行操作

运行Sphinx！