问题标签 [read-the-docs]

据我了解，新的 Read The Docs 主题从深度为 2 的目录树生成侧边栏。我的文档相对较深，深度为 2 不足以使其有用。我怎样才能增加这个限制，或者最好完全删除它？

如果这不合理，我如何使用本地 ToC 而不是全局目录树？

我的项目文档托管在
http://nsetools.readthedocs.org
上的 readthedocs.org 上 是否可以将谷歌分析与托管在 readthedocs 上的文档一起使用？由于 html 不是由我生成的，我不确定在哪里应用谷歌分析代码片段。

我用 Sphinx 为 Python 模块编写了一些文档。它在我的计算机上完美地构建和显示 HTML。但是，我一直在维护 Read the Docs 版本，但显示不正确。当我在文档更稀疏时检查它时，它起作用了，但它已经停止了。

API 页面（链接）应该有比它更详细的方法。当我查看 GitHub 上的原始 .rst 文件时，它们包含信息，但它不会显示在 RTD 上。

当我将项目放在 PyPI 上时，我更改了项目的文件夹结构，所以我想知道是不是这样，但我不知道如何修复它。

任何帮助将不胜感激。

我有一个包含两个记录在案的全球特殊成员的模块。

在本地运行 Sphinx 会创建包含其文档的文档，但 Read the Docs 不会。它使用内置类型的文档来代替。

我已经尝试了这两种样式：#:和定义后的文档字符串。我已多次阅读autodoc's 文档，以及Read the Docs条目。我无法弄清楚我错过了什么，因为我什至没有在Read the Docs上看到任何构建错误。

有任何想法吗？

有人知道使用时如何更改菜单顺序.md吗？我找不到它。我知道其他类型也可以，例如.rst，但我使用.md

谢谢！

I want to publish the documentation of my project https://bitbucket.org/oaltun/opn in readthedocs.org.

The build fails. There are different errors shown in the log https://readthedocs.org/builds/opn/2247789/ , but the first is "no module named sip".

sip is needed by pyqt, which is needed by the project.

Normally in this kind of situation, as far as I understand, you would add missing package to your setup.py, and check the readthedocs.org option to create a virtualenv. I do check the box to create a virtualenv. But I can not add sip or pyqt to setup.py.

The problem is pyqt & sip does not use setuptools, so can not be installed by pip. So you can not add them to setup.py (This fails even in my local machine).

In my local environment I install pyqt with (ana)conda. But I think readthedocs.org uses pip for calling the dependencies.

So, how can I have my virtualenv include sip?

我有一个项目，我为它构建了一组 .rst 文件，sphinx.ext.apidoc这些文件从我的项目的文档字符串中提取文档。

这些文件如下所示：

make html在我的计算机上正确构建文档，但需要我编辑conf.py文件以将我的项目添加到 python 系统路径，以便在 autodoc 尝试导入它们时正确找到 .rst 文件中提到的模块。

但是，当我尝试在 readthedocs 上构建文档时，autodoc 无法找到引用的模块，因为我不知道需要将什么路径添加到 python 系统路径才能让 autodoc 正确找到项目模块。

我想知道是否可以在本地环境中使用 autodoc 预先构建 .rst 文件，以便它们不再包含对 autodoc 的任何调用，然后将它们上传到 readthedocs，这样就不需要运行那里的自动文档扩展。

如果没有办法做到这一点，那么解决该问题的正确方法是什么？

我似乎无法让 ReadTheDocs 显示任何模块的 :members:，例如在我的本地 html 中我得到：

但是在推送到 github 之后，readthedocs 文档只说：

没有出现错误，当我在本地将其构建为 html 时，它会在没有警告的情况下运行。

任何提示将不胜感激！

我正在测试 RTD 以构建我们的 API 文档实现，因此在 debian VM 的 virtualenv 中运行 RTD 的本地安装。./manage.py runserver 命令成功运行 RTD 服务器。

要从我的笔记本电脑浏览器（VM 外部）访问 RTD 管理控制台，我想将 localhost 更改为公共 IP。为此，我更改了 IP 引用：

• /etc/hosts
• settings/sqlite.py（Internal_ips 部分和其他一些事件）

但是，它继续在http://127.0.0.1:8000/构建服务器

我应该在哪里配置这个？我还应该做什么？

如何获取阅读文档的 html 模板的源代码？我从 git hub 获得 sphinx 包，但我不知道 python 或如何继续使用该包

我只想要该模板的 HTML 和 css 文件，然后我将根据我的要求进行修改