qt - Python-Sphinx：如何为 qthelp builder 填写关键字字段

Question

我正在使用 Sphinx 生成我的应用程序的文档，以便使用QtHelpEngine查看。因此，我正在使用qthelp构建器。

我不明白如何从用作源的 reStructuredText 正确创建 qhp 文件的关键字部分。

默认情况下 sphinx 创建一个空标签：

<keywords>

</keywords>

然后linksForIdentifier()andlinksForKeyword()返回一个空的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"/>