Move to Dokka 2

arrow-kt · Oct 1, 2024 · 51dbce6 · 51dbce6
1 parent 2363757
commit 51dbce6
Show file tree

Hide file tree

Showing 21 changed files with 58 additions and 21 deletions.
diff --git a/arrow-libs/core/arrow-annotations/build.gradle.kts b/arrow-libs/core/arrow-annotations/build.gradle.kts
@@ -9,6 +9,7 @@ plugins {
   alias(libs.plugins.arrowGradleConfig.kotlin)
   alias(libs.plugins.publish)
   alias(libs.plugins.spotless)
+  alias(libs.plugins.dokka)
 }
 
 spotless {

diff --git a/arrow-libs/core/arrow-atomic/build.gradle.kts b/arrow-libs/core/arrow-atomic/build.gradle.kts
@@ -10,6 +10,7 @@ plugins {
   alias(libs.plugins.publish)
   alias(libs.plugins.kotlinx.kover)
   alias(libs.plugins.spotless)
+  alias(libs.plugins.dokka)
 }
 
 spotless {

diff --git a/arrow-libs/core/arrow-autoclose/build.gradle.kts b/arrow-libs/core/arrow-autoclose/build.gradle.kts
@@ -10,6 +10,7 @@ plugins {
   alias(libs.plugins.arrowGradleConfig.kotlin)
   alias(libs.plugins.publish)
   alias(libs.plugins.spotless)
+  alias(libs.plugins.dokka)
 }
 
 spotless {

diff --git a/arrow-libs/core/arrow-cache4k/build.gradle.kts b/arrow-libs/core/arrow-cache4k/build.gradle.kts
@@ -9,6 +9,7 @@ plugins {
   id(libs.plugins.kotlin.multiplatform.get().pluginId)
   alias(libs.plugins.publish)
   alias(libs.plugins.spotless)
+  // alias(libs.plugins.dokka)
 }
 
 apply(from = property("ANIMALSNIFFER_MPP"))

diff --git a/arrow-libs/core/arrow-core-high-arity/build.gradle.kts b/arrow-libs/core/arrow-core-high-arity/build.gradle.kts
@@ -10,6 +10,7 @@ plugins {
   alias(libs.plugins.publish)
   alias(libs.plugins.kotlinx.kover)
   alias(libs.plugins.spotless)
+  // alias(libs.plugins.dokka)
 }
 
 spotless {

diff --git a/arrow-libs/core/arrow-core-retrofit/build.gradle.kts b/arrow-libs/core/arrow-core-retrofit/build.gradle.kts
@@ -11,6 +11,7 @@ plugins {
   alias(libs.plugins.kotlinx.serialization) // Needed for testing only
   alias(libs.plugins.kotlinx.kover)
   alias(libs.plugins.spotless)
+  // alias(libs.plugins.dokka)
 }
 
 spotless {

diff --git a/arrow-libs/core/arrow-core-serialization/build.gradle.kts b/arrow-libs/core/arrow-core-serialization/build.gradle.kts
@@ -7,9 +7,9 @@ import org.jetbrains.kotlin.gradle.dsl.KotlinVersion
 plugins {
   id(libs.plugins.kotlin.multiplatform.get().pluginId)
   alias(libs.plugins.arrowGradleConfig.kotlin)
-
   alias(libs.plugins.kotlinx.kover)
   alias(libs.plugins.spotless)
+  // alias(libs.plugins.dokka)
   id(libs.plugins.kotlinx.serialization.get().pluginId)
 }
 

diff --git a/arrow-libs/core/arrow-core/build.gradle.kts b/arrow-libs/core/arrow-core/build.gradle.kts
@@ -11,6 +11,7 @@ plugins {
   alias(libs.plugins.publish)
   alias(libs.plugins.kotlinx.kover)
   alias(libs.plugins.spotless)
+  // alias(libs.plugins.dokka)
 }
 
 spotless {

diff --git a/arrow-libs/core/arrow-eval/build.gradle.kts b/arrow-libs/core/arrow-eval/build.gradle.kts
@@ -10,6 +10,7 @@ plugins {
   alias(libs.plugins.publish)
   alias(libs.plugins.kotlinx.kover)
   alias(libs.plugins.spotless)
+  // alias(libs.plugins.dokka)
 }
 
 spotless {

diff --git a/arrow-libs/core/arrow-functions/build.gradle.kts b/arrow-libs/core/arrow-functions/build.gradle.kts
@@ -10,6 +10,7 @@ plugins {
   alias(libs.plugins.publish)
   alias(libs.plugins.kotlinx.kover)
   alias(libs.plugins.spotless)
+  // alias(libs.plugins.dokka)
 }
 
 spotless {

diff --git a/arrow-libs/fx/arrow-collectors/build.gradle.kts b/arrow-libs/fx/arrow-collectors/build.gradle.kts
@@ -10,6 +10,7 @@ plugins {
   alias(libs.plugins.publish)
   alias(libs.plugins.spotless)
   alias(libs.plugins.kotlinx.kover)
+  // alias(libs.plugins.dokka)
 }
 
 apply(from = property("ANIMALSNIFFER_MPP"))

diff --git a/arrow-libs/fx/arrow-fx-coroutines/build.gradle.kts b/arrow-libs/fx/arrow-fx-coroutines/build.gradle.kts
@@ -11,6 +11,7 @@ plugins {
   alias(libs.plugins.publish)
   alias(libs.plugins.kotlinx.kover)
   alias(libs.plugins.spotless)
+  // alias(libs.plugins.dokka)
 }
 
 spotless {

diff --git a/arrow-libs/fx/arrow-fx-stm/build.gradle.kts b/arrow-libs/fx/arrow-fx-stm/build.gradle.kts
@@ -10,6 +10,7 @@ plugins {
   alias(libs.plugins.publish)
   alias(libs.plugins.kotlinx.kover)
   alias(libs.plugins.spotless)
+  // alias(libs.plugins.dokka)
 }
 
 spotless {

diff --git a/arrow-libs/optics/arrow-optics-compose/build.gradle.kts b/arrow-libs/optics/arrow-optics-compose/build.gradle.kts
@@ -19,6 +19,7 @@ plugins {
   alias(libs.plugins.compose.jetbrains)
   alias(libs.plugins.compose.compiler)
   alias(libs.plugins.android.library)
+  // alias(libs.plugins.dokka)
 }
 
 apply(from = property("ANIMALSNIFFER_MPP"))

diff --git a/arrow-libs/optics/arrow-optics-reflect/build.gradle.kts b/arrow-libs/optics/arrow-optics-reflect/build.gradle.kts
@@ -10,6 +10,7 @@ plugins {
   alias(libs.plugins.publish)
   alias(libs.plugins.kotlinx.kover)
   alias(libs.plugins.spotless)
+  // alias(libs.plugins.dokka)
 }
 
 spotless {

diff --git a/arrow-libs/optics/arrow-optics/build.gradle.kts b/arrow-libs/optics/arrow-optics/build.gradle.kts
@@ -10,6 +10,7 @@ plugins {
   alias(libs.plugins.publish)
   alias(libs.plugins.kotlinx.kover)
   alias(libs.plugins.spotless)
+  // alias(libs.plugins.dokka)
 }
 
 spotless {

diff --git a/arrow-libs/resilience/arrow-resilience/build.gradle.kts b/arrow-libs/resilience/arrow-resilience/build.gradle.kts
@@ -10,6 +10,7 @@ plugins {
   alias(libs.plugins.publish)
   alias(libs.plugins.kotlinx.kover)
   alias(libs.plugins.spotless)
+  // alias(libs.plugins.dokka)
 }
 
 spotless {

diff --git a/build.gradle.kts b/build.gradle.kts
@@ -20,6 +20,7 @@ buildscript {
     mavenCentral()
     google()
     maven("https://maven.pkg.jetbrains.space/public/p/compose/dev")
+    maven("https://maven.pkg.jetbrains.space/kotlin/p/dokka/dev")
   }
 
   dependencies {
@@ -33,9 +34,14 @@ allprojects {
     (project.rootProject.properties["kotlin_repo_url"] as? String)?.also { maven(it) }
     google()
     maven("https://maven.pkg.jetbrains.space/public/p/compose/dev")
+    maven("https://maven.pkg.jetbrains.space/kotlin/p/dokka/dev")
   }
 }
 
+allprojects {
+  group = property("projects.group").toString()
+}
+
 plugins {
   base
   alias(libs.plugins.android.library) apply false
@@ -85,8 +91,24 @@ dependencies {
   kover(projects.arrowEval)
 }
 
-allprojects {
-  group = property("projects.group").toString()
+dependencies {
+  dokka(projects.arrowAnnotations)
+  dokka(projects.arrowAtomic)
+  dokka(projects.arrowAutoclose)
+  dokka(projects.arrowCore)
+  dokka(projects.arrowCoreHighArity)
+  dokka(projects.arrowCoreRetrofit)
+  dokka(projects.arrowCoreSerialization)
+  dokka(projects.arrowCache4k)
+  dokka(projects.arrowFunctions)
+  dokka(projects.arrowFxCoroutines)
+  dokka(projects.arrowFxStm)
+  dokka(projects.arrowOptics)
+  dokka(projects.arrowOpticsReflect)
+  dokka(projects.arrowOpticsCompose)
+  dokka(projects.arrowResilience)
+  dokka(projects.arrowCollectors)
+  dokka(projects.arrowEval)
 }
 
 private val kotlinXUpstream =
@@ -121,26 +143,22 @@ remoteUrl.set(uri("https://github.com/arrow-kt/arrow/blob/main/${srcDir.relative
   }
 }
 
-tasks {
-  val undocumentedProjects =
-    listOf(project(":arrow-optics-ksp-plugin"))
-
-  val copyCNameFile = register<Copy>("copyCNameFile") {
-    from(layout.projectDirectory.dir("static").file("CNAME"))
-    into(layout.projectDirectory.dir("docs"))
-  }
+dokka {
+  dokkaPublicationDirectory.set(file("docs"))
+  moduleName.set("Arrow")
+}
 
-  dokkaHtmlMultiModule {
-    dependsOn(copyCNameFile)
-    removeChildTasks(undocumentedProjects)
-  }
+val copyCNameFile = tasks.register<Copy>("copyCNameFile") {
+  from(layout.projectDirectory.dir("static").file("CNAME"))
+  into(layout.projectDirectory.dir("docs"))
+}
 
-  getByName("knitPrepare").dependsOn(getTasksByName("dokka", true))
+tasks.dokkaGenerate {
+  dependsOn(copyCNameFile)
+}
 
-  withType<DokkaMultiModuleTask>().configureEach {
-    outputDirectory.set(file("docs"))
-    moduleName.set("Arrow")
-  }
+tasks.getByName("knitPrepare") {
+  dependsOn(tasks.dokkaGenerate, true)
 }
 
 apiValidation {

diff --git a/gradle.properties b/gradle.properties
@@ -4,6 +4,8 @@ projects.version=2.0.0-SNAPSHOT
 
 enable_wasm=true
 
+org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled
+
 # Pomfile definitions
 #RELEASE_SIGNING_ENABLED=true
 

diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -3,7 +3,7 @@ animalSniffer = "1.7.1"
 arrowGradleConfig = "0.12.0-rc.24"
 coroutines = "1.9.0"
 classgraph = "4.8.176"
-dokka = "1.9.20"
+dokka = "2.0.20-dev-362"
 kotest = "5.9.1"
 kover = "0.8.3"
 kotlin = "2.0.20"

diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -13,6 +13,7 @@ pluginManagement {
     kotlin_repo_url?.also { maven(it) }
     google()
     maven("https://maven.pkg.jetbrains.space/public/p/compose/dev")
+    maven("https://maven.pkg.jetbrains.space/kotlin/p/dokka/dev")
   }
 }