You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

如何在Sphinx表格中链接函数并自动生成属性表?

实现方案

方案1:自动生成汇总表(推荐)

首先启用sphinx.ext.autosummary扩展,在项目的conf.py中修改扩展配置:

extensions = [
    # 保留原有其他扩展
    "sphinx.ext.autosummary",
]
# 开启自动生成汇总页面的配置
autosummary_generate = True

然后在「Usage」板块需要插入汇总表的位置,添加如下指令:

.. autosummary::
   :nosignatures:
   :toctree: generated/

   你的第一个函数名
   你的第二个函数名
   # 依次列全所有已标记的函数名

默认生成的表格会包含函数名、简述两列,如果需要新增参数、属性等自定义列,可以在项目的_templates/autosummary/function.rst路径下自定义渲染模板,调整表格列的输出规则,最终效果和discord.py官方API的属性表格完全一致。

方案2:手动构建带跳转链接的表格

不需要额外扩展,直接用Sphinx原生的交叉引用语法即可实现:
所有通过.. function::标记的函数都会自动生成可引用的锚点,使用:func:角色包裹函数名,就能生成指向对应函数定义的自动跳转链接。手动写表格的示例如下:

| 函数 | 参数 | 功能说明 |
| ---- | ---- | -------- |
| :func:`test_func1` | `a: int, b: str` | 测试函数1的功能描述 |
| :func:`test_func2` | `c: bool` | 测试函数2的功能描述 |

如果项目内存在重名函数,可以填写函数的全路径避免引用冲突,例如:func:my_module.utils.test_func1``。

内容的提问来源于stack exchange,提问作者rxnen

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.09.29 15:54:04