From 463bfead384141356128ae7d36f2533ffaa34975 Mon Sep 17 00:00:00 2001 From: Dan Allen Date: Fri, 16 Sep 2022 16:52:47 -0600 Subject: [PATCH] add information to README describing how to build the reference docs --- README.adoc | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.adoc b/README.adoc index 272b99ff6d..4261c0f24b 100644 --- a/README.adoc +++ b/README.adoc @@ -52,6 +52,16 @@ git clone git@github.com:spring-projects/spring-security.git ./gradlew build ---- +The reference docs are not currently included in the distribution zip. +You can build the reference docs for this branch by running the following command: + +---- +./gradlew :spring-security-docs:antora +---- + +That command publishes the docs site to the _docs/build/site_ directory. +The https://github.com/spring-projects/spring-security/tree/docs-build[playbook branch] describes how to build the reference docs in detail. + Discover more commands with `./gradlew tasks`. See also the https://github.com/spring-projects/spring-framework/wiki/Gradle-build-and-release-FAQ[Gradle build and release FAQ].