В SPHINX, как я могу создать соединительную «терминологию» раздел без массивных накладных расходов?

Question

Я хочу создать раздел «терминологию» с определениями для терминов, которые я использую так, чтобы каждый раз, когда каждый раз, когда я использую термины в этой серии терминология, создается ссылка, которая указывает на определение.

В настоящее время лучшее, что я могу придумать:

.. |flavor| replace:: `:ref:flavor`

.. _flavor:

flavor
------
blah blah blah

Потом позже, в другом тексте я должен сделать:

''' This is a usage of the word |flavor|.'''

Я нахожу вышеупомянутый синтаксис, чтобы быть очень громоздким. Я знаю, что я мог бы использовать еще один слой сценариев или M4 для автоматического генерации этого синтаксиса, но я надеюсь, что есть лучший способ ..

Answer 1

Не так разные, но вы можете использовать:

.. Глоссарий ::

Эта директива должна содержать список определений отдыха с терминами и определениями. Затем определения будут ссылаться на «термин» роль.

:срок:

Ссылка на термин в глоссарии. Глоссарий создан с использованием глоссажной директивы, содержащей список определений с терминами и определениями. Он не должен быть в том же файле, что и термин разметки, например, документы Python имеют один глобальный глоссарий в файле Glossary.rst.

Если вы используете термин, который не объясняется в глоссарии, вы получите предупреждение во время сборки.

вставлен из Официальная документация сфинкса