我正在为自己的项目编写API文档。我发现这个酷炫的documentation(yt项目)直接使用ipython笔记本来给出示例。当我查看他们在bitbucket上的文档存储库时,发现一个相关的rst文件非常简单:
当然,这对我没有用。我不确定“notebook”是否是固有的块类型。也许“notebook”块需要外部包。实际上,在sphinx文档中搜索“notebook”时,我得到了零结果。
如果我可以直接使用我的笔记本(而无需转换)来举例说明,那将使生活更加轻松。但我无法弄清楚如何实现这一点。
.. notebook:: An_example_notebook.ipynb
当然,这对我没有用。我不确定“notebook”是否是固有的块类型。也许“notebook”块需要外部包。实际上,在sphinx文档中搜索“notebook”时,我得到了零结果。
如果我可以直接使用我的笔记本(而无需转换)来举例说明,那将使生活更加轻松。但我无法弄清楚如何实现这一点。