如何从一个Sphinx文件link转换成一个CHM文件？

Question

如何从 Sphinx 文件 link 转换为 CHM 文件？

看来我可以 link 从一个 chm 文件到另一个使用像

这样的语法

<a href="ms-its:path+filename.chm::/pagename.htm">

是否可以将其转换为 Sphinx 命令？

Answer 1

您知道，通过在 HTML 文件中添加以下代码，只能使用 Microsoft Internet Explorer (!) 打开编译成 CHM 的主题：

<p>Sample of CHM link to a topic in a compiled help file that is stored on a local computer</p>
<!-- To link to a topic in a compiled help file that is stored on a local computer, create a link using the following syntax:  -->
<A HREF="ms-its:D:\UserData-Sphinx\CHM-example.chm::/garden/garden.htm">Link to Garden topic here</a>

我认为，reStructuredText 解析器无法从源 (reST) 传输这些特殊类型的 link。

但是您可以使用如下所示的 Replacement Text。请注意，反斜杠使用了两次：

================
Replacement Text
================

I recommend you try |HTMLHelp|_ and continue compiling help in CHM file format.

.. |HTMLHelp| replace:: CHM, *the* best help format around
.. _HTMLHelp: ms-its:D:\UserData-Sphinx\CHM-example.chm::/garden/garden.htm

"replace" 指令用于指示替换引用的替换文本。它只能在替换定义中使用。

生成的HTML文件视图：

编译帮助CHM:

单击 link 后，主题 garden.htm 显示在帮助查看器的主题窗格中：

您可以从我的HTML帮助 (HH) 信息站点 see download section or download CHM.

下载上面使用的 CHM-example.chm 文件

请注意，要打开此 CHM 文件，请右键单击保存的文件，单击“属性”，然后单击“取消阻止”。

如何从一个Sphinx文件link转换成一个CHM文件？

How to link from a Sphinx document into a CHM file?

python-sphinx

chm