Python-Sphinx: как заполнить поля ключевых слов для сборщика qthelp

Question

Я использую Sphinx для генерации документации моего приложения, которую можно просмотреть с помощью QtHelpEngine. Поэтому я использую конструктор qthelp.

Я не понимаю, как правильно создать раздел ключевых слов файла qhp из reStructuredText, используемого в качестве источника.

По умолчанию sphinx создает пустой тег:

<keywords>

</keywords>

а затем linksForIdentifier() а также linksForKeyword() вернуть пустое QMap,

Answer 1

Sphinx заполняет ключевые слова тем же контентом, который он использует в индексе проекта документации. Вы найдете обзор того, как создать разметку, генерирующую индекс, здесь в документации по Sphinx (предположение Steve Piercy верно).

Например, если у нас есть файл this/is/an/example.rst, который содержит эту директиву домена Python:

.. py:function:: lorem(ispsum)

   Lorems the provided ipsum.

наш keywords тег в .qhp Файл содержит следующее ключевое слово:

<keyword name="lorem() (built-in function)" ref="this/is/an/example.html#lorem"/>

Пример явно созданной записи индекса:

.. index::
   single: lorem

, который создает следующее ключевое слово (давайте снова предположим, что файл this/is/an/example.rst):

<keyword name="lorem" ref="this/is/an/example.html#index-0"/>