Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Complete upgrade Dokka to V2 #2914

Merged
merged 7 commits into from
Dec 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 8 additions & 12 deletions build-logic/src/main/kotlin/ktlint-dokka.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,20 +1,16 @@
plugins {
`java-library`
id("org.jetbrains.dokka")
// Generates Javadoc documentation
id("org.jetbrains.dokka-javadoc")
}

dokka {
dokkaPublications.javadoc {
outputDirectory.set(layout.buildDirectory.dir("javadoc"))
}
}

java {
withSourcesJar()
withJavadocJar()
}

tasks.dokkaJavadoc {
notCompatibleWithConfigurationCache("https://github.com/Kotlin/dokka/issues/1217")
outputDirectory = layout.buildDirectory.dir("javadoc")
}

tasks.named<Jar>("javadocJar") {
dependsOn(tasks.dokkaJavadoc)
archiveClassifier = "javadoc"
from(tasks.dokkaJavadoc)
}
3 changes: 3 additions & 0 deletions gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,6 @@ org.gradle.caching=true
# The release process of ktlint breaks whenever the configuration cache is enabled as not all gradle tasks fully supports this feature yet.
# As the configuration cache only slightly improves the build performance, it is kept disabled for now.
org.gradle.configuration-cache=false

# Enable helpers for migration to Dokka V2
org.jetbrains.dokka.experimental.gradle.pluginMode=V2EnabledWithHelpers
Loading