Как сделать внутреннюю гиперссылку в документации Sphinx

Как сделать внутреннюю гиперссылку в документации Sphinx? Я использую:

:role:`target`

Но это не работает.


person ajax-ie    schedule 08.12.2010    source источник


Ответы (2)


Перекрестные ссылки выполняются с помощью ref

:ref:`label-name`

Вы можете предоставить свои этикетки, используя:

.. _label-name:

См.: https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-ref

Роли используются для создания пользовательского интерпретируемого текста. См.: http://docutils.sourceforge.net/docs/ref/rst/directives.html#role

person pyfunc    schedule 08.12.2010

Где-то заголовок есть,

.. _HeaderTag:

Header
------

Ссылка на заголовок выше (может быть не тот же файл)

:ref:`HeaderTag`

# or with custom text
:ref:`custom header<HeaderTag>`
person Anh-Thi DINH    schedule 09.07.2020