Search code examples
build-processbuild-automationdocumentation

Generate docs in automated build


Is there any way to generate project docs during automated builds?

I'd like to have a single set of source files (HTML?) with the user manual, and from them generate:

  • PDF document
  • CHM help
  • HTML version of the help

The content would be basically the same in all three formats.

Currently I'm using msbuild and CCNET, but I could change that if needed.


Solution

  • Yes!

    • Use SandCastle to build CHM/HTM documentation of the APIs.
    • Use DocBook + FOP and other tools to produce other kinds of documentation in PDF, RTF, HTML etc...

    They can be easily integrated with CruiseControl.NET through NAnt.