Я хочу добавить переменные, которые обозначены как греческие буквы в моем глоссарии в документе сфинкса. Например:Могут ли греческие буквы быть добавлены к документам Сфинкса в качестве терминов глоссария?
.. glossary::
:math:`{\alpha}`
Definition for alpha
Цель состоит в том, чтобы эти переменные отображались в индексе документа. У кого-нибудь есть опыт с этим?
Термины глоссария автоматически добавляются в индекс. Но это не работает для ввода глоссария в вопросе. Sphinx испускает это предупреждение: WARNING: invalid single index entry '' (по крайней мере, это для меня). Это похоже на ошибку.
Вот два обходных:
Используйте замену
|alpha|
Description of alpha
.. |alpha| replace:: :math:`{\alpha}`
Недостатком является то, что он будет говорить «альфа» в индексе вместо «альфа».
Используйте фактическое альфа письмо
α
Description of alpha
Здесь α будет запись в индексе под заголовком «Символы».
Спасибо за вашу помощь! Я собираюсь использовать второй вариант, потому что он будет использовать символ в индексе. –
Синтаксис не был для меня проблемой, но я обновил этот пример, чтобы устранить путаницу. Я хотел бы иметь возможность определять термины глоссария, которые являются греческими буквами. –
Это поможет, если вы объясните, что представляет собой настоящая проблема. – mzjn
Несомненно. В приведенном выше примере греческое письмо будет добавлено в документ с определением. Однако греческая буква (в данном случае альфа) не будет отображаться в глоссарии как термин. –