From 4b58d753ab35aac665e46ac89efa6927f2f1e1e1 Mon Sep 17 00:00:00 2001 From: Stephane Nicoll Date: Mon, 3 Aug 2015 16:45:32 +0200 Subject: [PATCH] Explain how to build the reference documentation --- README.adoc | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.adoc b/README.adoc index 3ce9d928298..7f7d89e55a2 100755 --- a/README.adoc +++ b/README.adoc @@ -112,6 +112,24 @@ https://support.springsource.com/spring_committer_signup[Contributor's Agreement before your first change however trivial. (Or if you filed such an agreement already for another project just mention that in your pull request.)_ +=== Building reference documentation + +The reference documentation requires the documentation of the maven plugin to be +available so you need to build that first since it's not generated by default. + +[indent=0] +---- + $ mvn clean install -pl spring-boot-tools/spring-boot-maven-plugin -Pdefault,full +---- + +Once this is done, you can build the reference documentation with the command below: + +[indent=0] +---- + $ mvn clean install -pl spring-boot-docs -Pdefault,full +---- + +TIP: The generated documentation is available from `spring-boot-docs/target/contents/reference` == Modules