Use dokka 2 (#1397)

https://kotlinlang.org/docs/dokka-migration.html

Author: Goooler

.github/workflows/deploy.yml

@@ -19,7 +19,7 @@ jobs:
         with:
           cache-read-only: true
       - name: Prepare API documentation
-        run: ./gradlew dokkaHtml
+        run: ./gradlew dokkaGenerate
       - name: Build Site
         run: |
           # Don't cache it to track updates.

.github/workflows/links.yml

@@ -26,7 +26,7 @@ jobs:
         with:
           cache-read-only: true
       # This is required for action-linkspector to work with API links.
-      - run: ./gradlew dokkaHtml
+      - run: ./gradlew dokkaGenerate
       - name: Mkdocs build validation
         run: |
           # Don't cache it to track updates.

build-logic/src/main/kotlin/shadow.convention.publish.gradle.kts

@@ -13,6 +13,12 @@ version = providers.gradleProperty("VERSION_NAME").get()
 group = providers.gradleProperty("GROUP").get()
 description = providers.gradleProperty("POM_DESCRIPTION").get()
 
+dokka {
+  dokkaPublications.html {
+    outputDirectory = rootDir.resolve("docs/api")
+  }
+}
+
 java {
   withSourcesJar()
   withJavadocJar()
@@ -33,10 +39,6 @@ gradlePlugin {
   }
 }
 
-tasks.dokkaHtml {
-  outputDirectory = rootDir.resolve("docs/api")
-}
-
 tasks.publishPlugins {
   doFirst {
     if (version.toString().endsWith("SNAPSHOT")) {

build.gradle.kts

@@ -181,7 +181,7 @@ tasks.clean {
   delete += listOf(
     rootDirs.map { it.resolve(".gradle") },
     rootDirs.map { it.resolve(".kotlin") },
-    tasks.dokkaHtml.map { it.outputDirectory },
+    dokka.dokkaPublications.html.map { it.outputDirectory },
     // Generated by MkDocs.
     rootDir.resolve("site"),
   )

gradle.properties

@@ -9,6 +9,11 @@ org.gradle.jvmargs=-Dfile.encoding=UTF-8 -Xmx4g
 org.gradle.kotlin.dsl.allWarningsAsErrors=true
 org.gradle.parallel=true
 
+org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled
+org.jetbrains.dokka.experimental.gradle.pluginMode.noWarn=true
+org.jetbrains.dokka.experimental.tryK2=true
+org.jetbrains.dokka.experimental.tryK2.nowarn=true
+
 ########## Properties for publishing to Maven Central ##########
 
 GROUP=com.gradleup.shadow