Build WebSite JavaDoc on default and update links

This commit is contained in:
Martyn Taylor 2015-03-09 15:13:20 +00:00
parent 8af60b10ab
commit 140d06a49a
5 changed files with 77 additions and 56 deletions

View File

@ -66,45 +66,50 @@
<webapp-outdir>${basedir}/target/classes/user-manual</webapp-outdir>
</properties>
<build>
<plugins>
<plugin>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.10.1</version>
<executions>
<execution>
<id>javadoc-jar</id>
<phase>package</phase>
<goals>
<goal>jar</goal>
</goals>
<configuration>
<useStandardDocletOptions>true</useStandardDocletOptions>
<minmemory>128m</minmemory>
<maxmemory>512m</maxmemory>
<quiet>false</quiet>
<!-- switch on dependency-driven aggregation -->
<includeDependencySources>true</includeDependencySources>
<dependencySourceIncludes>
<!-- include ONLY dependencies I control -->
<dependencySourceInclude>org.apache.activemq:activemq-core-client</dependencySourceInclude>
<dependencySourceInclude>org.apache.activemq:activemq-jms-client</dependencySourceInclude>
<dependencySourceInclude>org.apache.activemq:activemq-server</dependencySourceInclude>
<dependencySourceInclude>org.apache.activemq:activemq-jms-server</dependencySourceInclude>
<dependencySourceInclude>org.apache.activemq:activemq-journal</dependencySourceInclude>
<dependencySourceInclude>org.apache.activemq:activemq-selector</dependencySourceInclude>
</dependencySourceIncludes>
<quiet>false</quiet>
<aggregate>true</aggregate>
<excludePackageNames>org.apache.activemq.core:org.apache.activemq.utils</excludePackageNames>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
<profiles>
<profile>
<id>release</id>
<build>
<plugins>
<plugin>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.10.1</version>
<executions>
<execution>
<id>javadoc-jar</id>
<phase>package</phase>
<goals>
<goal>jar</goal>
</goals>
<configuration>
<useStandardDocletOptions>true</useStandardDocletOptions>
<minmemory>128m</minmemory>
<maxmemory>512m</maxmemory>
<quiet>false</quiet>
<!-- switch on dependency-driven aggregation -->
<includeDependencySources>true</includeDependencySources>
<dependencySourceIncludes>
<!-- include ONLY dependencies I control -->
<dependencySourceInclude>org.apache.activemq:activemq-core-client</dependencySourceInclude>
<dependencySourceInclude>org.apache.activemq:activemq-jms-client</dependencySourceInclude>
<dependencySourceInclude>org.apache.activemq:activemq-server</dependencySourceInclude>
<dependencySourceInclude>org.apache.activemq:activemq-jms-server</dependencySourceInclude>
<dependencySourceInclude>org.apache.activemq:activemq-journal</dependencySourceInclude>
<dependencySourceInclude>org.apache.activemq:activemq-selector</dependencySourceInclude>
</dependencySourceIncludes>
<quiet>false</quiet>
<aggregate>true</aggregate>
<excludePackageNames>org.apache.activemq.core:org.apache.activemq.utils</excludePackageNames>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<artifactId>maven-antrun-plugin</artifactId>
<version>1.6</version>
@ -113,9 +118,9 @@
<phase>generate-sources</phase>
<configuration>
<target>
<condition property="gitbook.cmd" value="gitbook.cmd" else="gitbook">
<os family="windows" />
</condition>
<condition property="gitbook.cmd" value="gitbook.cmd" else="gitbook">
<os family="windows" />
</condition>
<!-- lets generate the gitbook -->
<mkdir dir="${webapp-outdir}/gitbook" />
<echo>executing ${gitbook.cmd}</echo>

View File

@ -18,7 +18,7 @@ under the License.
-->
<h1>Apache ActiveMQ Examples</h1>
<h2>JMS Examples</h2>
<p>Apache ActiveMQ comes with over 90 runnable examples. These can be found in the examples directory in the root of the
distribution folder. There are examples covering JMS as well as all the protocols and functionality that Apache ActiveMQ
supports.</p>
@ -37,4 +37,4 @@ to run a different example simply edit the <code>config/examples/bootstrap.xml</
the correct configuration (this will be found in the directory of the example you wish to run). By default the broker
will use the <code>data/server0</code> directory for the journal, to avoid problems it is best to delete this
directory between running different examples or set the <code>ACTIVEMQ_DATA_DIR</code> environment property in
<code>activemq.conf</code>to use a different location</p>
<code>activemq.conf</code>to use a different location</p>

View File

@ -53,6 +53,7 @@
<li><a target="_blank" href="api/index.html">API</a></li>
<li><a target="_blank" href="user-manual/index.html">User Manual</a></li>
<li><a href="examples/index.html">Examples</a></li>
<li><a href="http://activemq.apache.org/activemq6">Apache ActiveMQ-6 Website</a></li>
</ul>
<div></div>
</div>

View File

@ -0,0 +1,26 @@
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<h1>User Manual</h1>
<p>If you are seeing this message, it is because the User Manual was not built during the Apache ActiveMQ-6 build. To
build Apache ActiveMQ-6 with the User Manual you must use the maven release profile:
<code>mvn clean install -Prelease</code>.</p>
<p>Please see the README in the source distribution for more information.</p>

View File

@ -166,25 +166,14 @@
<groupId>commons-logging</groupId>
<artifactId>commons-logging</artifactId>
</dependency>
<dependency>
<groupId>org.apache.activemq</groupId>
<artifactId>activemq-website</artifactId>
<version>${project.version}</version>
<classifier>javadoc</classifier>
</dependency>
</dependencies>
<profiles>
<profile>
<id>release</id>
<dependencies>
<!-- javadoc -->
<dependency>
<groupId>org.apache.activemq</groupId>
<artifactId>activemq-website</artifactId>
<version>${project.version}</version>
<classifier>javadoc</classifier>
</dependency>
</dependencies>
<build>
</build>
</profile>
</profiles>
<build>
<resources>
<resource>