不能将 :ref: 与使用 Sphinx 文档的标签一起使用
Can't use :ref: with a Label using Sphinx doc
我在使用 Sphinx-doc 的 :ref: 角色时遇到问题，我在段落上方放置了一个标签，然后我尝试 link 从另一个文档但在同一个项目中到该标签。
我在一个文档中使用的标签：
.. _hal_1k_1p:
而 ref 我尝试将 link 用于该标签：
:ref:`Link title hal_1k_1p`
但我只在构建文档时收到此错误消息：
WARNING: undefined label: link title hal_1k_1p (if the link has no
caption the label must precede a section header)
我做错了什么？
好的，看着 :ref: 你需要这个：
:ref:`Link title <ha1_1k_1p>`
到 link 到那个标签。
确保标签周围有尖括号，如下所示：
首先确保您的参考格式为：
标签:
.. _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
我在使用 Sphinx-doc 的 :ref: 角色时遇到问题，我在段落上方放置了一个标签，然后我尝试 link 从另一个文档但在同一个项目中到该标签。
我在一个文档中使用的标签：
.. _hal_1k_1p:
而 ref 我尝试将 link 用于该标签：
:ref:`Link title hal_1k_1p`
但我只在构建文档时收到此错误消息：
WARNING: undefined label: link title hal_1k_1p (if the link has no caption the label must precede a section header)
我做错了什么？
好的，看着 :ref: 你需要这个：
:ref:`Link title <ha1_1k_1p>`
到 link 到那个标签。
确保标签周围有尖括号，如下所示：
首先确保您的参考格式为：
标签:
.. _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