如何从sphinx文档链接到chm文件？

Question

如何从sphinx文档链接到chm文件？

似乎我可以使用类似

的语法从一个chm文件链接到另一个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）传输这些特殊类型的链接。

但您可以使用如下所示的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：

点击链接后，主题garden.htm会显示在帮助查看器的主题窗格中

您可以从我的HTMLHelp（HH）信息网站see download section下载以上使用的CHM-example.chm文件，或下载CHM。

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