Sphinx 文档和悬停文本答案

【问题标题】：Sphinx documentation and hover textSphinx 文档和悬停文本
【发布时间】：2013-12-06 07:13:45
【问题描述】：

是否可以使用sphinx 将hover-boxes 用于出现在代码sn-ps 中的单词，类似于angular.js landing page 中代码示例中的悬停框的外观和行为？

【问题讨论】：

【解决方案1】：

不幸的是，我不认为这将得到开箱即用的支持（请参阅：https://bitbucket.org/birkenfeld/sphinx/issue/73/show-term-contents-in-a-tooltip）。

还值得一提的是，Angular 的登录页面不是文档页面，它本身就是一个 web 应用程序，所以它首先会出现很多代码和 CSS 技巧。

【讨论】：

【解决方案2】：

它可以作为一个额外的构建步骤，忽略任何对 sphinx 的输入或扩展，因为 sphinx 代码 sn-ps（通常）在 sphinx 生成的 html 输出中很容易识别。因此，在 sphinx 步骤之后的额外后处理步骤可以轻松找到它们，然后可以在顶部添加一些逻辑，根据您的喜好添加悬停框。

【讨论】：

【解决方案3】：

（对于那些在常规 RsT 文本中寻找悬停工具提示时登陆这里的人）

:abbr: inline markup 在 HTML 中生成工具提示，像这样：

:abbr:`linkified text (tooltip text)`

另一种功能齐全的解决方案是 sphinx-hoverxref 扩展，它改进了类似 :ref: 的角色，从引用的部分、图形等中获取工具提示内容：

【讨论】：