improve documentation format
diff --git a/httpcore5-h2/pom.xml b/httpcore5-h2/pom.xml
index e5a5488..65f2134 100644
--- a/httpcore5-h2/pom.xml
+++ b/httpcore5-h2/pom.xml
@@ -23,7 +23,7 @@
individuals on behalf of the Apache Software Foundation. For more
information on the Apache Software Foundation, please see
<http://www.apache.org />.
- --><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+ --><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.apache.httpcomponents.core5</groupId>
@@ -33,8 +33,6 @@
<artifactId>httpcore5-h2</artifactId>
<name>Apache HttpComponents Core HTTP/2</name>
<description>Apache HttpComponents HTTP/2 Core Components</description>
- <url>https://hc.apache.org/httpcomponents-core-5.1.x/</url>
- <packaging>jar</packaging>
<properties>
<Automatic-Module-Name>org.apache.httpcomponents.core5.httpcore5.h2</Automatic-Module-Name>
@@ -86,6 +84,7 @@
<reportSets>
<reportSet>
<reports>
+ <report>index</report>
<report>dependencies</report>
<report>dependency-info</report>
<report>summary</report>
diff --git a/httpcore5-reactive/pom.xml b/httpcore5-reactive/pom.xml
index 6d234e3..d137739 100644
--- a/httpcore5-reactive/pom.xml
+++ b/httpcore5-reactive/pom.xml
@@ -34,8 +34,6 @@
<artifactId>httpcore5-reactive</artifactId>
<name>Apache HttpComponents Core Reactive Extensions</name>
<description>Apache HttpComponents Reactive Streams Bindings</description>
- <url>https://hc.apache.org/httpcomponents-core-5.1.x/</url>
- <packaging>jar</packaging>
<properties>
<Automatic-Module-Name>org.apache.httpcomponents.core5.httpcore5.reactive</Automatic-Module-Name>
@@ -73,6 +71,7 @@
<reportSets>
<reportSet>
<reports>
+ <report>index</report>
<report>dependencies</report>
<report>dependency-info</report>
<report>summary</report>
diff --git a/httpcore5-testing/pom.xml b/httpcore5-testing/pom.xml
index ad2e77e..143d3cb 100644
--- a/httpcore5-testing/pom.xml
+++ b/httpcore5-testing/pom.xml
@@ -23,7 +23,7 @@
individuals on behalf of the Apache Software Foundation. For more
information on the Apache Software Foundation, please see
<http://www.apache.org />.
- --><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+ --><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.apache.httpcomponents.core5</groupId>
@@ -33,8 +33,6 @@
<artifactId>httpcore5-testing</artifactId>
<name>Apache HttpComponents Core Integration Tests</name>
<description>Apache HttpComponents HTTP/2 and HTTP/1.1 core component integration tests</description>
- <url>https://hc.apache.org/httpcomponents-core-5.1.x/</url>
- <packaging>jar</packaging>
<properties>
<Automatic-Module-Name>org.apache.httpcomponents.core5.httpcore5.testing</Automatic-Module-Name>
@@ -168,6 +166,7 @@
<reportSets>
<reportSet>
<reports>
+ <report>index</report>
<report>dependencies</report>
<report>dependency-info</report>
<report>summary</report>
diff --git a/httpcore5/pom.xml b/httpcore5/pom.xml
index c9ffdf5..b7e9bfc 100644
--- a/httpcore5/pom.xml
+++ b/httpcore5/pom.xml
@@ -23,7 +23,7 @@
individuals on behalf of the Apache Software Foundation. For more
information on the Apache Software Foundation, please see
<http://www.apache.org />.
- --><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+ --><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.apache.httpcomponents.core5</groupId>
@@ -34,8 +34,6 @@
<name>Apache HttpComponents Core HTTP/1.1</name>
<inceptionYear>2005</inceptionYear>
<description>Apache HttpComponents HTTP/1.1 core components</description>
- <url>https://hc.apache.org/httpcomponents-core-5.1.x/</url>
- <packaging>jar</packaging>
<properties>
<Automatic-Module-Name>org.apache.httpcomponents.core5.httpcore5</Automatic-Module-Name>
@@ -102,6 +100,7 @@
<reportSets>
<reportSet>
<reports>
+ <report>index</report>
<report>dependencies</report>
<report>dependency-info</report>
<report>summary</report>
diff --git a/pom.xml b/pom.xml
index 8659e0f..66133d2 100644
--- a/pom.xml
+++ b/pom.xml
@@ -23,7 +23,7 @@
individuals on behalf of the Apache Software Foundation. For more
information on the Apache Software Foundation, please see
<http://www.apache.org />.
- --><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+ --><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpcomponents-parent</artifactId>
@@ -221,11 +221,31 @@
<link>${project.url}/httpcore5/apidocs/</link>
<link>${project.url}/httpcore5-h2/apidocs/</link>
</links>
+ <notimestamp>true</notimestamp>
+ <groups>
+ <group>
+ <title>Apache HttpCore HTTP/1.1</title>
+ <packages>org.apache.hc.core5*</packages>
+ </group>
+ <group>
+ <title>Apache HttpCore HTTP/2</title>
+ <packages>org.apache.hc.core5.http2*</packages>
+ </group>
+ <group>
+ <title>Apache HttpCore Reactive Streams Bindings</title>
+ <packages>org.apache.hc.core5.reactive*</packages>
+ </group>
+ <group>
+ <title>Apache HttpCore Testing</title>
+ <packages>org.apache.hc.core5.testing*:org.apache.hc.core5.benchmark*</packages>
+ </group>
+ </groups>
</configuration>
<reportSets>
<reportSet>
<reports>
<report>javadoc</report>
+ <report>aggregate</report>
</reports>
</reportSet>
</reportSets>
diff --git a/src/site/resources/css/site.css b/src/site/resources/css/site.css
new file mode 100644
index 0000000..d233cf1
--- /dev/null
+++ b/src/site/resources/css/site.css
@@ -0,0 +1,20 @@
+/*
+ * 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.
+ */
+ @import url("/css/hc-maven.css");
+
\ No newline at end of file
diff --git a/src/site/site.xml b/src/site/site.xml
new file mode 100644
index 0000000..13022a9
--- /dev/null
+++ b/src/site/site.xml
@@ -0,0 +1,88 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!--
+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.
+-->
+
+<project xmlns="http://maven.apache.org/DECORATION/1.6.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/DECORATION/1.6.0 http://maven.apache.org/xsd/decoration-1.6.0.xsd"
+ name="Apache HttpCore">
+
+ <!-- N.B. all non-body elements are automatically inherited -->
+
+ <skin>
+ <groupId>org.apache.httpcomponents</groupId>
+ <artifactId>maven-site-skin</artifactId>
+ <version>1.1</version>
+ </skin>
+ <!--skin>
+ <groupId>org.apache.maven.skins</groupId>
+ <artifactId>maven-fluido-skin</artifactId>
+ <version>1.9</version>
+ </skin-->
+
+ <bannerLeft>
+ <name>Apache</name>
+ <src>http://www.apache.org/images/asf_logo_wide.gif</src>
+ <href>http://www.apache.org/</href>
+ </bannerLeft>
+
+ <bannerRight>
+ <name>HttpComponents</name>
+ <src>http://hc.apache.org/images/logos/httpcomponents.png</src>
+ <href>http://hc.apache.org/</href>
+ </bannerRight>
+
+ <body>
+ <!-- N.B. body links are automatically inherited -->
+ <links>
+ <item name="Apache" href="http://www.apache.org/"/>
+ <item name="HttpComponents" href="http://hc.apache.org/index.html"/>
+ </links>
+
+ <!-- inherited -->
+ <menu ref="parent" inherit="bottom"/>
+ <menu ref="modules" inherit="bottom"/>
+ <menu ref="reports" inherit="bottom"/>
+
+ <menu name="ASF" inherit="bottom">
+ <item name="ASF Home Page" href="http://www.apache.org"/>
+ <item name="Foundation" href="http://www.apache.org/foundation/"/>
+ <item name="Sponsor Apache" href="http://www.apache.org/foundation/sponsorship.html"/>
+ <item name="Thanks" href="http://www.apache.org/foundation/thanks.html"/>
+ </menu>
+ </body>
+
+ <!-- inherited -->
+ <poweredBy>
+ <!-- Add ApacheCon logo -->
+ <logo name="ApacheCon" href="http://www.apache.org/events/current-event.html"
+ img="http://www.apache.org/events/current-event-125x125.png"/>
+ <!-- Keep the default logo as well -->
+ <logo name="Maven" href="http://maven.apache.org/"
+ img="http://maven.apache.org/images/logos/maven-feather.png"/>
+ </poweredBy>
+
+ <!-- inherited -->
+ <custom>
+ <footer>
+ <div class="xleft">Apache HttpComponents, Commons HttpClient, Apache, the Apache feather logo, and the Apache HttpComponents project logo are trademarks of The Apache Software Foundation.</div>
+ <br/>
+ <div class="xleft">All other marks mentioned may be trademarks or registered trademarks of their respective owners.</div>
+ </footer>
+ </custom>
+</project>
