Question

我正在使用Sphinx作为我的Python项目文档。这很有用，因为我可以从同一rst源导出标准html文档和Microsoft帮助（CHM）。但是，我想在我自己的项目中包含NumPy chm帮助。有没有办法做到这一点？

例如，我在单独的.rst文件中有我的项目文档。然后我使用sphinx将该文本转换为.chm文件，以便分发给Windows客户端。我还有一个单独的chm文件用于NumPy文档。从我自己的项目文档中获取numpy chm的最佳方法是什么？

我希望在我自己的目录中有一些链接到numpy chm的东西。但是，我会讨论某种超链接，用户可以根据需要在单独的Microsoft帮助窗口中单击并打开numpy chm。

也许我还没有考虑过更好的解决方案？

Answer 1

以下解决方案可能符合您的要求：

我使用帮助创作工具将一些HTML示例文件编译成'CHM-example-A.chm'文件。
在相应文件的末尾，我添加了一个包含NumPy文档链接的部分（参见下文 - 使用NodePad ++编辑）。
CHM再次编译并产生了TOC和内容：

enter image description here

在互联世界中，您可能希望直接链接到NumPy的网络，如上所示。但当然 - 导航窗格中没有目录（TOC）。此处仅添加主题节点，无法进行全文搜索。链接的NumPy Web内容显示在CHM Viewer内容窗格中。当然你可以在这里导航。

      <LI><OBJECT type="text/sitemap">
        <param name="Name" value="NumPy External Link">
      </OBJECT>
  <UL>
 <LI> <OBJECT type="text/sitemap">
    <param name="Name" value="Jump to NumPy documemts">
    <param name="Local" value="http://docs.scipy.org/doc/numpy-dev">
    <param name="ImageNumber" value="13">
    </OBJECT>
  </UL>

从以下链接下载HTML示例文件，并尝试编译并添加如上所示的节点以满足您的需求： http://www.help-info.de/files_download/chm_example_files.zip （有关Microsoft HTMLHelp Workshop（免费软件）或FAR HTML的第一步）。或者尝试使用自己的CHM项目文件。

可以使用硬编码的索引项（如针对TOC所做的那样）。

链接CHM很困难，并且受到安全更新的影响： http://kb.helpwaregroup.com/ms-html-help/merge/notes

从Python项目CHM链接到PDF（例如NumPy）可能是一个解决方案。请参阅示例Project for download from：http://www.help-info.de/files_download/CHM-example_project.zip

enter image description here

链接或合并CHM文件

1 个答案: