使用ReadTheDocs託管使用Jupyter創建的Sphinx Docs

Question

我繼續使用ReadTheDocs使用帶有使用sphinx和readthedocs主題呈現的Jupyter筆記本的github存儲庫構建失敗。我能夠在本地渲染這些，但是當我嘗試用RTD，我得到以下失敗消息：

我試着放置nbsphinx.py服務器中的資源，但事情仍然會失敗。鏈接到RTD是在這裏：

https://readthedocs.org/projects/calculus-notes/

Github上回購是在這裏：

https://github.com/jfkoehler/calc_docs

Answer 1

RTD需要安裝nbsphinx。告訴RTD安裝軟件包，你必須：

1. 從RTD FAQ, My project isn’t building with autodoc：

   能夠在你的項目，該項目將安裝到您的項目一個virtualenv中的管理頁面中的virtualenv功能，並允許您指定一個requirements.txt文件爲您的項目。

2. 在您的回購中創建requirements.txt並將nbsphinx添加到其內容中。見https://github.com/spatialaudio/nbsphinx/blob/0.2.14/doc/requirements.txt#L2

你提交之後，推動項目2到您的回購，那麼RTD應該安裝nbsphinx並能夠成功地建立自己的文檔，或者至少進入下一個失敗，如果有一個。