root
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Actions 12 Packages Projects Releases Wiki Activity

Explain how to build the reference documentation

This commit is contained in:
Stephane Nicoll 2015-08-03 16:45:32 +02:00
parent fac04c1228
commit 4b58d753ab
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.adoc
View File

@ -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