External-Mirrors/keycloak
2
0
Fork 0
mirror of https://github.com/keycloak/keycloak.git synced 2026-01-10 15:32:05 -03:30
Code Issues Packages Projects Releases Wiki Activity

Add build documentation for REST API and Javadoc

Browse Source 
Closes #42176

Signed-off-by: Andrés Maldonado <maldonado@codelutin.com>
Signed-off-by: Alexander Schwartz <alexander.schwartz@gmx.net>
Co-authored-by: Alexander Schwartz <alexander.schwartz@gmx.net>
This commit is contained in:
am97 2025-09-01 13:37:26 +02:00 committed by GitHub
parent 6f87b080b0
commit 0c91d106a2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/documentation/README.md
View File

@ -35,13 +35,29 @@ To build Keycloak Documentation run:
Or to build a specific guide run:
./mvnw clean install -pl docs/documentation/GUIDE_DIR -Pdocumentation
By default, an archive version of the documentation is built. To build the latest build run:
./mvnw clean install ... -Platest,documentation
You can then view the documentation by opening `docs/documentation/GUIDE_DIR/target/generated-docs/index.html`.
To build the REST API documentation and the Javadoc:
- Export the `JAVA_HOME` variable, for example:
```
export JAVA_HOME=/usr/lib/jvm/java-21-openjdk
```
(without this, you may get the following error: `Unable to find javadoc command: The environment variable JAVA_HOME is not correctly set.`)
- Run:
```
./mvnw clean package -am -pl services -Pjboss-release -DskipTests
```
You can view the generated docs by opening the following files:
- REST API: `services/target/apidocs-rest/output/index.html`
- Javadoc: `services/target/apidocs/index.html`
License
-------