The top level README and CONTRIBUTING guidelines documentation are generated from sources in this module on mvn package using asciidoctor-reducer and downdoc.
The Spring gRPC configuration properties are automatically documented as follows:
- This module contains a Java class (
org.springframework.grpc.internal.ConfigurationPropertiesAsciidocGenerator) that is compiled when the module is built. - This class is then used during the Maven
process-resourcesphase in thedocsprofile to generate an asciidoc page containing each of the configuration properties. - The asciidoc is then included in the Antora reference documentation.
To build the Antora site locally run the following command from the project root directory:
./mvnw -pl spring-grpc-docs process-resources antora -P docs
You can then view the output by opening spring-grpc-docs/target/antora/site/index.html.