Files
spring-grpc/spring-grpc-docs
Dave Syer a3d7ba643d Split bean registration and creation for stubs
GrpcClientRegistry was responsible for both, which causes lifecycle
issues when users don't follow recommendations. This change
pushes the bean registration firmly down a level into an
ImportBeanDefinitionRegistrar. Also helps with AOT because the AOT
processor only runs the IBDR at build time.
2025-04-03 12:09:23 +01:00
..
2024-10-22 11:17:53 +01:00
2025-03-10 10:25:10 +00:00
2025-03-24 08:31:38 +00:00

Spring gRPC Docs

README

The top level README and CONTRIBUTING guidelines documentation are generated from sources in this module on mvn package using asciidoctor-reducer and downdoc.

Configuration Properties

The Spring gRPC configuration properties are automatically documented as follows:

  1. This module contains a Java class (org.springframework.grpc.internal.ConfigurationPropertiesAsciidocGenerator) that is compiled when the module is built.
  2. This class is then used during the Maven process-resources phase in the docs profile to generate an asciidoc page containing each of the configuration properties.
  3. The asciidoc is then included in the Antora reference documentation.

Antora Site

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.