使用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并能够成功地建立自己的文档，或者至少进入下一个失败，如果有一个。