From 901e71e078fa8947bbf7f2a3dd812f5232a8996d Mon Sep 17 00:00:00 2001 From: Jocelyne Date: Thu, 19 Dec 2024 01:08:14 +0100 Subject: [PATCH] build: Enable the new Dokka Gradle plugin This migrates to Dokka Gradle plugin v2 and removes the warning that Dokka Gradle plugin V1 is deprecated. --- .github/workflows/docs-workflow.yml | 2 +- build.gradle.kts | 7 ++++--- gradle.properties | 1 + 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/.github/workflows/docs-workflow.yml b/.github/workflows/docs-workflow.yml index f7068c3400..451756977a 100644 --- a/.github/workflows/docs-workflow.yml +++ b/.github/workflows/docs-workflow.yml @@ -50,7 +50,7 @@ jobs: uses: gradle/gradle-build-action@v2 - name: Build API documentation with Dokka - run: ./gradlew dokkaHtmlMultiModule + run: ./gradlew :dokkaGenerate - name: Create Pull Request uses: peter-evans/create-pull-request@v6 diff --git a/build.gradle.kts b/build.gradle.kts index 5574c0fe43..b4b1d5ff02 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -1,4 +1,3 @@ -import org.jetbrains.dokka.gradle.DokkaMultiModuleTask import org.jetbrains.exposed.gradle.configureDetekt import org.jetbrains.exposed.gradle.configurePublishing import org.jetbrains.exposed.gradle.testDb @@ -12,8 +11,10 @@ plugins { alias(libs.plugins.dokka) } -tasks.withType { - outputDirectory.set(project.file("docs/api")) +dokka { + dokkaPublications.html { + outputDirectory.set(project.file("docs/api")) + } } repositories { diff --git a/gradle.properties b/gradle.properties index 2d8d635a81..204008cf05 100644 --- a/gradle.properties +++ b/gradle.properties @@ -2,6 +2,7 @@ org.gradle.parallel=false org.gradle.jvmargs=-Dfile.encoding=UTF-8 org.gradle.configuration.cache=true org.gradle.caching=true +org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled group=org.jetbrains.exposed version=0.57.0