如何自动生成Sphinx术语表中所有术语的带链接目录?
在Sphinx中自动生成带内部链接的术语表列表
以下两种简便方法可实现需求:
方法1:利用Sphinx内置引用机制
先按常规方式定义术语表:
.. glossary:: 术语A 术语A的详细说明 术语B 术语B的详细说明
要生成术语列表时,直接用:ref:引用每个术语的自动锚点:
- :ref:`术语A` - :ref:`术语B`
Sphinx会自动为每个术语生成锚点,:ref:会创建指向对应术语条目的内部链接,无需手动设置锚点名称。
方法2:用扩展实现全自动化
如果术语数量较多,手动引用效率低,可以借助sphinxcontrib-glossary扩展:
- 安装扩展:
pip install sphinxcontrib-glossary
- 在项目的
conf.py中启用扩展:
extensions = [ # 保留你已有的其他扩展 'sphinxcontrib.glossary', ]
- 在需要生成术语列表的位置添加指令:
.. glossarylist::
该指令会自动扫描文档中所有glossary块定义的术语,生成带内部链接的完整列表,无需手动逐个引用。
内容的提问来源于stack exchange,提问作者Jan E
相关产品推荐
相关产品推荐

