Невозможно использовать :ref: с меткой, используя документ Sphinx

У меня проблема с использованием роли :ref: Sphinx-doc, я помещаю метку над абзацем, а затем пытаюсь сделать ссылку на эту метку из другого документа, но внутри того же проекта.

Метка, которую я использую в одном документе:

.. _hal_1k_1p:

И ref, который я пытаюсь использовать для ссылки на этот ярлык:

:ref:`Link title hal_1k_1p`

Но я получаю это сообщение об ошибке только при создании документа:

ВНИМАНИЕ: неопределенная метка: заголовок ссылки hal_1k_1p (если у ссылки нет заголовка, метка должна предшествовать заголовку раздела)

Что я делаю неправильно?


python-sphinx cross-reference restructuredtext
person Raiu    schedule 02.09.2015    source источник

Ответы (1)


arrow_upward
29
arrow_downward

Хорошо, посмотрите на :ref: вам нужно иметь это:

:ref:`Link title <ha1_1k_1p>`

для ссылки на этот ярлык.

Убедитесь, что ярлык заключен в угловые скобки, например: ‹label›.

person user1411260    schedule 02.09.2015
comment
Когда я читаю официальные документы, они дают такой ответ относительно моей проблемы. На метки, которые не помещены перед заголовком раздела, все еще можно ссылаться, но вы должны дать ссылке явный заголовок, используя следующий синтаксис: :ref:Link title <label-name>. Но проблема в том, что они на самом деле не дают примеров того, как это реализовать, так что я как бы застрял - person Raiu; 02.09.2015
comment
также обратите внимание, что определение метки включает _ в начале, в то время как использование метки не включает символ _ - person Hubert Kario; 20.10.2019