Add a task that creates a tar.gz of the javadoc

kcooney · kcooney · commit 919caccfc955 · 2026-03-27T23:57:09.000-07:00
diff --git a/build.gradle b/build.gradle
@@ -25,4 +25,32 @@ allprojects {
             }
         }
     }
-}
+}
+
+tasks.register('archiveJavadoc', Tar) {
+    archiveFileName = 'javadoc.tar.gz'
+    compression = Compression.GZIP
+    destinationDirectory = layout.buildDirectory.dir("docs/javadoc/${gradle.lib_version}")
+
+    from(tasks.named('generateJavadocIndex'))
+
+    subprojects.forEach { sub ->
+        sub.tasks.withType(Javadoc).configureEach { javadocTask ->
+            from(javadocTask.destinationDir) {
+                into sub.name
+            }
+        }
+    }
+}
+
+tasks.register('generateJavadocIndex', Copy) {
+    from 'site/javadoc/latest'
+    include 'index.j2.html'
+    into layout.buildDirectory.dir("docs/javadoc")
+
+    // Rename the file during the copy process
+    rename { 'index.html' }
+
+    // This performs the variable substitution
+    expand([version: gradle.lib_version])
+}
diff --git a/buildSrc/src/main/groovy/publishing-conventions.gradle b/buildSrc/src/main/groovy/publishing-conventions.gradle
@@ -3,7 +3,7 @@ plugins {
 }
 
 group = 'com.team2813.lib2813'
-version = "2.0.0"
+version = gradle.lib_version
 
 mavenPublishing {
 
diff --git a/settings.gradle b/settings.gradle
@@ -8,5 +8,6 @@
  */
 
 rootProject.name = 'lib2813'
+gradle.ext.lib_version = "2.0.0"
 include 'core', 'limelight', 'vision', 'testing'
 include 'vendor:ctre', 'vendor:rev'
diff --git a/site/javadoc/latest/index.j2.html b/site/javadoc/latest/index.j2.html
@@ -0,0 +1,28 @@
+<!DOCTYPE HTML>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>lib2813 2.0.0 Javadoc</title>
+  <link rel="stylesheet" href="https://cdn.simplecss.org/simple.min.css">
+  <link rel="stylesheet" href="../stylesheet.css">
+</head>
+<body>
+  <header>
+    <h1>lib2813 {{ version }} Javadoc</h1>
+  </header>
+  <main>
+    <ul>
+      <li><a href="core/">core</a></li>
+      <li><a href="limelight/">limelight</a></li>
+      <li><a href="testing/">testing</a></li>
+      <li><a href="vendor-ctre/">vendor-ctre</a></li>
+      <li><a href="vendor-rev/">vendor-rev</a></li>
+      <li><a href="vision"/>vision</a></li>
+    </ul>
+  </main>
+  <footer>
+    <p>Copyright 2023-2026 Prospect Robotics SWENext Club</p>
+  </footer>
+</body>
+</html>
diff --git a/site/javadoc/stylesheet.css b/site/javadoc/stylesheet.css
@@ -0,0 +1,6 @@
+body > header {
+  --accent-bg: #4D7A97;
+}
+:root {
+  --accent: #4D7A97;
+}

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ plugins {`
`3`	`3`	`}`
`4`	`4`
`5`	`5`	`group = 'com.team2813.lib2813'`
`6`		`-version = "2.0.0"`
	`6`	`+version = gradle.lib_version`
`7`	`7`
`8`	`8`	`mavenPublishing {`
`9`	`9`