Skip to content

Commit 463bfea

Browse files
mojavelinuxrwinch
authored andcommitted
add information to README describing how to build the reference docs
1 parent 38d8b21 commit 463bfea

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.adoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,16 @@ git clone [email protected]:spring-projects/spring-security.git
5252
./gradlew build
5353
----
5454

55+
The reference docs are not currently included in the distribution zip.
56+
You can build the reference docs for this branch by running the following command:
57+
58+
----
59+
./gradlew :spring-security-docs:antora
60+
----
61+
62+
That command publishes the docs site to the _docs/build/site_ directory.
63+
The https://github.com/spring-projects/spring-security/tree/docs-build[playbook branch] describes how to build the reference docs in detail.
64+
5565
Discover more commands with `./gradlew tasks`.
5666
See also the https://github.com/spring-projects/spring-framework/wiki/Gradle-build-and-release-FAQ[Gradle build and release FAQ].
5767

0 commit comments

Comments
 (0)