【问题标题】:Read the docs only import links and not the contents in it阅读文档仅导入链接而不是其中的内容
【发布时间】:2017-07-26 00:23:17
【问题描述】:

我对阅读文档很陌生。我有一个文档文件夹 docs 在我的 在我的本地机器上使用 Sphinx 创建的 github 存储库。我尝试将文档链接到 Read the Docs

从 repo 的设置中,我添加了 read the docs 服务。

Read the Docs 网站我导入了项目。

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

我的 github 仓库是这样的:github repo

我的 ReadTheDocs 链接是:readthedocs docs

文件结构

  • 文档
    • html
    • 第一
      ** conf.py
    • 来源
    • 生成文件
  • 源代码

index.html的主页

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

在 readthedocs 网站中,当我点击第一个链接时,它是空的

请注意,github 网站和我的本地计算机中的整个 repo 是相同的。
电脑里的所有文件都上传到github上,但是还是readthedocs就找不到文档了。

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

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

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

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

部分相关链接如下:

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

【问题讨论】:

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


    【解决方案1】:

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

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

    修复它:

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

    【讨论】:

    • 谢谢,但是,我查看了构建历史,它说构建完成并带有绿色突出显示,我看不到任何错误。
    • 我将按照 readthedocs 管理选项卡中的说明进行操作,如果仍然出现错误,我将更新问题,谢谢史蒂夫。
    • @BhishanPoudel as,我之前说过你需要展开第三条才能看到导入错误。构建可以完成有错误。要修复它,您需要在我的回答中执行 both 1 和 2。
    • 很抱歉更新,但是,无论我尝试 RTD 失败,我上传 requirements.txt 和所有必需的库,仍然失败。
    • 为什么会失败?正如我之前提到的,当您展开第三个栏时,错误消息是什么?
    猜你喜欢
    • 1970-01-01
    • 2020-09-22
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2022-06-18
    • 1970-01-01
    • 2021-07-22
    • 2017-05-09
    相关资源
    最近更新 更多