Создание документов в автоматической сборке

Question

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

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

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

Контент был бы в основном одинаковым во всех трех форматах.

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

Answer 1

Да!

• Использование Замок из песка для создания документации CHM / HTM по API.
• Использование Документальная книга + ЩЕГОЛЬ и другие инструменты для создания других видов документации в формате PDF, RTF, HTML и т.д...

Их можно легко интегрировать с CruiseControl.ПОДКЛЮЧАЙТЕ через NAnt.

Answer 2

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

Answer 3

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

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

Answer 4

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

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

Answer 5

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

Answer 6

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