使用ReadTheDocs托管使用Jupyter创建的Sphinx文档 [英] Using ReadTheDocs to host Sphinx Docs created with Jupyter
问题描述
我仍然无法使用github存储库以及使用sphinx和readthedocs主题渲染的Jupyter笔记本进行ReadTheDocs构建.我可以在本地渲染这些图像,但是当我尝试使用RTD时,会收到以下失败消息:
我尝试将nbsphinx.py文件放入存储库中,但仍然失败.链接到RTD在这里:
https://readthedocs.org/projects/calculus-notes/ >
Github仓库在这里:
https://github.com/jfkoehler/calc_docs
RTD需要安装nbsphinx
.要告诉RTD安装软件包,您必须:
- 来自 RTD常见问题解答,我的项目没有使用autodoc构建:
在项目的管理"页面中启用virtualenv功能,该功能会将您的项目安装到virtualenv中,并允许您为项目指定
requirements.txt
文件. - 在存储库中创建
requirements.txt
并将nbsphinx
添加到其内容中.参见 https://github.com/spatialaudio/nbsphinx /blob/0.2.14/doc/requirements.txt#L2
在提交并将项目2推送到存储库后,RTD应该安装nbsphinx
并能够成功构建文档,或者如果存在一个文档,则至少继续进行下一个失败.
I continue to have failed builds with ReadTheDocs using a github repository with Jupyter notebooks rendered using sphinx and the readthedocs theme. I am able to render these locally, however when I try with RTD, I get the following fail message:
I tried placing the nbsphinx.py file in the repository but things still fail. Link to RTD is here:
https://readthedocs.org/projects/calculus-notes/
Github repo is here:
https://github.com/jfkoehler/calc_docs
RTD needs to install nbsphinx
. To tell RTD to install packages, you must:
- From RTD FAQ, My project isn’t building with autodoc:
enable the virtualenv feature in the Admin page of your project, which will install your project into a virtualenv, and allow you to specify a
requirements.txt
file for your project. - Create
requirements.txt
in your repo and addnbsphinx
to its contents. See https://github.com/spatialaudio/nbsphinx/blob/0.2.14/doc/requirements.txt#L2
After you commit and push item 2 to your repo, then RTD should install nbsphinx
and be able to build your docs successfully, or at least proceed to the next failure if there is one.
这篇关于使用ReadTheDocs托管使用Jupyter创建的Sphinx文档的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!