Spring/spring-grpc
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update docs README w/ steps on generating config props

Browse Source 
Signed-off-by: Chris Bono <chris.bono@gmail.com>
This commit is contained in:
Chris Bono
2025-02-21 13:09:51 -06:00
parent fbae1c9cb6
commit 581e841550
2 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
build-docs.sh Executable file
View File

@@ -0,0 +1,3 @@
#!/bin/bash
./mvnw -pl spring-grpc-docs process-resources antora -P docs

4
spring-grpc-docs/README.md
View File

@@ -8,13 +8,13 @@ The top level README and CONTRIBUTING guidleines documentation are generated fro
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.
1. This class is then used during the Maven `package` phase to generate an asciidoc page containing each of the configuration properties.
1. 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.
1. 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 antora
./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`.