问题标签 [read-the-docs]

Read The Docs 一直告诉我，我的文档构建失败。错误日志显示“构建环境创建失败”。我试图擦除我的构建环境，但文档仍然无法构建。

这是页面的图像：

构建环境创建失败

我已阅读常见问题解答，但其中不包含有关我的问题的任何信息。我怎样才能解决这个问题？

我的程序的文档主要是用Sphinx编写的，但它还包括两个自定义 HTML 页面：

• 程序生成的示例报告；
• 关于程序某些功能的扩展参考。

这两个 HTML 文件是由程序本身生成的，而不是由 Sphinx 生成的。

我想在Read the Docs上托管我的文档，我可以非常方便地构建和托管两个自定义页面，版本化，以及 Sphinx 文档。

我的程序已经安装在 RtD 构建环境中，因为我启用了安装项目选项。而且由于 RtD 文档提到编写自己的 builder，我认为可以从那里调用我的程序并将 HTML 内容转储到特定位置。

所以我真的有两个问题：

1. 这是对 Read the Docs 的适当使用吗？我想它不是为托管任意网页而设计的——但话说回来，这些文件不是任意的，它们是文档的重要组成部分。

2. 我将如何实施它？我很难理解RtD API：这个“构建器”是否与Sphinx 构建器有任何关系？如何将它连接到 RtD？也许某处有一个例子？

我正在尝试根据此链接中给出的说明在 python3 虚拟环境中的本地系统（Ubuntu 14.04）中安装 readthedocs

当我运行pip3 install -r requirements.txt时，出现 Distutils2 错误。我删除了该依赖项，因为不再支持 distutils2 并且假设 setuptools 就足够了。

运行此命令 python manage.py migrate 给出以下错误：

我从上面的堆栈跟踪中了解到代码在 python2 中，因此 print 语句在 python3 中是不同的。

这是否意味着我必须在 python2 virtualenv 中安装 readthedocs ？

我们不能在 readthedocs 内部服务器中托管 python3 项目的文档吗？

我正在使用sphinx和RST将一些技术文档生成为 HTML，并且在获取本地 PDF 参考以用作超链接时遇到问题。我见过人们:download:用来链接到本地​​ PDF，但我将 PDF 嵌入到/docs目录中以供参考。我不喜欢:download:，因为它不会在浏览器中显示 PDF 内联，这需要代表用户执行额外的步骤才能使用。

sphinx-build -b html不会复制任何文件，除非它们在config.pyhookhtml_static_path或html_extra_path- 中指定，即使这样它们也会被拖放到root目录或_static文件夹中。

是否有建议的方法在 sphinx 中嵌入链接的二进制文件，或者这是一种不好的做法？通常，这些链接是指向不在其他任何地方托管的幻灯片或设计图表。

链接 PDF 的示例 RST

我有一个由 ReadTheDocs 呈现和托管的文档。它仍然显示 Git 提交哈希而不是“上次更新时间”行，而我的本地 HTML 文档显示今天的日期。

本地版本：

网络版：

在docs/conf.py文件中，我配置html_last_updated_fmt为非None值 -> 空字符串。
来源：https ://github.com/VLSI-EDA/PoC/blob/master/docs/conf.py#L173-L176

为什么 ReadTheDocs 会忽略我的设置？如何获取最后更新日期？

我一直在编写个人“操作方法”指南，在进行过程中记录并记录我的研究。

我现在有一个几乎太长的代码块，当我自己遇到这种长度的代码时，总是令人沮丧地试图突出显示该块而不突出显示整个页面，或者不够。

所以，我的问题是，对于rst(reStructuredText).. code-block::的，是否有附加组件或添加copy按钮的方法，用于自动突出显示或自动将文本添加到用户剪贴板？或者这将是我必须包含在构建中并在代码块中引用它的更多 html 文字类型的代码？如果是这样，那么类似的东西会是什么样子？

我正在使用sphinx-autodoc-annotation读取 Python 代码中的函数注释，并使用它来生成适当的预期参数类型和返回类型。它在我的本地机器上运行良好，但我pip install sphinx-autodoc-annotation当然必须这样做。

我正在尝试使用Read the Docs生成相同的文档，但它给了我一个错误：

是否可以将 Read the Docs 配置为使用 sphinx-autodoc-annotation，如果可以，我该如何使其工作？

我正在尝试让 Read the Docs 生成py-modindex.html文件。对这个问题的研究引导我进行以下设置：

• setup.py在项目目录中有以下内容，这是开始工作所需的最低限度，pytest并且自从我的项目的那部分工作以来没有改变：

  /li>

• docs/requirements.txt包含一行：

  /li>

• 阅读文档存储库 URL 指向我的GitHub存储库。

• 检查“使用 setup.py install 在 vi​​rtualenv 中安装项目”的 RtD 设置。
• “需求文件”的 RtD 设置指向docs/requirements.txt.

“模块索引”链接包含在 中index.html，但该py-modindex.html文件丢失。

我的理解是，通过上面的 virtualenv 设置，RtD 将使用该setup.py文件来安装项目，以便 Sphinx 可以读取 Python 文档字符串中的文档。我正在使用函数注释，并希望sphyinx-autodoc-annotation在创建构建的文档文件时使用它们。make html当我在docs文件夹中运行时，所有这些都在我的本地机器上运行得非常好。现在我正试图让它在 Read the Docs 上工作。

注意：这是一个练习，我在将其应用到我的实际项目之前要了解所有内容，多边形项目是一个占位符。

近一年来，我有一个导入并在 ReadTheDocs 上构建的项目。在很长一段时间没有更新之后，我决定是时候重建文档了。但是，构建现在失败，并出现以下信息不是很丰富的错误：

错误：无法导入项目：无法从“ https://subversion.xray.aps.anl.gov/pyGSAS/trunk/”（svn checkout）获取代码：1

我找到了“擦除”选项，并试图看看这是否有帮助，但也没有运气。

我愿意相信与我们的存储库相关的问题是问题（尽管我没有收到任何无法访问的人的消息），但在我开始敲响那个笼子的栏杆之前，我需要更具体和明确的东西。

欢迎提出建议！

我尝试在我的 Win10 上安装 Read the Docs 的本地实例

当我遵循此文档时： http:
//docs.readthedocs.io/en/latest/install.html

并输入：

我收到此错误：

有人知道这个错误吗？

我的点子版本：8.1.2；
蟒蛇：3.5