Sphinx文档和悬停文本

Question

使用sphinx，是否可以为出现在代码片段中的单词提供类似于angular.js landing page中代码示例中的悬停框的hover-boxes？

- matanster

---

既然在生成的HTML中容易识别代码块，因此可以将其作为sphinx普通构建之后的附加步骤。我想，在sphinx完成其任务后进行另一个步骤也是可能的。 - matanster

Answer 1

<请勿修改格式>

(对于那些在查找常规RsT文本中的悬停提示时着陆在这里的人)

:abbr:内联标记会在HTML中产生工具提示，如下所示：

:abbr:`linkified text (tooltip text)`

---

一种可供选择的完全功能解决方案是sphinx-hoverxref扩展，它是一种类似:ref:角色的工具，可以从所引用的部分、图像等获取工具提示内容：

- ankostis

Answer 2

很遗憾，我认为这不会被原生支持（参见：https://bitbucket.org/birkenfeld/sphinx/issue/73/show-term-contents-in-a-tooltip）。

还值得一提的是，Angular 的首页不是文档页面，它是一个独立的 Web 应用程序，所以有很多代码和 CSS 技巧，首先它看起来是如此。

- rdodev

---

很遗憾，我无法访问那个Bitbucket仓库。而且我不明白为什么渲染rst页面的一些内容为hoverbox会如此复杂。 - Omni

问题现在已经在 GitHub 上了（已关闭，不会修复）：https://github.com/sphinx-doc/sphinx/issues/73 - mzjn

Answer 3

作为额外的构建步骤，可以很容易地识别 sphinx 生成的 html 输出中的 sphinx 代码片段（通常情况下），而不需要任何输入或扩展。因此，在 sphinx 步骤之后进行额外的后处理步骤，可以轻松地定位它们，然后在其上添加一些逻辑，根据您的喜好添加悬停框。

- matanster