问题标签 [read-the-docs]

我正在尝试使用以下方法在 reStructuredText 文档中嵌入一个交互式图形，该图形保存为 html 文件iframe：

html 文件与我的文件位于同一目录中.rst，但图表未显示，并且出现file could not be found错误。

但是，如果我将外部 html 文件粘贴到_build/html目录中，则图形显示正常。如何正确嵌入此 html 文件，以便在我的时候自动嵌入图形make html？

我想要的东西的工作示例。

我从全新安装 readthedocs.org 开始：

http://read-the-docs.readthedocs.org/en/latest/install.html

接下来，我在管理面板中添加了 SocialApp GitHub，然后将我的超级用户连接到该 GitHub 帐户。

然后我去了 github 并分叉了 readthedocs 存储库。

https://github.com/Drachenfels/Test-Fork

接下来我点击了导入项目。任务永远不会结束，但是当我刷新页面时，repos 就在那里。

我选择了分叉存储库 Test-Fork 并单击了构建。

任务永远不会完成，当我刷新或启动另一个任务时，它们会卡在“已触发”状态。没有错误，什么都没有。

更重要的是，我是 readthedocs 的默认配置。

我在后台运行以下进程：

在这一点上我有什么想念的吗？

在我看来，尽管 celery 处于活动状态并且正在运行的任务从未启动或终止，也不会出错。

我们正在转换一个相当大的文档以在 ReadTheDocs 上托管。我们对 Markdown 表格语法所支持的简单表示并不满意，因此我们将表格编码为 HTML。在 HTML 查看器中非常好（例如， http: //manual.cytoscape.org/en/latest/Command_Line_Arguments.html的结尾）。

在 ReadTheDocs 生成的 PDF 版本中，我们的每个表格都完全丢失（参见https://media.readthedocs.org/pdf/cytoscape-working-copy/latest/cytoscape-working-copy.pdf上的第 9 页）。

我们将表格编码为 HTML 是否犯了错误？我们是否可以采取不同的方式并在 HTML和PDF 中获得漂亮的表格？

任何意见将是有益的 ...

谢谢！

我正在尝试从 GitHub Enterprise 存储库创建 RTD 页面。它是公开的，您可以在这里查看。但是，在 RTD 中导入我的存储库时出现错误：

此存储库没有设置有效的 webhook。这意味着它不会在提交到存储库时重建。你可以重新同步你的 webhook 来解​​决这个问题

我正在使用import manually导入此存储库的选项，因为我无法将我的企业 github 帐户连接到 readthedocs 帐户。

我已经readthedocs service为这个 repo 添加了如下所示：

我还在最近交付下获得了一些带有警告的 json 数据Invalid HTTP Response 400：

要求：

标题：

有效载荷：

响应 400：

标题：

身体：

我有一个项目（最近加入）在运行某些测试时依赖于底图。单独在 setup.py 中指定“底图”会在 Travis CI 上产生以下结果：

为了解决这个问题，以前的维护者启动了一个 requirements.txt 文件：

我们安装在我们的 travis yaml 中：

然后我们的 Travis 安装的其余部分工作。现在，当 Readthedocs 尝试构建文档时，它会自动获取需求文件（即使它说默认为None），但在找不到 libgeos 时会失败。为了解决这个问题，我创建了一个readthedocs.yml文件并尝试：

这导致 Rtd 挂在“Cloning ...”上，所以我尝试了：

这也挂起。我最终的工作解决方案是在“docs/requirements.txt”中创建一个空文件，并为 Rtd 指定该文件。

有没有人有更好的方法来解决这个问题？我有什么明显的遗漏吗？

我正在尝试使用Sphinx和ReadTheDocs (RTD) 在每次 GitHub 推送时编译我的文档。不幸的是，RTD 发现了多个包含一个文件的doc/文件夹。docsconf.py

我的存储库使用 git 子模块来嵌入第三方库。其中一些还使用 Sphinx 进行了记录。我假设最大的（持久的文档构建）获胜并覆盖最终 RTD 视图中的所有静态 HTML 页面。

如何排除或告诉 RTD 忽略这些子模块的文件夹：

我的文档位于此处：

据我发现，RTD 确实支持*.yml文件，但没有定义文档根文件夹的条目。

有什么想法可以解决我的问题吗？

我正在为我的项目在 reST 中编写一个新文档。该文档在 ReadTheDocs 上使用 Sphinx 呈现。我已经将 ReadTheDocs 主题作为 git 子模块下载到我的存储库docs/source/_themes文件夹中，因此我可以修改一些模板或 CSS 设置。

我想将大段落的文本对齐方式从ragged right更改为fully justified。
我在哪里可以在数百行 CSS 代码中更改他的？

文件结构：

要包含或替换的 CSS 代码：

我在 10 年前使用过 CSS，但我对新的 CSS 选择器并不是很了解......

我正在关注如何在本地安装 readthedocs 的本教程。

https://docs.readthedocs.io/en/latest/install.html

一切都按预期工作，但是有一件事我无法理解。

我已经创建了用户，通过单击确认链接激活了他，然后在管理员中我尝试连接到 github。我在这一点上得到的是：

快速而肮脏的解决方案是在管理员（/admin/socialaccount/socialapp/add/）中添加 github 应用程序，但是在这种情况下，当我单击连接时，帐户将简单地连接到该 github 帐户（并且任何其他用户将被阻止连接对任何东西）。

我的配置中缺少什么？

我已经为我的项目设置了一个 Sphinx 文档，并希望提取源文件的文档字符串并将它们嵌入到最终文档中。不幸的是，Sphinx 不支持源文件的语言 (VHDL)。VHDL 似乎没有 Sphinx 域。

所以我的想法如下：

• 挂钩到 Sphinx 运行并在 Sphinx 之前执行一些 Python 代码
• Python 代码从每个源文件（最顶部的多行注释块）中提取文本块，并为每个源文件组装一个 reST 文件，由该注释块和一些其他 reST 标记组成。
• 所有源文件都列在index.rst, 中以生成适当的.. toctree::指令。
• 文本提取和转换是按源代码目录递归完成的。

所以主要问题是：如何连接到 Spinx？

或者我应该只导入并运行我自己的配置conf.py吗？

我无法修改构建过程文件：Makefile并且make.bat，因为真正的构建过程在 ReadTheDocs.org 上运行。RTD 仅执行conf.py.

我最近（昨天）才开始使用 sphinx 并阅读了我的项目的文档。

到目前为止，我对 Html 文档感到满意，但 pdf 版本包括出现在目录标题内索引中的所有文章。文档的原始内容/索引仅由两个链接组成。

请帮忙。

文档位于http ://todx.rtfd.io，pdf 位于此处。