大家好!
我正在用Sphinx编写一个文档网页,尽管我已经能够按照本指南中的内容在同一页面中创建良好的交叉引用,但我现在想在页面a中添加对页面b中子部分的引用。
我知道我可以通过一个显式的外部链接做到这一点,比如:
`Link name <https://my.documentation.domain/path/to/page-B#subsection>`_
但是我也可以用交叉引用来做吗?在我看来这样会更整洁。I tried:
:doc:`page_B:subsection`
和
:doc:`page_B#subsection`
,但无法识别。抱歉,如果这是一个假问题,但我没有找到答案在互联网上。谢谢你:)
感谢@bad_coder和@Steve Piercy!所以这个问题的答案就是我一直在寻找的,但并没有以一种我能找到的方式表达出来。对于那些最终会在这里结束的人,对我有用的是:
在page-A
中定义一个目标,在section标题前添加:
.. _target name in page A:
在page-B
中引用此目标,只需使用:
:ref:`target name in page A`
注意不需要添加page-A
的名称,引用会自动找到。
它也可以使用相对html链接,但这远远不够健壮(例如,如果部分名称发生变化,它会中断):
`Link name <page_A.html#subsection>`_