Integrate Dokka

.github/workflows/ci.yml

@@ -15,10 +15,10 @@ jobs:
       - name: Checkout Repository
         uses: actions/checkout@v4
 
-      - name: Set up Java 17
+      - name: Set up Java 21
         uses: actions/setup-java@v4
         with:
-          java-version: '17'
+          java-version: '21'
           distribution: 'zulu'
 
       - name: Setup Gradle

.github/workflows/docs.yml

@@ -0,0 +1,54 @@
+name: Deploy Dokka to GitHub Pages
+
+on:
+  # Only trigger this when code is merged into main
+  push:
+    branches: ["main"]
+
+# Grants the workflow permission to push to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Prevents multiple documentation deployments from running at the same time
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  deploy-docs:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    # We use macOS again to ensure the KMP project configures iOS targets successfully
+    runs-on: macos-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Set up Java 21
+        uses: actions/setup-java@v4
+        with:
+          java-version: '21'
+          distribution: 'zulu'
+
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v3
+
+      - name: Generate Dokka HTML
+        run: ./gradlew dokkaGenerateHtml --no-configuration-cache
+
+      - name: Setup GitHub Pages
+        uses: actions/configure-pages@v4
+
+      - name: Upload Documentation Artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: 'build/dokka/html'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/publish.yml

@@ -16,10 +16,10 @@ jobs:
       - name: Checkout Repository
         uses: actions/checkout@v4
 
-      - name: Set up Java 17
+      - name: Set up Java 21
         uses: actions/setup-java@v4
         with:
-          java-version: '17'
+          java-version: '21'
           distribution: 'zulu'
 
       - name: Setup Gradle

build.gradle.kts

@@ -1,3 +1,5 @@
+import org.jetbrains.dokka.gradle.engine.parameters.VisibilityModifier
+
 plugins {
     // this is necessary to avoid the plugins to be loaded multiple times
     // in each subproject's classloader
@@ -9,6 +11,24 @@ plugins {
     alias(libs.plugins.androidKotlinMultiplatformLibrary) apply false
     alias(libs.plugins.androidLint) apply false
     alias(libs.plugins.vanniktech.mavenPublish) apply false
+    id("org.jetbrains.dokka") version "2.1.0"
+}
+
+dokka {
+    // Sets properties for the whole project
+    dokkaPublications.html {
+        moduleName.set("Kapacity Documentation")
+        includes.from("README.md")
+    }
+
+    dokkaSourceSets.configureEach {
+        documentedVisibilities.set(setOf(VisibilityModifier.Public))
+    }
+}
+
+dependencies {
+    dokka(project(":kapacity"))
+    dokka(project(":kapacity-io"))
 }
 
 val projectGroup = project.findProperty("GROUP")?.toString() ?: "io.github.developrofthings"

kapacity-io/build.gradle.kts

@@ -2,6 +2,21 @@ plugins {
     alias(libs.plugins.kotlinMultiplatform)
     alias(libs.plugins.androidKotlinMultiplatformLibrary)
     alias(libs.plugins.androidLint)
+    id("org.jetbrains.dokka")
+}
+
+dokka {
+    dokkaPublications.html {
+        moduleName.set("Kapacity IO")
+        includes.from("README.md")
+    }
+    dokkaSourceSets.configureEach {
+        sourceLink {
+            localDirectory.set(file("src/main/kotlin"))
+            remoteUrl("https://github.com/DeveloprOfThings/Kapacity/tree/main/kapacity-io")
+            remoteLineSuffix.set("#L")
+        }
+    }
 }
 
 kotlin {

kapacity/build.gradle.kts

@@ -2,10 +2,25 @@ plugins {
     alias(libs.plugins.kotlinMultiplatform)
     alias(libs.plugins.androidKotlinMultiplatformLibrary)
     alias(libs.plugins.androidLint)
+    id("org.jetbrains.dokka")
 }
 
-kotlin {
+dokka {
+    dokkaPublications.html {
+        moduleName.set("Kapacity Core")
+        includes.from("README.md")
+    }
+
+    dokkaSourceSets.configureEach {
+        sourceLink {
+            localDirectory.set(file("src/main/kotlin"))
+            remoteUrl("https://github.com/DeveloprOfThings/Kapacity/tree/main/kapacity")
+            remoteLineSuffix.set("#L")
+        }
+    }
+}
 
+kotlin {
     // Target declarations - add or remove as needed below. These define
     // which platforms this KMP module supports.
     // See: https://kotlinlang.org/docs/multiplatform-discover-project.html#targets
@@ -96,5 +111,4 @@ kotlin {
             }
         }
     }
-
 }