问题标签 [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 投票
6 回答
8401 浏览

python-sphinx - 将可点击的 SVG 图像插入 Sphinx 文档

我有几个节点的 SVG 图像文件,每个节点都与 URL 相关联。如果我直接在浏览器中打开这个文件,我可以点击每个节点,它会打开不同的 URL。但是,当我在我的 Sphinx 文档中使用这张图片时,它不起作用 - 图片呈现为一个整体,所以我需要打开它,View Image然后我才能点击节点。

我正在使用标准图像指令:

可能我需要使用其他东西?

0 投票
1 回答
1198 浏览

read-the-docs - 为什么 readthedocs 没有显示最新版本?

在以下项目中:

https://readthedocs.org/projects/django-guardian/versions/

1.4.1 版没有出现。然而 1.4.1 版本在 github 中被标记,并且我在此更改后进行了推送。

https://github.com/django-guardian/django-guardian/releases

如何让 v1.4.1 显示?我也没有在管理版本选项中看到它。

(v1.4.0 也没有显示,但那是因为我手动禁用了此修订版;由于缺少依赖项,出现错误阻止 readthedocs 构建此版本)

0 投票
0 回答
204 浏览

python - readthedocs.org 上的 sphinx-doc 文档依赖于私有 sphinxcontrib-package

我在 readthedocs.org 上托管了一个 sphinx-doc 网站,它依赖于一个私有 sphinx-doc 扩展/sphinxcontrib-package [extension_name]。在我的本地电脑上,这个扩展位于子目录 [sphinx-doc project root]/exts/sphinxcontrib-[extension name] 和conf.py中的“引用”

.py 文件位于“源”目录sphinxcontrib中。本地 sphinx-doc 构建输出符合预期。然而,readthedocs.org 上的构建失败,原因是

由于扩展处于测试阶段,我不想在线分发它。(如果我愿意,我应该能够将它安装为从网络源预构建的 readthedocs.org。)我该如何处理这个问题?

0 投票
1 回答
194 浏览

python - 阅读文档 build failed UnicodeDecodeError

我在https://readthedocs.org上,我尝试构建用 python3 编写的项目文档。

设置:

文档类型:Sphinx html

编程语言:python

使用虚拟环境

python解释器:CPython 3.x

它失败了:

和:

https://readthedocs.org/projects/crawler/builds/3711852上的详细信息

0 投票
2 回答
757 浏览

python-sphinx - 在 Sphinx ReadTheDocs 主题中禁用顶部导航栏(面包屑)

我想禁用 ReadTheDocs 主题的顶部导航栏。对于其他主题,例如classic它只是一个选项

如何修改阅读文档主题以禁用此顶部导航栏?

编辑: 用 处理源文件后make html,我必须在 html 文件中删除这些行

以获得预期的结果。在使用 编译源之前是否可以获得此结果make html

0 投票
1 回答
56 浏览

read-the-docs - 阅读损坏的文档;怎么修?

如果我访问http://django-guardian.readthedocs.org/en/latest/installation.html,我会看到没有任何样式的原始内容。CSS 文件似乎可以正常加载,但没有任何影响。如果我在本地机器上手动构建文档,它可以正常工作。

0 投票
2 回答
378 浏览

python - Readthedocs 上的 Sphinx 错误:“TypeError:'bool' 对象没有属性 '__getitem__'”

Readthedocs 上的文档构建失败,出现一个很难理解的 Sphinx 错误:

有关完整日志,请参阅https://readthedocs.org/projects/fluidimage/builds/3758665/

我发现其他项目也遇到过同样的问题(链接到谷歌搜索),但这并不能帮助我理解发生了什么。

这个错误是什么意思?如何解决?

0 投票
1 回答
538 浏览

python - sphinx - 一章中有几个文件,并且可以使用 rtd 主题进行干净的 html 导航?

我正在使用 sphinx 1.3.4¹ 来编写我的文档,make html使用“阅读文档”主题²。

当我在 index.rst 中包含标题从 Lv 1 到 Lv3 的文件 chaper1.rst 时,我会在生成的导航侧边栏中看到标题 lv 1。单击此标题后,它会折叠并显示标题 lv2 -lv3。好吧,没关系。

当我将第 1 章拆分为多个文件时,我可以chaper1/*在 index.rst 和生成的 html 文档中使用每个文件。但是每个文件标题 - 也包括那些以 lv2 开头的文件 - 在中央导航侧边栏中显示为单独的章节。不再折叠章节标题。:-/

如何为每章使用多个文件在左侧实现干净的导航?

蒂亚!

编辑 我做了 rtd-theme 版本 0.1.9 的反向移植 - 没有变化。所以这似乎是一个狮身人面像的问题。如何正确地将多个文件包含到一章中?

[1] https://packages.debian.org/jessie-backports/python3-sphinx
[2] https://packages.debian.org/jessie/python3-sphinx-rtd-theme

0 投票
1 回答
121 浏览

python-sphinx - 将次要页面放在目录中的正确位置

在我的 sphinx 文档中,我有一些小页面(当然)需要成为目录树的一部分,但我无法将它们列在正确的位置。

如果我的“第 3 节”页面如下所示:

然后3.3之前3.4都列出来了。 3

我尝试了其他排列,但似乎没有一个有效。

  1. 如果我将目录树放在3标题之后,则在3.3之间3.4列出。 33.1
  2. 如果我将目录树放在页面的末尾,一切都按正确的顺序排列,但3.3成为3.4第三级部分,即 section 的子级3.2

我在这里举了一个具体的例子:

0 投票
3 回答
1595 浏览

setuptools - 阅读文档和 setuptools scm 版本错误

我有一个我刚刚更新以使用 setuptools_scm 的软件包,并在 readthedocs 中发现版本号错误。

http://sshuttle.readthedocs.org/en/v0.77/显示:

但是由于版本 083293e 有 0.77 标签,版本字符串应该只是 0.77

看起来 readthedocs 可能会在构建之前对我的源代码进行更改。

我查看了 readthedocs 构建日志,它似乎在某个阶段(0.77)具有正确的版本,但是这是在它构建文档之前。

构建文档时构建日志未提及版本。

有可能解决这个问题吗?

谢谢