如何在sphinx文档中创建内部超链接

时间:2010-12-08 08:02:18

标签: python python-sphinx

如何在sphinx文档中创建内部超链接? 我正在使用:

:role:`target`  

但它没有用。

2 个答案:

答案 0 :(得分:26)

使用ref

进行交叉引用
:ref:`label-name`

您可以使用以下方式提供标签:

.. _label-name:

请参阅:http://sphinx.pocoo.org/markup/inline.html#ref-role

角色用于创建自定义解释文本。请参阅:http://docutils.sourceforge.net/docs/ref/rst/directives.html#role

答案 1 :(得分:0)

标题在某处

.. _HeaderTag:

Header
------

请参考上面的标题(可能不是同一文件)

:ref:`HeaderTag`

# or with custom text
:ref:`custum header<HeaderTag>`