Sphinx文档和悬停文本

时间:2013-11-21 17:03:49

标签: html user-interface python-sphinx pygments

是否可以使用sphinx对代码段中出现的字词hover-boxes,类似于angular.js landing page中代码示例中的悬停框的外观和行为样的?

3 个答案:

答案 0 :(得分:1)

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

:abbr: inline markup生成HTML的工具提示, 像这样:

:abbr:`linkified text (tooltip text)`

另一种功能齐全的解决方案是sphinx-hoverxref扩展,它扩展了类似:ref:的角色,该角色从引用的部分,图形等中获取工具提示内容: enter image description here

答案 1 :(得分:0)

不幸的是,我认为这不会支持开箱即用(参见:https://bitbucket.org/birkenfeld/sphinx/issue/73/show-term-contents-in-a-tooltip)。

值得一提的是,Angular的登陆页面不是一个文档页面,它本身就是一个webapp,所以会出现很多代码和CSS技巧,它会首先出现。

答案 2 :(得分:0)

这可能是一个额外的构建步骤,无视任何sphinx的输入或扩展,因为sphinx代码片段(通常)很容易在sphinx生成的html输出中识别。因此,在狮身人面像步骤之后进行额外的后处理步骤,可以轻松找到它们,然后可以在顶部喷洒一些逻辑,根据您的喜好添加悬停框。