Configure dokka

kevincianfarini · Feb 29, 2024 · 303cc76 · 303cc76
1 parent b3fd5fd
commit 303cc76
Show file tree

Hide file tree

Showing 8 changed files with 18 additions and 10 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -26,13 +26,13 @@ jobs:
           ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.ORG_GRADLE_PROJECT_MAVENCENTRALUSERNAME }}
           ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.ORG_GRADLE_PROJECT_MAVENCENTRALPASSWORD }}
           ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.ORG_GRADLE_PROJECT_SIGNINGINMEMORYKEY }}
-        run: ./gradlew publish
+        run: ./gradlew dokkaHtml publish
 
-#      - name: Deploy docs to website
-#        uses: JamesIves/github-pages-deploy-action@releases/v3
-#        with:
-#          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-#          BRANCH: site
-#          FOLDER: build/dokka/html
-#          TARGET_FOLDER: docs/0.x/
-#          CLEAN: true
+      - name: Deploy docs to website
+        uses: JamesIves/github-pages-deploy-action@releases/v3
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          BRANCH: site
+          FOLDER: build/dokka/html
+          TARGET_FOLDER: docs/0.x/
+          CLEAN: true
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -1,5 +1,6 @@
 plugins {
     alias(libs.plugins.android.library) apply false
+    alias(libs.plugins.dokka) apply false
     alias(libs.plugins.kotlin.multiplatform) apply false
     alias(libs.plugins.kotlin.serialization) apply false
     alias(libs.plugins.publish) apply false

diff --git a/compose/build.gradle.kts b/compose/build.gradle.kts
@@ -1,6 +1,7 @@
 plugins {
-    alias(libs.plugins.kotlin.multiplatform)
     alias(libs.plugins.compose.plugin)
+    alias(libs.plugins.dokka)
+    alias(libs.plugins.kotlin.multiplatform)
     alias(libs.plugins.publish)
 }
 

diff --git a/core/build.gradle.kts b/core/build.gradle.kts
@@ -1,4 +1,5 @@
 plugins {
+    alias(libs.plugins.dokka)
     alias(libs.plugins.kotlin.multiplatform)
     alias(libs.plugins.publish)
 }

diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -3,6 +3,7 @@ agp = "8.2.2"
 android-compileSdk = "34"
 android-minSdk = "21"
 compose = "1.6.0"
+dokka = "1.9.10"
 kotlin = "1.9.22"
 kotlinx-coroutines = "1.8.0"
 kotlinx-serialization = "1.6.2"
@@ -23,6 +24,7 @@ turbine = { module = "app.cash.turbine:turbine", version.ref = "turbine" }
 [plugins]
 android-library = { id = "com.android.library", version.ref = "agp" }
 compose-plugin = { id = "org.jetbrains.compose", version.ref = "compose" }
+dokka = { id = "org.jetbrains.dokka", version.ref = "dokka" }
 kotlin-multiplatform = { id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin" }
 kotlin-serialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin" }
 publish = { id = "com.vanniktech.maven.publish", version.ref = "publish" }
diff --git a/integrations/launch-darkly/build.gradle.kts b/integrations/launch-darkly/build.gradle.kts
@@ -1,5 +1,6 @@
 plugins {
     alias(libs.plugins.android.library)
+    alias(libs.plugins.dokka)
     alias(libs.plugins.kotlin.multiplatform)
     alias(libs.plugins.publish)
 }

diff --git a/mixins/kotlinx-serialization-json/build.gradle.kts b/mixins/kotlinx-serialization-json/build.gradle.kts
@@ -1,4 +1,5 @@
 plugins {
+    alias(libs.plugins.dokka)
     alias(libs.plugins.kotlin.multiplatform)
     alias(libs.plugins.kotlin.serialization)
     alias(libs.plugins.publish)

diff --git a/test/build.gradle.kts b/test/build.gradle.kts
@@ -1,4 +1,5 @@
 plugins {
+    alias(libs.plugins.dokka)
     alias(libs.plugins.kotlin.multiplatform)
     alias(libs.plugins.publish)
 }