Как установить значение конфигурации расширения в Sphinx

Question

Я пытаюсь использовать значение конфигурации autosectionlabel_prefix_document в расширении autosectionlabel, описанном здесь . Я загрузил расширение в conf.py, и оно отлично работает. В настоящее время я попытался добавить строку:

autosectionlabel_prefix_document = True

до conf.py, но выдает сообщение об ошибке:

WARNING: undefined label: shaders:force shaders
(if the link has no caption the label must precede a section header)

Что-то мне не хватает для настройки расширений? Документация будет размещена на ReadTheDocs, поэтому я не могу контролировать сами расширения, и в любом случае кажется, что делать это неаккуратно.

Просто чтобы убедиться, что у меня отключен синтаксис на случай, если это проблема, я использую

:ref:`shaders:force shaders`

, которая должна создавать ссылку с именем force shaders на подзаголовок force shaders в документе shaders.rst.

Соответствующие версии:
Python 2.7
Сфинкс 1.7.5
PyCharm 2018.1.4

Answer 1

Если shaders.rst не находится в корневом каталоге, вам следует добавить префикс имени файла к пути из корневого каталога. Например, если у вас есть следующий макет:

index.rst
/xdir
    main.rst
/ydir
    /zdir
        shaders.rst

Тогда вы можете ссылаться на заголовок Force Shaders, расположенный в shaders.rst из main.rst, как :ref:`ydir/zdir/shaders:force shaders`. (У меня работает с sphinx-1.7.5.)