在獅身人面像文件中嵌入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上述事情之後，你做

運行獅身人面像！