API docs generation only

.github/workflows/build-api-docs.yml

@@ -0,0 +1,28 @@
+name: Build API Docs
+
+on: [push, pull_request]
+
+jobs:
+
+  website:
+    name: Build API Docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/[email protected]
+        with:
+          fetch-depth: 0
+      - name: Set up JDK 11
+        uses: actions/[email protected]
+        with:
+          java-version: 11
+          distribution: 'temurin'
+      - name: Run dokka build
+        run: ./gradlew dokkaHtmlMultiModule --no-daemon --stacktrace
+      - name: Deploy to netlify
+        uses: netlify/actions/cli@master
+        env:
+          NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
+          NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
+        with:
+          args: deploy --dir=build/dokka/htmlMultiModule --prod

.github/workflows/build-rtron.yml

@@ -26,4 +26,4 @@ jobs:
           distribution: ${{ matrix.distribution }}
           java-version: ${{ matrix.java }}
       - name: Build with Gradle
-        run: ./gradlew build
+        run: ./gradlew build --no-daemon

build.gradle.kts

@@ -15,6 +15,7 @@
  */
 
 import com.github.benmanes.gradle.versions.updates.DependencyUpdatesTask
+import org.jetbrains.dokka.gradle.DokkaMultiModuleTask
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 if (!JavaVersion.current().isJava11Compatible)
@@ -29,6 +30,7 @@ plugins {
     kotlin("jvm") version DependencyVersions.kotlin
     id(Plugins.versionChecker) version PluginVersions.versionChecker
     id(Plugins.ktlint) version PluginVersions.ktlint
+    id(Plugins.dokka) version PluginVersions.dokka
     `maven-publish`
     signing
 }
@@ -88,6 +90,22 @@ allprojects {
         version.set("0.45.2")
     }
 
+    /*tasks.withType<DokkaTask>().configureEach {
+        dokkaSourceSets {
+            named("main") {
+                moduleName.set("Dokka Gradle Example")
+                includes.from("Module.md")
+                sourceLink {
+                    localDirectory.set(file("src/main/kotlin"))
+                    remoteUrl.set(URL("https://github.com/Kotlin/dokka/tree/master/" +
+                            "examples/gradle/dokka-gradle-example/src/main/kotlin"
+                    ))
+                    remoteLineSuffix.set("#L")
+                }
+            }
+        }
+    }*/
+
     publishing {
         apply(plugin = "maven-publish")
 
@@ -171,3 +189,33 @@ val compileTestKotlin: KotlinCompile by tasks
 compileTestKotlin.kotlinOptions {
     jvmTarget = "11"
 }
+
+fun configureDokka() {
+    // if (COMMON_JVM_ONLY) return
+
+    subprojects {
+        plugins.apply("org.jetbrains.dokka")
+
+        /*val dokkaPlugin by configurations
+        dependencies {
+            dokkaPlugin("org.jetbrains.dokka:versioning-plugin:1.7.20")
+        }*/
+    }
+    // val dokkaOutputDir = "../versions"
+
+    tasks.withType<DokkaMultiModuleTask> {
+        /*val mapOf = mapOf(
+            "org.jetbrains.dokka.versioning.VersioningPlugin" to
+                    """{ "version": "${Project.version}", "olderVersionsDir":"$dokkaOutputDir" }"""
+        )
+
+        outputDirectory.set(file(projectDir.toPath().resolve(dokkaOutputDir).resolve(Project.version)))
+        pluginsMapConfiguration.set(mapOf)*/
+    }
+
+    /*rootProject.plugins.withType<org.jetbrains.kotlin.gradle.targets.js.yarn.YarnPlugin> {
+        rootProject.the<org.jetbrains.kotlin.gradle.targets.js.yarn.YarnRootExtension>().ignoreScripts = false
+    }*/
+}
+
+configureDokka()

buildSrc/src/main/kotlin/Dependencies.kt

@@ -17,31 +17,31 @@
 
 object DependencyVersions {
     // standard libraries
-    const val kotlin = "1.7.10"
+    const val kotlin = "1.7.20"
     const val coroutines = "1.6.4"
-    const val arrow = "1.1.2"
+    const val arrow = "1.1.3"
 
     // testing libraries
-    const val junit = "5.9.0"
+    const val junit = "5.9.1"
     const val assertj = "3.23.1"
-    const val mockk = "1.12.7"
+    const val mockk = "1.13.2"
 
     // logging libraries
-    const val kotlinLogging = "2.1.23"
-    const val slf4jSimple = "1.7.36"
+    const val kotlinLogging = "3.0.3"
+    const val slf4jSimple = "2.0.3"
 
     // documentation libraries
-    const val orchid = "0.21.1"
+    //const val orchid = "0.21.1"
 
     // object creation libraries
-    const val kotlinxSerializationJson = "1.4.0"
-    const val kaml = "0.47.0"
+    const val kotlinxSerializationJson = "1.4.1"
+    const val kaml = "0.49.0"
     const val jakartaActivationApi = "2.1.0"
     const val jakartaXmlBindApi = "4.0.0"
-    const val jaxb = "4.0.0"
+    const val jaxb = "4.0.1"
 
     // object mapping libraries
-    const val mapstruct = "1.5.2.Final"
+    const val mapstruct = "1.5.3.Final"
 
     // io libraries
     const val clikt = "3.5.0"
@@ -50,13 +50,13 @@ object DependencyVersions {
     const val commonsCSV = "1.9.0"
     const val commonsLang = "3.12.0"
     const val commonsCompress = "1.21"
-    const val zstdJni = "1.5.2-3"
+    const val zstdJni = "1.5.2-5"
     const val emojiJava = "5.1.1"
 
     // math libraries
     const val guava = "31.1-jre"
     const val commonsMath = "3.6.1"
-    const val joml = "1.10.4"
+    const val joml = "1.10.5"
     const val poly2tri = "0.1.2"
 
     // geo libraries

buildSrc/src/main/kotlin/Plugins.kt

@@ -19,18 +19,18 @@ object PluginVersions {
     const val shadowjar = "7.1.2"
     const val ktlint = "11.0.0"
     const val xjc = "1.6"
-    const val versionChecker = "0.42.0"
-    const val orchid = "0.21.1"
-    const val serialization = "1.7.10"
-    const val ksp = "1.7.10-1.0.6"
+    const val versionChecker = "0.43.0"
+    const val dokka = "1.7.20"
+    const val serialization = "1.7.20"
+    const val ksp = "1.7.20-1.0.7"
 }
 
 object Plugins {
     const val shadowjar = "com.github.johnrengelman.shadow"
     const val ktlint = "org.jlleitschuh.gradle.ktlint"
     const val xjc = "com.github.edeandrea.xjc-generation"
     const val versionChecker = "com.github.ben-manes.versions"
-    const val orchid = "com.eden.orchidPlugin"
+    const val dokka = "org.jetbrains.dokka"
     const val serialization = "plugin.serialization"
     const val ksp = "com.google.devtools.ksp"
 }

gradle.properties

@@ -0,0 +1,2 @@
+## gradle.properties
+org.gradle.jvmargs=-XX:MaxMetaspaceSize=2G

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-rc-1-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

rtron-cli/README.md

@@ -1,6 +1,3 @@
----
----
-
-## [CLI Component]({{page.link}})
+# CLI Component
 
 This component handles the command line interfacing (CLI) and argument parsing.