Generating Documentation - restful-api-description-language/RADL GitHub Wiki
Generating Documentation
In an XML environment, the simplest way to generate HTML documentation is to transform the .radl
file using the radl2html.xsl
stylesheet with an XSLT 2.0 processor. We test this stylesheet with Saxon HE 9.6, which is an open-source edition of Saxon.
The radl.core.documentation.DocumentationGenerator
class generates HTML documentation from RADL using radl2html.xsl
. This class supports the following arguments:
- The directory in which to generate the documentation
- An optional css URL to customize the style of the documentation
- One or more RADL files for which to generate documentation
The easiest way to generate documentation in your Continuous Integration build is using the RADL Gradle RADL Plugin or Maven RADL plugin.