This module contains generators that create HTML files directly from Flink's source code.
The RestAPIDocGenerator
can be used to generate a full reference of the REST API of a RestServerEndpoint
. A separate file is generated for each endpoint.
To integrate a new endpoint into the generator
DocumentingRestEndpoint
class to RestAPIDocGenerator
that extends the new endpoint classcreateHtmlFile
in RestAPIDocGenerator#main
mvn package -Dgenerate-rest-docs -pl flink-docs -am -nsu -DskipTests
{{< generated/<file-name> }}
to the corresponding markdown file.The documentation must be regenerated whenever
RestServerEndpoint
MessageHeaders
class or any referenced RequestBody
, ResponseBody
, MessageParameters
or MessageParameter
class is modified.The ConfigOptionsDocGenerator
can be use to generate a reference of ConfigOptions
. By default, a separate file is generated for each *Options
class found in org.apache.flink.configuration
and org.apache.flink.yarn.configuration
. The @ConfigGroups
annotation can be used to generate multiple files from a single class.
To integrate an *Options
class from another package, add another module-package argument pair to ConfigOptionsDocGenerator#LOCATIONS
.
The files can be generated by running mvn package -Dgenerate-config-docs -pl flink-docs -am -nsu -DskipTests
, and can be integrated into the documentation using {{ include generated/<file-name> >}}
.
The documentation must be regenerated whenever
*Options
class was added or removedConfigOption
was added to or removed from an *Options
classConfigOption
was modified in any way.