Генерация документов в автоматизированной сборке

Question

Есть ли способ генерировать документы проекта во время автоматизированных сборок?

Я хотел бы иметь один набор исходных файлов (HTML?) С руководством пользователя, и из них генерировать:

• PDF документ
• CHM help
• HTML-версия справки

Содержание будет в основном одинаковым во всех трех форматах.

В настоящее время я использую msbuild и CCNET, но я могу изменить это при необходимости.

Answer 1

Да!

• Используйте SandCastle для создания документации по API CHM / HTM.
• Используйте DocBook + FOP и другие инструменты для создания других видов документации в PDF, RTF, HTML и т. Д.

Их можно легко интегрировать с CruiseControl.NET через NAnt .

Answer 2

Вы пробовали doxygen ? Он также доступен для Windows, и его легко интегрировать в любой сценарий / процесс сборки.

Answer 3

Проект Apache Forrest может дать вам то, что вы хотите.

Как правило, вам лучше писать свою документацию в формате XML. Исходя из этого, вы должны иметь возможность генерировать все, что вам нужно.

Answer 4

Если вы также хотите, чтобы ваш API был задокументирован, и вы используете msbuild, тогда рассмотрите возможность использования DocProject для управления сборкой SandCastle . (Эти инструменты не предназначены для документации конечного пользователя ...)

Answer 5

Справка и руководство могут генерировать хорошее качество PDF, HTML и CHM (и других форматов) из одного источника. Он также имеет интерфейс командной строки. У меня есть версия 4, и мне это очень нравится. Я использую условные выражения (например, #ifdefs) для генерации версий моей документации для Windows и Mac в различных форматах как часть файла сборки .bat / .csh. Версия 5 теперь доступна.

http://www.ec -software.com /

Answer 6

У меня был опыт работы с Doxygen. Это приятно и просто, но заставляет вас хотеть комментировать код, чтобы облегчить последующую работу по документированию