只阅读文档中的导入链接,而不阅读其中的内容

2022-04-20 00:00:00 python python-sphinx read-the-docs

问题描述

我对阅读这些文档非常陌生。我的文件夹中有一个文档文件夹Docs 在我的本地机器上使用Sphinx创建的GitHub repo。我尝试将文档链接到阅读文档。

我从Repo的设置添加了Read the Docs服务。

从Read the Docs网站导入项目。

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

我的GitHub回购如下:github repo

我的ReadTheDocs链接是:readthedocs docs

文件结构

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

index.html主页

在我的计算机中,当我单击第一个链接时,它有内容

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

请注意,GitHub网站和我的本地计算机中的整个回购都是相同的。
计算机中的所有文件都上传到GitHub,但ReadtheDocs仍然无法找到文档。

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

我做错了什么?
是否有解决问题的方法或RTD仅显示首页?

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

更新
我用谷歌搜索了很多次,也试着阅读了医生的网站,但都没有用。我想知道在本地计算机和ReadtheDocs网络主机上打开相同的HTML页面有什么不同?

以下是一些相关链接:

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

rtd

您需要告诉推荐答案安装您的程序包。请参阅RTD常见问题My project isn’t building with autodoc。

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

修复:

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

相关文章