Embed Ipython Notebook in Sphinx Dokument

Question

Ich schreibe das API-Dokument für mein eigenes Projekt. Und ich fand, dass diese coole documentation (Yt-Projekt) ipython Notebook direkt verwendet, um Beispiel zu geben. Als ich in ihre Dokumentation Repo auf bitbucket sah, schien ein relevantes rst ganz einfach:

.. notebook:: An_example_notebook.ipynb 

Aber natürlich ist es nicht für mich arbeiten. Ich bin mir nicht sicher, ob das "Notebook" ein intrinsischer Blocktyp ist oder nicht. Vielleicht benötigt der "Notebook" -Block ein externes Paket. Eigentlich habe ich kein Ergebnis erhalten, als ich in der Sphinx-Dokumentation nach "Notebook" gesucht habe.

Wenn ich meine Notebooks direkt (ohne Konvertierung) verwenden kann, um Beispiele zu geben, wird das Leben viel einfacher. Aber ich kann nicht herausfinden, wie ich das erreichen kann.

Answer 1

nbsphinx ist eine Sphinx-Erweiterung, die einen Quellparser für *.ipynb Dateien bereitstellt.

Installieren nbsphinx:

pip install nbsphinx --user 

Bearbeiten Sie Ihre conf.py und 'nbsphinx' zu Erweiterungen hinzufügen.

Bearbeiten Sie Ihre index.rst und fügen Sie die Namen Ihrer *.ipynb Dateien in die toctree.

Folgen Sie dieser Link nach oben, was Sie

Run Sphinx tun!