How can I write documentation with Gradle for my own project?


(Oscar Vargas Torres) #1

Gradle documentation itself is built by Gradle, How can I write documentation with Gradle for my own project?


(Peter Niederwieser) #2

You can use the ‘Javadoc’ task to generate Javadoc. Beyond that, Gradle doesn’t currently ship with tasks or plugins to generate documentation. We do want to offer this eventually, in particular for documenting third-party Gradle tasks and plugins.


(Tom Sheehan) #3

You might consider using DocBook. I’m looking forward to trying the following myself.

See: https://github.com/SpringSource/spring-build-gradle/blob/master/docs.gradle

For a sample task: http://stackoverflow.com/questions/8274521/generate-pdf-from-docbook-xml-when-building-java-project-using-gradle

Good luck Tom