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

如何在Python-Sphinx中跨页面引用子章节?

Sphinx跨页面引用子章节的正确方法

要实现跨页面引用子章节,别用:doc:指令加锚点的方式,正确操作分两步:

  • 第一步:给页面B的目标子章节加标签
    在页面B的子章节标题上方添加自定义标签,格式如下:

    .. _page_b_subsection:
    
    ## 我的子章节标题
    

    这里的page_b_subsection是你自定义的标签名,尽量取有辨识度的名字,避免和其他标签重复。

  • 第二步:在页面A中引用该标签
    用:ref:指令来引用,有两种写法:

    1. 自定义显示文本:
      :ref:`跳转到页面B的子章节 <page_b_subsection>`
      
    2. 直接显示目标子章节的标题:
      :ref:`page_b_subsection`
      

这种方式比硬编码URL更可靠,就算页面B的路径或者子章节标题改了,只要标签名不变,引用就不会失效。

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

相关产品推荐
方舟 Agent Plan

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

最近更新时间:2026.08.11 20:15:16