Sphinx / reST没有为文档生成索引

时间:2011-11-17 04:26:42

标签: python-sphinx restructuredtext

使用 make html 命令生成文档时,索引页面始终为空。我是否需要为此启用任何功能?

1 个答案:

答案 0 :(得分:2)

来自http://people.ee.ethz.ch/~creller/web/tricks/reST.html#sphinx-directives

  

索引中的条目是从所有信息自动创建的   单位(如函数,类或属性)。明确的手工条目   制作成:

     

.. index :: ,...

     

.. index :: single:; <子关键字>

     

.. index :: pair:; <关键字第二部分>第一部分   两个版本创建单个(子)条目,而最后一个版本   创建两个条目“; <关键字第二部分>“和   “<关键字第二部分>; “。