阅读文档只导入链接而不是其中的内容
Read the docs only import links and not the contents in it
我对阅读文档还很陌生。我的文档文件夹 docs
github 在我的本地机器上使用 Sphinx 创建的 repo。我尝试 link 文档 阅读文档 。
我从 repo 的设置中添加了阅读文档服务。
从阅读文档 网站我导入了项目。
但是,read the docs 中的文档仅显示 index.html
文件的首页。当我单击任何 link 时,所有内容都是空的。但是,在我的本地计算机中,所有 link 都是文本。
我的 github 回购是这样的:github repo
我的 ReadTheDocs link 是:readthedocs docs
文件结构
- 文档
- html
- 第一
** conf.py
- 来源
- 生成文件
- 源码
index.html
的主页
在我的机器中,当我第一次点击时link它有内容
在 readthedocs 网站上,当我第一次点击时 link 它是空的
请注意,github 网站和我的本地计算机中的整个回购都是相同的。
github电脑里的所有文件都上传了,但是还是readthedocs还是找不到文档
问题:如何在 ReadTheDocs 中显示 links 的内容?
我做错了什么?
有没有办法解决这个问题,或者 RTD 只显示首页?
简单测试:
我们可以下载 repo (5Mb) 和 运行 index.html,其中显示了 a0_interpolate_flux link 中的内容,但是如果我们在上面给出的 readthedocs 中单击相同的 link不显示任何文档字符串内容。
更新
我在谷歌上搜索了很多,也尝试阅读文档网站,但无济于事。我想知道同一个 HTML 页面在本地计算机和 readthedocs webhost 中的打开方式有何不同?
一些相关的 link 如下:
您需要告诉 RTD 安装您的软件包。请参阅 RTD 常见问题解答 My project isn’t building with autodoc。
如果您查看 RTD build history,并展开第三个栏,您将看到导入错误。
修复它:
- 配置 RTD 管理员使用虚拟环境并使用
requirements.txt
文件安装您的包。
- 创建一个
requirements.txt
文件并将其推送到您的存储库,指定您的项目要求,本身包括在内。
我对阅读文档还很陌生。我的文档文件夹 docs github 在我的本地机器上使用 Sphinx 创建的 repo。我尝试 link 文档 阅读文档 。
我从 repo 的设置中添加了阅读文档服务。
从阅读文档 网站我导入了项目。
但是,read the docs 中的文档仅显示 index.html
文件的首页。当我单击任何 link 时,所有内容都是空的。但是,在我的本地计算机中,所有 link 都是文本。
我的 github 回购是这样的:github repo
我的 ReadTheDocs link 是:readthedocs docs
文件结构
- 文档
- html
- 第一
** conf.py - 来源
- 生成文件
- 源码
index.html
的主页在我的机器中,当我第一次点击时link它有内容
在 readthedocs 网站上,当我第一次点击时 link 它是空的
请注意,github 网站和我的本地计算机中的整个回购都是相同的。
github电脑里的所有文件都上传了,但是还是readthedocs还是找不到文档
问题:如何在 ReadTheDocs 中显示 links 的内容?
我做错了什么?
有没有办法解决这个问题,或者 RTD 只显示首页?
简单测试:
我们可以下载 repo (5Mb) 和 运行 index.html,其中显示了 a0_interpolate_flux link 中的内容,但是如果我们在上面给出的 readthedocs 中单击相同的 link不显示任何文档字符串内容。
更新
我在谷歌上搜索了很多,也尝试阅读文档网站,但无济于事。我想知道同一个 HTML 页面在本地计算机和 readthedocs webhost 中的打开方式有何不同?
一些相关的 link 如下:
您需要告诉 RTD 安装您的软件包。请参阅 RTD 常见问题解答 My project isn’t building with autodoc。
如果您查看 RTD build history,并展开第三个栏,您将看到导入错误。
修复它:
- 配置 RTD 管理员使用虚拟环境并使用
requirements.txt
文件安装您的包。 - 创建一个
requirements.txt
文件并将其推送到您的存储库,指定您的项目要求,本身包括在内。