Spring/spring-shell
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Generate aggregated API docs

Browse Source 
Fixes #145
This commit is contained in:
Eric Bottard
2017-08-29 17:44:27 +02:00
parent efd9e24100
commit 49850562c1
5 changed files with 100 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
pom.xml
View File

@@ -18,6 +18,8 @@
<jline.version>3.3.0</jline.version>
<assertj.version>3.8.0</assertj.version>
<java.version>1.8</java.version>
<jcommander.version>1.48</jcommander.version>
<shell1.version>1.2.0.RELEASE</shell1.version>
</properties>
<modules>
@@ -87,12 +89,24 @@
<version>${jline.version}</version>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>com.beust</groupId>
<artifactId>jcommander</artifactId>
<version>${jcommander.version}</version>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.assertj</groupId>
<artifactId>assertj-core</artifactId>
<version>${assertj.version}</version>
<scope>test</scope>
</dependency>
<!-- The following dependency is Spring Shell 1. Note the spring-shell artifactId is not used by Shell 2-->
<dependency>
<groupId>org.springframework.shell</groupId>
<artifactId>spring-shell</artifactId>
<version>${shell1.version}</version>
</dependency>
</dependencies>
</dependencyManagement>

82
spring-shell-docs/pom.xml
View File

@@ -19,8 +19,53 @@
<asciidoctorj.version>1.5.6</asciidoctorj.version>
<jruby.version>1.7.26</jruby.version>
</properties>
<!-- This project artificially depends on all others so that the javadoc plugin can consolidate everything.-->
<dependencies>
<dependency>
<groupId>org.springframework.shell</groupId>
<artifactId>spring-shell-core</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.springframework.shell</groupId>
<artifactId>spring-shell-standard</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.springframework.shell</groupId>
<artifactId>spring-shell-standard-commands</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.springframework.shell</groupId>
<artifactId>spring-shell-shell1-adapter</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.springframework.shell</groupId>
<artifactId>spring-shell</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.shell</groupId>
<artifactId>spring-shell-jcommander-adapter</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>com.beust</groupId>
<artifactId>jcommander</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.springframework.shell</groupId>
<artifactId>spring-shell-table</artifactId>
<scope>provided</scope>
</dependency>
</dependencies>
<build>
<plugins>
<!-- ASCIIDOC -->
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
@@ -87,6 +132,43 @@
</execution>
</executions>
</plugin>
<!-- API DOCS -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.0.0-M1</version>
<executions>
<execution>
<id>dependency-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
<phase>prepare-package</phase>
<configuration>
<includeDependencySources>true</includeDependencySources>
<dependencySourceIncludes>
<dependencySourceInclude>${project.groupId}:*</dependencySourceInclude>
</dependencySourceIncludes>
<dependencySourceExcludes>
<!-- Exclude Spring Shell 1 -->
<dependencySourceExclude>${project.groupId}:spring-shell</dependencySourceExclude>
</dependencySourceExcludes>
<quiet>true</quiet>
<attach>false</attach>
<links>
<link>
http://docs.spring.io/spring-framework/docs/current/javadoc-api/
</link>
<link>http://jcommander.org/apidocs/</link>
<link>https://docs.spring.io/spring-shell/docs/1.2.0.RELEASE/api/</link>
</links>
<doclint>-missing</doclint>
</configuration>
</execution>
</executions>
</plugin>
<!-- PACKAGE ASCIIDOC + API -->
<plugin>
<artifactId>maven-assembly-plugin</artifactId>
<version>3.1.0</version>

4
spring-shell-docs/src/assembly/docs-zip.xml
View File

@@ -21,5 +21,9 @@
<include>index.pdf</include>
</includes>
</fileSet>
<fileSet>
<directory>${project.build.directory}/apidocs</directory>
<outputDirectory>api</outputDirectory>
</fileSet>
</fileSets>
</assembly>

1
spring-shell-jcommander-adapter/pom.xml
View File

@@ -22,7 +22,6 @@
<dependency>
<groupId>com.beust</groupId>
<artifactId>jcommander</artifactId>
<version>1.48</version>
<optional>true</optional>
</dependency>
<dependency>

1
spring-shell-shell1-adapter/pom.xml
View File

@@ -24,7 +24,6 @@
<dependency>
<groupId>org.springframework.shell</groupId>
<artifactId>spring-shell</artifactId>
<version>1.2.0.RELEASE</version>
<optional>true</optional>
</dependency>
<dependency>