跳转到主要内容

Sphinx扩展,当鼠标悬停在引用上时显示包含内容的工具提示。

项目描述

Current PyPI version Documentation status Repository license

sphinx-hoverxref

sphinx-hoverxref 是一个 Sphinx 扩展,用于在文档的交叉引用上添加工具提示,显示链接部分的文本内容。

示例

docs/sphinx-hoverxref-example.png

安装

您可以从 PyPI 安装 sphinx-hoverxref

pip install sphinx-hoverxref

或者,也可以直接从 GitHub 安装(需要 git)

pip install git+https://github.com/readthedocs/sphinx-hoverxref

配置

将此扩展添加到您的 conf.py 文件中,如下所示

extensions = [
 # ... other extensions here

 'hoverxref.extension',
]

文档

查看完整文档,请访问 https://sphinx-hoverxref.readthedocs.io/

项目详情


下载文件

下载适合您平台的应用程序。如果您不确定选择哪个,请了解更多关于 安装软件包 的信息。

源代码分发

sphinx_hoverxref-1.4.1.tar.gz (1.7 MB 查看哈希值)

上传时间 源代码

构建分发

sphinx_hoverxref-1.4.1-py2.py3-none-any.whl (32.3 kB 查看哈希值)

上传时间 Python 2 Python 3

由以下机构支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误日志 StatusPage StatusPage 状态页面