Skip to content

Commit

Permalink
build: Enable the new Dokka Gradle plugin (#2341)
Browse files Browse the repository at this point in the history
This migrates to Dokka Gradle plugin v2 and removes the warning that Dokka Gradle plugin V1 is deprecated.
  • Loading branch information
joc-a authored Jan 8, 2025
1 parent 9fe5ad2 commit a9feb99
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docs-workflow.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 4 additions & 3 deletions build.gradle.kts
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -12,8 +11,10 @@ plugins {
alias(libs.plugins.dokka)
}

tasks.withType<DokkaMultiModuleTask> {
outputDirectory.set(project.file("docs/api"))
dokka {
dokkaPublications.html {
outputDirectory.set(project.file("docs/api"))
}
}

repositories {
Expand Down
1 change: 1 addition & 0 deletions gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit a9feb99

Please sign in to comment.