python-sphinx - 可以将希腊字母作为词汇表添加到 Sphinx 文档中吗？

Question

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

.. glossary::

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

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

Answer 1

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

这里有两个解决方法：

1. 使用替代品

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

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

2. 使用实际的字母

   α
      Description of alpha
   

   这里 α 将是索引中“符号”标题下的条目。