Sphinx / reST не генерирует индекс для документации - PullRequest
2 голосов
/ 17 ноября 2011

Страница индекса всегда пуста, когда документ генерируется с помощью команды make html .Нужно ли что-нибудь для этого включить?

1 Ответ

2 голосов
/ 17 ноября 2011

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

Записи в индексе создаются автоматически из всей информации единицы (например, функции, классы или атрибуты). Явные записи вручную сделаны как:

.. index :: ‹ключевое слово 1›, ‹ключевое слово 2›, ...

.. index :: single: ‹keyword›; <Суб-ключевое слово>

.. index :: pair: ‹ключевое слово 1st part›; ‹Ключевое слово 2-я часть› первая две версии создают отдельные (под) записи, в то время как последняя версия создает две записи «‹ ключевое слово 1-я часть »; ‹Ключевое слово 2-я часть› »и «‹ Ключевое слово 2-я часть »; ‹Ключевое слово 1-я часть› ».

...