2014-12-30 41 views
1

我爲我的Python項目文檔使用Sphinx。這很有用,因爲我可以從相同的rst源文件導出標準的html文檔和Microsoft幫助文件(CHM)。但是,我還想在我自己的項目中包含NumPy chm幫助。有沒有辦法做到這一點?鏈接或合併CHM文件

例如,我有我的項目在單獨的.rst文件中的文檔。然後,我使用sphinx將該文本轉換爲.chm文件以分發給Windows客戶端。我還爲NumPy文檔提供了一個單獨的chm文件。從我自己的項目文檔中獲得numpy chm的最佳方法是什麼?

我寧願在我自己的目錄中鏈接到numpy chm。不過,如果需要,我會解決某種超鏈接,用戶可以單擊它並在單獨的Microsoft幫助窗口中打開numpy chm。

也許有更好的解決方案,我甚至沒有考慮過?

+0

最好的教程中,我記得你會在http://kb.helpwaregroup.com/ms-html-help/merge找到。需要具有用於編譯CHM的Microsoft HTML Help Workshop的Windows計算機。 –

回答

0

以下解決方案可滿足您的要求:

  1. 我整理了一些HTML樣本文件爲「CHM-例如,A.chm」文件中使用幫助創作工具。
  2. 在相應文件的末尾,我添加了一個包含NumPy文檔鏈接的部分(參見下文 - 用NodePad ++編輯)。
  3. CHM再次編譯生成的TOC和內容:

enter image description here

在互聯世界中,你可能要像上面顯示直接鏈接到與NumPy的網頁。但是,當然 - 導航窗格中沒有目錄(TOC)。這裏只添加一個主題節點,不可能進行全文搜索。鏈接的NumPy網頁內容顯示在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 HTML幫助研討會(免費)或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

enter image description here