问题标签 [read-the-docs]

RuboCop已从单页 README更改为包含多个较小页面的手册，可在 readthedocs.io 上找到。有没有办法在一个页面中查看所有内容？在 github 上查看最后一个未重构的 README 版本现在可以使用，但随着时间的推移将变得过时。

我根本不知道如何链接到 reST 文件中的另一个文档。

install.rst我想在一个段落中链接一个名为我的快速入门指南的文件。我不知道我怎样才能做到这一点。

请您还可以参考一个很好的资源，我可以从中查找语法以供休息。默认的快速入门有点乏味，并且不涉及将 rest 与 sphinx 一起使用的深入讨论。

有问题的文档是：http ://todx.rtfd.io

我正在使用ReadThedocs (mkdocs). .md但它正在为放置在docs目录中的文件生成文档项目。我的要求是，我想为.md放置在 github 存储库中任何位置的每个文件构建文档项目。

如何做到这一点？

我从包含的 ReadtheDocs 主题切换到我的项目的 bootswatch United 主题。我pip install mkdocs-bootswatch为这个主题做了一个，并在我的文件中更改theme: readthedocs为。theme: unitedmkdocs.yml

然而，尽管项目在 Read the Docs 中构建成功，但文档保留了标准的 readthedocs 主题。当我在本地运行它（使用mkdocs serve）时，它以 United 主题正确显示。

我应该在某处调整另一行代码吗？我应该添加一个需求文件？我怎样才能让外部主题正确出现在 ReadtheDocs 中......或者实际上，我什至可以在 readthedocs.org 上使用外部主题吗？

注意：我确实问过 MkDocs 的人，他们说这是 ReadTheDocs 的限制，所以如果有什么需要做的，它似乎是一个与 ReadTheDocs 相关的解决方案。否则，我可能不得不切换到 GitHub 页面或类似的东西。

我知道这可能是一个非常愚蠢的问题，但我没有设法在网上找到任何关于潜在解决方案的信息。

我正在使用Sphinx 1.4和sphinx_rtd_theme为我的 Django 项目生成一些文档。我一直在尝试找到一种在 .rst 文件中使用字体真棒图标的方法，但没有找到方法。我查看了 sphinx_rtd_theme 源文件，并且 fa-* 图标包含在 theme.css 文件中。但是，我不知道实际上包含它们的方法。

它是指令、解释文本还是类似的东西？我已经尝试过icon、fonticon和fa作为上述任何一种方法，但都没有奏效。

任何帮助，将不胜感激。

我知道我可能会使用原始 HTML，但如果可能的话，我想避免这种情况。

我对这件事完全陌生。花了一整天试图找出“最常用”的方法。我想要实现的是类似于 readthedocs.org 的东西，但是对于私人客户（和专有项目）。

几乎所有常见问题解答、博客文章、操作指南等都在描述如何使用 GitHub 页面或使用 readthedocs.org (.com) 托管（发布）文档

我尝试在本地使用 Sphinx（注意：不是“Sphinx 搜索”），我可以很容易地构建一个示例演示文档，但我并不完全了解如何托管一个“可搜索”解决方案，比如它适用于http://www.sphinx-doc.org（不过，它似乎使用 readthedocs.org 作为搜索后端）。

我尝试在本地部署 readthedocs.org，但是：

1. “搜索”不起作用（没有人在 127.0.0.1:9200 上收听）。
2. 我无法构建任何文档（未找到版本或未找到项目）。
3. 我无法从我的私人存储库 (ssh:) 添加项目

（注意：我在 Windows 上尝试过，这可能解释了第 1-2 项，但不是第 3 项，我相信。）

到目前为止，感觉就像我已经没有想法了..

任何建议将不胜感激！

我尝试按照文档在我的 linux 服务器上安装 ReadTheDocs：http ://read-the-docs.readthedocs.io/en/latest/install.html

但是我没有收到激活电子邮件。
我能够在服务器上看到电子邮件的输出

注意：此邮件为密码重置邮件，与激活邮件有同样的问题。（我没有收到来自我的 ReadTheDocs 安装的任何电子邮件）

有两件事引起了我的注意。
1.阅读文档在哪里配置网站名称，我想将example.com更改为真实的网站名称。
2.目前的发送地址是no-reply@readthedocs.org，在哪里可以更改？我认为这也是问题的一部分。

这是电子邮件的其他标题

所以实际上我有两个问题

• 我在哪里可以更改电子邮件的内容以及发件人地址等内容。

• 电子邮件发生了什么（为什么我收不到它）

要在 readthedocs 上编译文档，必须模拟模块 h5py。我得到一个可以用这个简单的代码重现的错误：

这个脚本的输出是：

h5py模拟和的正确方法是什么h5py.File？

在我看来，这个问题对于带有 readthedocs 的文档来说非常普遍，其中一些模块必须被模拟。社区有一个答案会很有用。

我有个问题。我已经手动安装了 Read The Docs，但是当我尝试连接到 bitbucket 时出现错误：

追溯http://dpaste.com/3J4AK6K。请帮忙。我需要做什么？我是python和django的新手。

按照http://read-the-docs.readthedocs.io/en/latest/install.html中的指南在本地安装 readthedocs失败。我正在尝试将它安装在 Mac Pro OSX El Capitan 10.11.15 上。

当我尝试访问 localhosts:8000 时，它会返回消息A server error occurred. Please contact the administrator.

终端输出：

有谁熟悉这个问题？