Можно ли добавлять греческие буквы в документы Sphinx в качестве терминов глоссария?

Question

Можно ли добавлять греческие буквы в документы Sphinx в качестве терминов глоссария?

Я хочу добавить переменные, которые определены как греческие буквы к моему глоссарию в документе сфинкса. Например:

.. glossary::

    :math:`{\alpha}`
        Definition for alpha

Цель состоит в том, чтобы эти переменные появились в индексе документа. Кто-нибудь имеет опыт работы с этим?

2

python-sphinx restructuredtext

Источник

user6499894 29 ноя '16 в 01:37

1 ответ

Решение

Другие вопросы по тегам python-sphinx restructuredtext

user407651 01 дек '16 в 12:30 2016-12-01 12:30 · Accepted Answer · 2016-12-01 12:30

Термины словаря автоматически добавляются в указатель. Но это не работает для глоссария в вопросе. Сфинкс выдает это предупреждение: WARNING: invalid single index entry '' (по крайней мере, это для меня). Это похоже на ошибку.

Вот два обходных пути:

Используйте замену
```
|alpha|
   Description of alpha

.. |alpha| replace:: :math:`{\alpha}`
```
Недостатком является то, что он будет говорить "альфа" в индексе вместо "α".
Используйте фактическую альфа-букву
```
α
   Description of alpha
```
Здесь α будет входить в индекс под заголовком "Символы".