How do you write your DSL documentation?

(Fred Thiele) #1

I’m curious if there’s a convinient process to generate a DSL in a common way, so that a Gradle style DSL documentation results. How do you do this ATM?

(René Groeschke) #2

The gradle project currently uses a very custom approach to generate the DSL documentation.
In short:

1. we extract meta-data from the Groovy and Java source files which make up the Gradle API
2. Then we generate docbook xml out of this (see
3. We generate html from the docbook content.

You can have a look the the docs subproject in the gradle codebase for more details. see

hope that helps. You might also want to take a look at for automating your documentation workflow.


(Fred Thiele) #3

Thanks a lot, I’ll check this during the next days. Cheers!