Jupyter Notebook HTML 输出中带工具提示注释的 Python 源代码

Question

我的目标是创建高质量的 Python 代码示例。

我使用 Jupyter Notebooks 作为笔记本中的代码示例。是否可以使用 Jupyter 笔记本本身，或使用

nbsphinx

从其创建的 Sphinx 文档将类和类型文档用作工具提示？

• 用户可以将鼠标悬停在示例代码上以查看变量的类/类型
• 鼠标悬停在工具提示上将包含文档字符串（类描述）
• 当您编辑笔记本时，Jupyter 笔记本似乎已经能够提取此信息
• 单击代码示例中的变量将跳转到其类/类型定义的文档

下面是当鼠标悬停在 PyCharm 中的笔记本上时工具提示的示例屏幕截图。在代码示例和文档中提供此类功能将使文档变得更加有用。

Answer 1

它没有花哨的工具提示，但

sphinx_codeautolink

扩展会生成您想要的链接。

它适用于 nbsphinx 和 MyST-NB。