You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ah...@apache.org on 2022/10/24 22:05:00 UTC

[commons-rng] 02/03: Add site configuration for docs-archive

This is an automated email from the ASF dual-hosted git repository.

aherbert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-rng.git

commit d7ba447bc23ef7dc95530ba2deced394aafd1c9e
Author: Alex Herbert <ah...@apache.org>
AuthorDate: Mon Oct 24 22:43:38 2022 +0100

    Add site configuration for docs-archive
    
    Allows the site to be built with aggregate javadoc and jacoco reports in
    a docs module.
---
 docs-archive/pom.xml                 |  1 +
 docs-archive/src/site/site.xml       | 34 ++++++++++++++++++++++++++++++
 docs-archive/src/site/xdoc/index.xml | 41 ++++++++++++++++++++++++++++++++++++
 3 files changed, 76 insertions(+)

diff --git a/docs-archive/pom.xml b/docs-archive/pom.xml
index d8c7c55a..7bd998f5 100644
--- a/docs-archive/pom.xml
+++ b/docs-archive/pom.xml
@@ -39,6 +39,7 @@
     <maven.deploy.skip>true</maven.deploy.skip>
     <!-- Simple site -->
     <pmd.skip>true</pmd.skip>
+    <cpd.skip>true</cpd.skip>
     <spotbugs.skip>true</spotbugs.skip>
     <checkstyle.skip>true</checkstyle.skip>
     <changes.jira.skip>true</changes.jira.skip>
diff --git a/docs-archive/src/site/site.xml b/docs-archive/src/site/site.xml
new file mode 100644
index 00000000..d2c68ff4
--- /dev/null
+++ b/docs-archive/src/site/site.xml
@@ -0,0 +1,34 @@
+<?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 name="RNG">
+  <bannerRight>
+    <name>Apache Commons RNG</name>
+    <!-- Use a full URL allows a correct banner for the modules. -->
+    <src>https://commons.apache.org/proper/commons-rng/images/commons_rng.small.png</src>
+    <href>https://commons.apache.org/proper/commons-rng/index.html</href>
+  </bannerRight>
+
+  <body>
+    <menu name="RNG Documentation">
+      <item name="Overview" href="index.html"/>
+      <item name="Latest API docs (development)"
+            href="apidocs/index.html"/>
+    </menu>
+
+  </body>
+</project>
diff --git a/docs-archive/src/site/xdoc/index.xml b/docs-archive/src/site/xdoc/index.xml
new file mode 100644
index 00000000..8fa04f5b
--- /dev/null
+++ b/docs-archive/src/site/xdoc/index.xml
@@ -0,0 +1,41 @@
+<?xml version="1.0"?>
+
+<!--
+   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.
+  -->
+
+<document>
+
+  <properties>
+    <title>Commons RNG Documentation</title>
+  </properties>
+
+  <body>
+
+    <section name="Apache Commons RNG: Random Numbers Generators" href="summary">
+      <p>
+        Commons RNG provides implementations of pseudo-random numbers generators that are
+        either faster or of higher quality (and sometimes both) than <code>java.util.Random</code>.
+      </p>
+
+      <p>
+        Browse the <a href="apidocs/index.html">Javadoc</a> for more information.
+      </p>
+    </section>
+
+  </body>
+
+</document>