2017-07-26 88 views
2

我很新的阅读文档。我有一个文档文件夹docs在我的 github回购在我的本地机器上使用sphinx创建。我试图将文档链接到readthedocs。RTD:阅读文档只有导入链接,而不是其中的内容

从回购的设置我添加了阅读文档服务。

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

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

我的GitHub库是这样的:github repo

我readthedocs链接是:readthedocs docs

文件结构

  • 文档
    • HTML
    • 首先
      ** 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只显示头版?

简单的测试:
我们可以下载它显示a0_interpolate_flux内部链接内容的回购协议(5MB)和运行index.html的,但如果我们点击它上面给出readthedocs相同的链接不显示任何文档字符串内容。

更新
我用Google搜索了很多,也尝试阅读文档的网站,但无济于事。我想知道如何在本地机器和readthedocs虚拟主机打开不同的HTML页面?

一些相关的链接如下:

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

回答

3

你需要告诉RTD安装软件包。请参阅RTD常见问题解答My project isn’t building with autodoc

如果你看看你的RTD build history,扩大第三棒,你会看到导入错误。

要解决这个问题:

  1. 配置RTD管理员可以使用虚拟环境和安装包,使用requirements.txt文件。
  2. 创建requirements.txt文件,并将其推送到您的回购协议,指定项目的要求,本身包括在内。
+0

谢谢你,但是,我看着构建历史,它说构建绿色亮点建成后,我看不出有任何错误。 –

+0

我会遵循readthedocs的管理选项卡中的说明,将更新的问题,如果我仍然得到错误,谢谢你史蒂夫。 –

+0

@BhishanPoudel作为,我说过在你需要*展开第三栏*来查看导入错误。构建可以完成*有错误*。要解决这个问题,你需要在我的答案中做* 1和2。 –