【问题标题】:Link or merge CHM files链接或合并 CHM 文件
【发布时间】:2015-02-27 00:39:42
【问题描述】:

我将Sphinx 用于我的 Python 项目文档。这很有用,因为我可以从同一 rst 源导出标准 html 文档和 Microsoft 帮助 (CHM)。但是,我还想在我自己的项目中包含NumPy chm 帮助。有没有办法做到这一点?

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

我希望在我自己的目录中包含一些链接到 numpy chm 的内容。但是,如果需要,我会选择某种超链接,用户可以单击该超链接并在单独的 Microsoft 帮助窗口中打开 numpy chm。

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

【问题讨论】:

标签: numpy python-sphinx chm


【解决方案1】:

以下解决方案可能满足您的要求:

  1. 我使用帮助创作工具将一些 HTML 示例文件编译成“CHM-example-A.chm”文件。
  2. 在相应文件的末尾,我添加了一个包含 NumPy 文档链接的部分(见下文 - 使用 NodePad++ 编辑,)。
  3. 再次编译 CHM 和生成的 TOC 和内容:

在互联世界中,您可能希望直接链接到 NumPy 的网络,如上所示。但当然 - 导航窗格中没有目录 (TOC)。这里只添加了一个主题节点,无法进行全文搜索。链接的 NumPy Web 内容显示在 CHM 查看器内容窗格中。当然你可以在这里导航。

      <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)可能是适合您的解决方案。请参阅示例项目以从以下位置下载:http://www.help-info.de/files_download/CHM-example_project.zip

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 2015-08-06
    • 1970-01-01
    • 1970-01-01
    • 2011-09-03
    • 1970-01-01
    • 2014-11-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多