Ссылка на локальный заголовок при использовании autosectionlabel - PullRequest
0 голосов
/ 04 ноября 2019

Как мне ссылаться на заголовок подраздела в локальном документе с помощью sphinx, если у меня включены autosectionlabel и autosectionlabel_prefix_document. У меня есть подробная и довольно вложенная папка в моей документации, и я хотел бы заменить длинный путь чем-то, что представляет локальный файл. #,. или локальное имя файла не работает

пример

Heading 1
---------

subheading
^^^^^^^^^^

:ref:`/full/path/relative_to_config_file:subheading` works 

1 Ответ

0 голосов
/ 04 ноября 2019

Документы на autosectionlabel мне не совсем понятны. Я думаю, что вы можете делать то, что вы хотите без абсолютной ссылки:

Heading 1
---------

subheading
^^^^^^^^^^

:ref:`relative/to/config/file:subheading`

Или, возможно:

:ref:`relative-to-config-file:subheading`

В противном случае вам придется использовать произвольные перекрестные ссылки .

Если вы поместите ярлык непосредственно перед заголовком раздела, вы можете сослаться на него с помощью: ref: label-name. Например:

.. _my-reference-label:

Section to cross-reference
--------------------------

This is the text of the section.

It refers to the section itself, see :ref:`my-reference-label`.
...