RTD:阅读仅限文档的导入链接,而不是其中的内容

时间:2017-07-26 00:23:17

标签: python documentation python-sphinx read-the-docs

我很擅长阅读文档。我的文档文件夹 docs 在我的本地机器上使用sphinx创建的github repo。我试图将文档链接到readthedocs。

从repo的设置我添加了阅读docs服务。

从阅读文档网站我导入了项目。

但是,阅读文档的文档只显示了index.html文件的首页。当我点击任何链接时都是空的。但是,在我的本地计算机中,所有链接都是文本。

我的github回购是:github repo

我的readthedocs链接是:readthedocs docs

文件结构

  • 文档
    • HTML
    • RST
      ** conf.py
    • 来源
    • Makefile
  • SRC

index.html的主页

The main page of index.html

在我的机器中,当我点击第一个链接时,它有内容

enter image description here

在readthedocs网站上点击第一个链接时,它是EMPTEY enter image description here

请注意,整个仓库在github网站和本地机器上都是一样的 计算机中的所有文件都是在github上传的,但是readthedocs只能找到文档。

问题:我们如何在ReadTheDocs中显示链接的内容?

我做错了什么? 有没有办法解决问题或RTD只显示首页?

简单测试:
 我们可以下载repo(5Mb)并运行index.html,它显示了a0_interpolate_flux链接中的内容,但如果我们点击上面给出的readthedocs中的相同链接,它就不会显示任何文档字符串内容。

更新
我google了很多,也尝试阅读文档网站,但无济于事。我想知道同一个html页面在本地机器和readthedocs webhost中的打开方式有何不同?

以下是一些相关链接:

[1]: https://stackoverflow.com/questions/41029181/read-the-docs-not-updating-with-new-files?rq=1

1 个答案:

答案 0 :(得分:2)

您需要告诉RTD安装您的包裹。请参阅RTD常见问题My project isn’t building with autodoc

如果您查看RTD build history,并展开第三个栏,您将看到导入错误。

修复它:

  1. 使用requirements.txt文件将RTD管理员配置为使用虚拟环境并安装软件包。
  2. 创建一个requirements.txt文件并将其推送到您的仓库,指定您自己的项目要求。