2014-12-30 7 views
1

Я использую Sphinx для моей документации по проекту Python. Это полезно, потому что я могу экспортировать стандартную html-документацию и справку Microsoft (CHM) из того же источника rst. Тем не менее, я также хочу включить в наш проект проект помощи NumPy. Есть ли способ сделать это?Связать или объединить файлы CHM

Например, у меня есть документация для моего проекта в отдельных файлах .rst. Затем я использую sphinx для перевода этого текста в файл .chm для распространения на клиенты Windows. У меня также есть отдельный файл chm для документации NumPy. Каков наилучший способ сделать numpy chm доступным из документации моего собственного проекта?

Я бы предпочел иметь что-то в моей собственной таблице содержания, которая ссылается на numpy chm. Тем не менее, я соглашусь на какую-то гиперссылку, которую пользователи могут щелкнуть и открыть numpy chm в отдельном окне справки Microsoft, если это необходимо.

Возможно, есть лучшее решение, которое я даже не рассматривал?

+0

Лучший учебник я помню, вы найдете в http://kb.helpwaregroup.com/ms-html-help/merge. Требуется Windows-машина с Microsoft HTML Help Workshop для компиляции CHM. –

ответ

0

После решения могут удовлетворить ваши требования:

  1. Я собирал некоторые файлы HTML выборки в файл «CHM-Example-A.chm» с помощью инструмента Помощь авторинга.
  2. В конце соответствующего файла я добавил раздел, который содержит ссылку на документы NumPy (см. Ниже - отредактирован с помощью NodePad ++).
  3. CHM компилируется снова и полученное ТОС и содержание:

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 HTMLHelp Workshop (Freeware) или FAR HTML). Или попробуйте использовать свои собственные файлы проекта CHM.

Возможна жесткая кодировка Индекса (например, сделано для ТОС).

Связывание CHM является трудным и сломана обновлений безопасности: http://kb.helpwaregroup.com/ms-html-help/merge/notes

Связывание с PDF (например, NumPy) из проекта Python CHM может быть решением для вас. Смотрите пример проекта для скачивания: http://www.help-info.de/files_download/CHM-example_project.zip

enter image description here

Смежные вопросы