在自动构建中生成文档

Question

在自动构建期间是否有任何方式生成项目文档？

我想有一组源文件（HTML？）与用户手册，并从中产生：

• PDF文档
• CHM帮助
• 的HTML版本帮助

所有三种格式的内容基本相同。

目前我使用msbuild和CCNET，但如果需要我可以更改。

Answer 1

是的！

• 使用SandCastle来构建API的CHM/HTM文档。
• 使用DocBook + FOP和其他工具，以产生其它类型的文档的PDF，RTF，HTML等...

它们可以很容易地通过CruiseControl.NET集成NAnt。

Answer 2

Apache Forrest项目可能会通过某种方式向您提供所需的内容。

通常情况下，您最好使用XML编写文档。从那里你应该能够产生任何你需要的东西。

Answer 3

你试过Doxygen？它也适用于Windows，应该很容易将它集成到任何构建脚本/过程中。

Answer 4

帮助和手册可以从单一来源生成高质量的PDF，HTML和CHM（以及其他格式）。它也有一个命令行界面。我有版本4，我很喜欢它。我使用条件（如#ifdefs）以各种格式生成我的文档的Windows和Mac版本，作为构建.bat/.csh文件的一部分。版本5现在可用。

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

Answer 5

如果你希望你的API的文档也和你正在使用的MSBuild，则可以考虑使用DocProject控制SandCastle构建。 （这些工具不适用于最终用户文档...）

Answer 6

我曾与Doxygen合作过。这很好，很容易，但是它会让你想要过度注册代码，以便于以后的文档工作。