问题标签 [read-the-docs]

我目前正在尝试在 readthedocs.com 上为我的 Sphinx 重组文本项目构建文档。文档本身位于其自己的 github 存储库中。我已经在 github 上的 repo 中添加了 rtd 的 webhook，但是由于某种原因，在我导入项目后，我收到了错误：

我尝试按照提供的链接重新同步 webhook，但是当我尝试再次构建时，错误仍然出现。我认为我已经正确配置了设置，所以我不确定是什么导致了问题。存储库本身设置为私有，但我认为这不一定会导致问题。

这里可能是什么问题？

我正在尝试找出如何使用 Sphinx 中的 _template overrides 选项来覆盖默认的 ReadTheDocs 主题，以便在http://readthedocs.org上托管 Sphinx 文档。

具体来说，我想删除/隐藏此主题右上角显示的“在 Github 上编辑”链接。

任何提示将非常感谢！谢谢！

我在这里查看了文档：http ://www.sphinx-doc.org/en/stable/templating.html ，但是，我很难过，真的需要一些帮助。

谢谢！

我已经使用 Doxygen 和 Markdown 编写了一个中型 C++ 软件的文档。我对此很满意，因为在更改了 xml 层后，我得到了类似的结果： http: //docs.mitk.org/nightly/index.html

我想把这个文档放到网上，最好使用 ReadtheDocs 之类的东西，文档将在“git commit”之后自动构建，并托管以供浏览。

ReadtheDocs 看起来像是理想的站点，但默认使用 Sphinx 和 reStructuredText。Doxygen 也可以使用，但 AFAIK 只能通过呼吸。走这条路线本质上意味着如果我不想将所有 API 文档转储到一个页面中，我需要重新构建所有文档（http://librelist.com/browser//breathe/2011/8 /6/fwd-guidance-for-usage-breathe-with-existing-doxygen-set-up-on-a-large-project/#cab3f36b1e4bb2294e2507acad71775f）。

矛盾的是，Doxygen 安装在 read-the-docs 服务器中，但经过努力，我找不到跳过其 Sphinx 或 Mkdocs 的解决方法。

为了测试，我在github上创建了一个库，访问地址： https ://github.com/zibuyule/test2 。
在 readthedocs.org 上输入我的 github 帐户并构建最新版本。
在 readthedocs.org 我的地址是：https ://readthedocs.org/projects/test-zibuyule/ 。
点击“阅读文档”显示404错误页面。试了下午还是没有解决。
谁有成功在readthedocs.org上发帖，能否请教下。感觉这个东西还是很不错的，希望能用。谢谢

我想使用 readthedocs.org 为我的项目生成文档（包括使用 autodoc 自动生成的文档）。但是，我的项目使用 Python 3.5 语法 ( asyncand await)，它看起来无法处理。构建成功，虽然我得到了很多这样的错误：

有没有办法来解决这个问题？

我的基于 Sphinx 的文档有一个带有自定义 Jinja2 模板的特殊页面。我想将使用一些 Python 代码生成的自定义对象作为此模板的上下文传递。（它们是datetime，用于各种日历。）其中conf.py包括如下内容：

这在本地构建良好，但 Read the Docs 尝试使用 JSON 对其进行序列化。有没有办法将“非 JSON-able”对象传递给模板？

我得到的例外是：

我目前正在通过 read-the-docs 在线获取我的代码文档，但是，让 read-the-docs 处理我的 PyQt4 依赖模块似乎有问题。

我的项目具有以下结构：

我正在使用 sphinx-autodoc 构建不同模块的文档字符串的 html 表示。在我的本地机器上一切正常，但是，因为我需要 mockPyQt4 阅读文档，我遇到了以下问题： 在我的一个 GUI 类中，我QtGui.QDialog通过子类

并listSelectorDialog通过

模拟QtGui将导致阅读文档告诉我：

并因此崩溃。我尝试通过 使用 setup.py install 选择在 virtualenv 中安装您的项目来将我的包构建到虚拟环境 中，但事实证明，即使 PyQt4 列在中pip，您也无法安装它，请参阅https://superuser。 com/questions/679298/how-to-install-pyqt4-and-what-are-the-practical-differences-between-pyqt4-and-py。

到目前为止，我发现的唯一解决方法是，如果环境是 RTD，则不加载 GUI 模块并省略 GUI 模块的文档，但这不应该是最终解决方案。谢谢。

我正在尝试在本地主机上安装Readthedocs，一切都很好，除了它运行了很多我不需要的 Sphinx 构建器。具体来说，它运行python /path/to/sphinx-build -b latex最终会出现错误，因为我没有安装 texlive。

如何使 RTD 仅运行 html builder 以进行 repo？

我正在考虑建立自己的 readthedocs 实例。我看到他们支持 Git、Mercurial、Subversion 和 CVS。但是，我确实有几个遗留项目，这些项目需要相当大的努力才能转移到使用 TFVS 的 TFS 中的 git。

是否仍然可以使用他们正在谈论的 webhook 方法来拉入这些项目？

什么是基于代码的方法来让它工作？

最终我想在 Github 上打开所有这些，但那是我仍然需要出售的东西。

我已经开源了我的一些代码，但是尽管使用由本地创建sphinx-quickstart的Makefile 按预期工作，但文档无法在 ReadTheDocs 上正确构建。make html谁能告诉我我在 RTD 集成方面做错了什么？

我已经阅读了有关可能使用 RTD 高级设置在 virtualenv 中构建模块的信息，但这不起作用，因为我有 scipy 作为要求，并且由于没有可用的 BLAS 库而构建失败（对于每个构建来说，这也是一项不必要的长任务的文档）。

sphinx.ext.autodoc 和 sphinx.ext.napoleon（用于谷歌风格的文档字符串）都包括在内。在本地，我只跑过dev-scripts/api-docs.sh一次，它创建了docs/source/bnol.rst和docs/source/modules.rst. 然后使用标准 Makefile（在 git repo 中忽略）按预期构建文档。

• 包含包的GitHub 存储库/bnol/
• 狮身人面像conf.py
• RTD 托管的文档未正确构建

编辑：我发现这个常见问题解答详细介绍了 RTD 上的构建过程，sphinx-build并在本地使用了相同的过程，它按预期工作。我正在搜索 RTD 日志以查找错误，但目前还没有什么值得注意的。