Polish Gradle plugin's documentation

This commit is contained in:
Andy Wilkinson 2017-04-05 12:24:35 +01:00
parent 2de7e9c310
commit 5bc721f3ad
2 changed files with 7 additions and 2 deletions

View File

@ -175,7 +175,11 @@
<target>
<zip destfile="${project.build.directory}/${project.artifactId}-${project.version}-docs.zip">
<zipfileset src="build/libs/${project.artifactId}-${project.version}-javadoc.jar" prefix="api" />
<zipfileset dir="${project.build.directory}/generated-docs" prefix="reference" />
<zipfileset dir="${project.build.directory}/generated-docs" includes="index.html" prefix="reference/html" />
<mappedresources>
<fileset dir="${project.build.directory}/generated-docs" includes="index.pdf" />
<globmapper from="index.pdf" to="reference/pdf/spring-boot-gradle-plugin-reference.pdf"/>
</mappedresources>
</zip>
</target>
</configuration>
@ -209,6 +213,7 @@
</execution>
</executions>
<configuration>
<sourceDocumentName>index.adoc</sourceDocumentName>
<attributes>
<version-type>${version-type}</version-type>
<version>${project.version}</version>

View File

@ -19,7 +19,7 @@ Andy Wilkinson
:maven-publish-plugin: {gradle-userguide}/maven_publish_plugin.html
:software-component: {gradle-userguide}/software_model_extend.html
:kotlin-plugin: https://kotlinlang.org/docs/reference/using-gradle.html
:spring-boot-docs: https://docs.spring.io/spring-boot/{version}
:spring-boot-docs: https://docs.spring.io/spring-boot/docs/{version}
:api-documentation: {spring-boot-docs}/gradle-plugin/api
:spring-boot-reference: {spring-boot-docs}/reference/htmlsingle
:build-info-javadoc: {api-documentation}/org/springframework/boot/gradle/tasks/buildinfo/BuildInfo.html