Generar los documentos de construcción automatizada

Question

Es allí cualquier manera de generar proyecto docs durante automatizado construye?

Me gustaría tener un único conjunto de archivos de código fuente (HTML?) con el manual de usuario, y a partir de ellos generar:

• Documento PDF
• Ayuda CHM
• Versión HTML de la ayuda

El contenido sería básicamente el mismo en los tres formatos.

Actualmente estoy usando msbuild y CCNET, pero yo podría cambiar si es necesario.

Answer 1

Sí!

• Uso Castillos de arena para construir CHM/HTM documentación de la Api.
• Uso DocBook + FOP y otras herramientas para producir otros tipos de documentación en PDF, RTF, HTML, etc...

Ellos pueden ser fácilmente integrado con CruiseControl.NET a través de NAnt.

Answer 2

Intenta doxygen?Está disponible para Windows y también debe ser fácil de integrar en cualquier script de compilación/proceso.

Answer 3

El Apache Forrest proyecto podría de alguna manera para darle lo que usted desea.

Usted será generalmente mejor de la escritura de su documentación en XML.Desde que usted debería ser capaz de generar casi cualquier cosa que usted necesita.

Answer 4

Ayuda y Manual puede generar buena calidad, PDF, HTML y CHM (y otros formatos) a partir de una sola fuente.También tiene una interfaz de línea de comandos.Tengo la version 4 y me gusta mucho.Yo uso condicionales (como #ifdefs) para generar versiones para Windows y Mac de mi documentación en varios formatos, como parte de una generación .bat/.csh archivo.La versión 5 ya está disponible.

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

Answer 5

Si usted quiere que su api documentada también, y usted está utilizando msbuild, a continuación, considere el uso de DocProject para el control de la Castillos de arena construir.(Estas herramientas no son para la documentación de usuario final...)

Answer 6

He tenido una experiencia con Doxygen.Es agradable y fácil, pero se hace querer overcommenting el código a la facilidad más adelante documetation trabajo.