ipythonノートブックをスフィンクス文書に埋め込みました

Question

私自身のプロジェクトのためのAPI文書を書いています。 そして私はこの涼しいことがわかりましたdocumentation（ytプロジェクト）は、例を与えるためにipythonノートブックを直接使用しています。しかし、もちろん、それは私のために動作しませんでした

.. notebook:: An_example_notebook.ipynb 

：私はビットバケット上の文書レポに見えたとき、1つの関連RSTはと非常に簡単に思えました。 "ノートブック"が本質的なブロックタイプであるかどうかはわかりません。 「ノートブック」ブロックに外部パッケージが必要なのかもしれません。実際には、私はsphinxのドキュメントで「ノートブック」を検索したときにゼロの結果を得ました。

ノートブックを直接（変換せずに）使用して例を挙げることができれば、それはもっと簡単になります。 しかし、私はそれを達成する方法を理解できません。

Answer 1

nbsphinxは、*.ipynbファイルのソースパーサーを提供するSphinx拡張です。

pip install nbsphinx --user 

があなたのconf.pyを編集し、拡張子に'nbsphinx'を追加します。nbsphinxをインストールする

。

index.rstを編集し、に*.ipynbファイルの名前を追加してください。

あなたは

実行スフィンクスを行う以上のことの後にこのLinkに従ってください！