问题标签 [read-the-docs]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
1939 浏览

bitbucket - 如何将 bitbucket 文档添加到 readthedocs

我有一个私人 bitbucket 存储库,其中包含:

我想将此文档添加到 readthedocs(我已经在 bitbucket 中设置了钩子)但是当它尝试构建它时说

有什么问题以及如何正确地做到这一点?

此外,这一切都是手动完成的,将 repo 添加到 redthedocs 虽然我已经在 readthedocs 中将 bitbucket 添加到我的社交帐户中,当我尝试从 bitbucket 导入时它说什么都没有,当我尝试同步时,就会发生这种情况:

0 投票
1 回答
124 浏览

read-the-docs - 错误:找不到xxx模块

我正在尝试在 readthedocs.org 上构建这个文档(doc/source/conf.py 中的 conf.py 。构建失败(此处为完整跟踪):

我尝试擦除构建环境但没有成功。任何想法 ?

0 投票
0 回答
337 浏览

python-sphinx - 不要从本地托管的 readthedocs 构建文档

我正在部署本地实例应用程序 readthedocs。当我开始生成文档时出现错误。

这里记录:

我使用服务器 gunicorn 和 nginx 作为代理。

0 投票
0 回答
981 浏览

python-sphinx - 如何在 Sphinx 中显示所有部分的侧边栏目录

也许只有我一个人,但我经常很难理解和浏览基于 Sphinx 的文档,因为目录只显示当前页面的结构(至少在标准主题中)。

还有一个previousand next,但我真正想看到的是侧边栏中的一个 TOC,它显示了所有部分,当前部分已展开。

例如,主页(即 index.rst)将是“概览”并默认打开。简介和快速入门是 index.rst 的部分:

“教程”将以next. When the 'Contribute' item is selected, the TOC is updated like so:

Search, Index,API应该链接到生成的页面,这些页面通常在 Sphinx 教程中像这样插入:

有没有一种简单的方法可以在Read the Docs上实现这一点,或者任何人都可以指向现有的模板?

0 投票
1 回答
1273 浏览

read-the-docs - 密码保护 readthedocs.org 文档

我有一个在 readthedocs.org 上管理的文档。有没有办法密码保护或至少让我们的文档只对我们的一些客户可用?

0 投票
1 回答
434 浏览

python-2.7 - ctypes 的模拟导入因 Read The Docs 上不支持的操作数而失败

我有依赖于ctypes核心模块的小型 Windows 模块。在项目 RTD 站点上,该模块的页面为空。查看最新的几乎成功的构建日志https://readthedocs.org/builds/apt/2900858/在make html阶段出现故障。

按照常见问题解答条目https://read-the-docs.readthedocs.org/en/latest/faq.html#i-get-import-errors-on-libraries-that-depend-on-c-modules我试图使用 伪造 import ctypes mock,但这样做会导致构建完全失败。据我所知,但我不是这方面的专家,这是因为 mock 本身缺少一些数学函数:

对错误的研究仅导致 3 次搜索命中,与 Mock 最相关(至少)缺少真正的除法运算符:https://mail.python.org/pipermail/python-bugs-list/2014-March/235709。 html

我走的是正确的道路吗?ctypes 可以在 RTD 上的项目中使用,我只需要坚持,还是我需要放弃并只使用本地机器上的 sphinx?

这是我的 conf.py中的当前模拟块:

// 这是来自https://github.com/rtfd/readthedocs.org/issues/1342的交叉帖子。一周后零回复,所以我把目光投向了更远的地方。//

0 投票
0 回答
1151 浏览

python-sphinx - Sphinx rtd 主题中的可折叠目录侧边栏

我正在使用 Sphinx 来记录我的 python 代码,我选择使用内置的 sphinx_rtd_theme(阅读文档主题),如图所示

我的文档纯粹是本地的,它绝不会连接到互联网,它看起来很好,只是在演示中,当您点击 [+] 或 [-] 符号时,目录(侧边栏)会展开和折叠。我的没有,实际上它在第一次点击时会展开,随后的点击会在 Windows 资源管理器中打开 index.html 文件夹的路径。双击也是如此。我的问题是如何防止这种行为并使我的目录像在演示中一样具有很好的可扩展/可折叠目录。它是 conf.py 文件中的设置吗?

我确实从 sphinx 网站上阅读了指向主题选项的文档,但它们似乎只适用于经典主题。我是否正确理解这一点?

0 投票
1 回答
2370 浏览

github - 如何在 ReadTheDocs 的一个项目中设置多个 Sphinx 文档?

我想使用 ReadTheDocs 来托管我的 Sphinx 文档。该项目托管在 github 上。我可以很好地连接到它。

我的特殊之处在于该项目包含 2 个 Sphinx 文档(例如程序员手册和用户手册)。ReadTheDocs 似乎正在检测两者(有两个 conf.py)并构建两者。但是,在显示它们时,它只显示其中一个的 html,据我所知,第一个按字母顺序显示。

所以我的问题是:

  1. 如果两者都已建成,您如何才能看到另一个?

  2. 有没有办法使用“子项目”来指定每个 conf.py 的路径,从而有每个文档/手册的清晰 URL?那将是理想的解决方案。

0 投票
0 回答
346 浏览

git - 如何从存储库中导入项目以进行 readthedocs?

我在存储库上有一个项目github,我正在尝试根据它的降价文件为它构建一个文档。我决定使用readthedocs它,但是,我无法正确导入它。在尝试构建文档时,它返回以下错误消息:

我提供的地址是公开的,不是 SSH 或任何东西。有任何想法吗?

0 投票
1 回答
1598 浏览

git - 为什么我不能为 readthedocs 克隆一个 git repo 来构建文档?

我正在尝试导入我的项目代码,readthedocs以便它可以为我生成文档。但是,在克隆 repo 的阶段,已经出现了错误:

该错误代码表明,存储库是私有的,我无法在不登录的情况下访问它,除非我拥有能够在我的计算机和服务器之间建立安全连接的 SSH 密钥。所以我生成了我的密钥,然后将其添加到项目中的部署密钥中。

您能想到为什么我仍然无法访问项目代码的任何原因吗?