Как в Sphinx создать ссылочный раздел терминологии без огромных накладных расходов?

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

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

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

.. _flavor:

flavor
------
blah blah blah

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

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

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


python-sphinx restructuredtext glossary
person Ross Rogers    schedule 21.09.2010    source источник

Ответы (1)


arrow_upward
23
arrow_downward

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

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

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

:термин:

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

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

[вставлено из официальной документации sphinx]

person eolo999    schedule 29.09.2010
comment
Я предполагаю, что я должен был проконсультироваться с тезаурусом, чтобы найти другое слово для терминологии при поиске документов по сфинксу. Спасибо eolo999. - person Ross Rogers; 30.09.2010