Skip to content

Commit

Permalink
build: use v2 of the official dokka gradle plugin
Browse files Browse the repository at this point in the history
The official (but yet experimental) v2 of the dokka
gradle plugin has integrated the benefits of the
community maintained dokkatoo plugin.
  • Loading branch information
mervyn-mccreight committed Jan 25, 2025
1 parent 0552c20 commit 497b698
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 10 deletions.
2 changes: 1 addition & 1 deletion buildSrc/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ plugins {

dependencies {
implementation(libs.kotlin.gradle)
implementation(libs.dokkatoo.gradle)
implementation(libs.dokka.gradle)
implementation(libs.mavenPublish.gradle)
}
13 changes: 5 additions & 8 deletions buildSrc/src/main/kotlin/library-conventions.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import org.jetbrains.kotlin.gradle.dsl.KotlinVersion

plugins {
id("kotlin-conventions")
id("dev.adamko.dokkatoo-html")
id("org.jetbrains.dokka")
id("com.vanniktech.maven.publish")
}

Expand All @@ -20,16 +20,13 @@ kotlin {
}
}

dokkatoo {
dokkaGeneratorIsolation.set(
ProcessIsolation {
maxHeapSize.set("4g")
}
)
dokka {
dokkaGeneratorIsolation = ProcessIsolation {
maxHeapSize = "4g"
}
}

mavenPublishing {
configure(KotlinJvm(JavadocJar.Dokka("dokkatooGeneratePublicationHtml")))
publishToMavenCentral(SonatypeHost.CENTRAL_PORTAL)
signAllPublications()
pom {
Expand Down
2 changes: 2 additions & 0 deletions gradle.properties
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
org.gradle.parallel=true
org.gradle.caching=true
org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled
org.jetbrains.dokka.experimental.gradle.pluginMode.noWarn=true
2 changes: 1 addition & 1 deletion gradle/libs.versions.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ serialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref

[libraries]
kotlin-gradle = { module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "kotlin" }
dokkatoo-gradle = { module = "dev.adamko.dokkatoo:dokkatoo-plugin", version = "2.4.0" }
dokka-gradle = { module = "org.jetbrains.dokka:org.jetbrains.dokka.gradle.plugin", version = "2.0.0" }
mavenPublish-gradle = { module = "com.vanniktech.maven.publish:com.vanniktech.maven.publish.gradle.plugin", version = "0.30.0" }
kotlinx-coroutines-core = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "kotlinx-coroutines" }
kotlinx-coroutines-jdk8 = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-jdk8", version.ref = "kotlinx-coroutines" }
Expand Down

0 comments on commit 497b698

Please sign in to comment.