스핑크스 문서에 ipython 노트 포함

Question

내 프로젝트 용 API 문서를 작성 중입니다. 그리고이 멋진 것 documentation (yt 프로젝트) 예제를 제공하기 위해 ipython 노트북을 직접 사용합니다. 그러나, 물론, 나를 위해 작동하지 않았다

.. notebook:: An_example_notebook.ipynb 

: 나는의 bitbucket에 자신의 문서의 repo로 보았을 때, 하나의 관련 첫 번째는 다음과 같이 매우 간단 보였다. 나는 "노트북"이 본질적인 블록 유형인지 아닌지 잘 모르겠습니다. 어쩌면 '노트북'블록에 외부 패키지가 필요할 수도 있습니다. 실제로, 나는 스핑크스 문서에서 "수첩"을 검색했을 때 제로 결과를 얻었습니다.

노트북을 직접 (변환하지 않고) 사용하여 예제를 제공하면 훨씬 쉽게 사용할 수 있습니다. 그러나 어떻게 달성 할 수 있는지 알 수 없습니다.

Answer 1

nbsphinx은 *.ipynb 파일에 대한 소스 파서를 제공하는 Sphinx 확장입니다.

pip install nbsphinx --user 

을 편집 conf.py과 확장에 'nbsphinx'을 추가

는 nbsphinx를 설치합니다.

index.rst을 편집하고 에 *.ipynb 파일의 이름을 추가하십시오.

는

실행 스핑크스을 위 일 후이 Link을 따르십시오!