希腊字母可以作为词汇表术语添加到Sphinx文档中吗？

Question

我想在sphinx文档中为我的词汇表添加定义为希腊字母的变量。例如：

.. glossary::

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

目标是让这些变量出现在文档的索引中。有人有这方面的经验吗？

Answer 1

词汇表术语会自动添加到索引中。但这不适用于问题中的词汇表条目。 Sphinx发出此警告：WARNING: invalid single index entry ''（至少它对我有用）。这感觉就像一个错误。

以下是两种解决方法：

1. 使用替换

   |alpha|
      Description of alpha
   
   .. |alpha| replace:: :math:`{\alpha}`
   

   缺点是它会在索引中说“alpha”而不是“α”。

2. 使用实际的字母

   α
      Description of alpha
   

   此处α将是标题“符号”下的索引条目。