不能使用 :ref: 与使用 Sphinx 文档的标签



我有一个问题,使用Sphinx-doc的:ref:角色,我把一个标签上面的段落,然后我尝试链接到标签从另一个文档,但在同一项目内。

我在一个文档中使用的标签:
.. _hal_1k_1p:

ref我试图用它来链接到那个标签:

:ref:`Link title hal_1k_1p`

但是我只在构建文档时得到这个错误信息:

警告:未定义标签:链接标题hal_1k_1p(如果链接没有标题(标签必须在节头之前)

我做错了什么?

好的,看看:ref:你需要有这个:

:ref:`Link title <ha1_1k_1p>` 

链接到那个标签。

确保你的标签周围有尖括号,像这样:

首先确保ref的格式为:

标签:

.. _yourlabel:
参考

:

This is a reference to :ref:`yourlabel`.

或者(如果你想给它一个自定义的名字)

This is a reference to :ref:`my very own label <yourlabel>`.

标签定义包含前导下划线(_),而引用不包含!还要确保您没有意外地将冒号从标签定义(:)复制到引用中。

如果这没有帮助,试着在conf.py:

中将语言暂时切换回英语。
language = 'en'

如果你看到这是有效的,你可以切换回来。不知怎么的,这解决了我的问题。可能与:https://github.com/sphinx-doc/sphinx/issues/1300

有关

最新更新