From a298e0e8ec6e981b9656f5307166a13c7ea2aec7 Mon Sep 17 00:00:00 2001 From: Geoff Powell Date: Wed, 8 Jan 2025 10:51:23 -0500 Subject: [PATCH] Migrate to Dokka2 --- .github/workflows/prepare_mkdocs.sh | 2 +- gradle.properties | 4 ++++ paparazzi/build.gradle | 23 ++++++++++++----------- 3 files changed, 17 insertions(+), 12 deletions(-) diff --git a/.github/workflows/prepare_mkdocs.sh b/.github/workflows/prepare_mkdocs.sh index 575d8e3318..c2bed3380a 100755 --- a/.github/workflows/prepare_mkdocs.sh +++ b/.github/workflows/prepare_mkdocs.sh @@ -9,7 +9,7 @@ set -ex # Generate the API docs -./gradlew dokkaGfm +./gradlew dokkaGenerate # Dokka filenames like `-http-url/index.md` don't work well with MkDocs tags. # Assign metadata to the file's first Markdown heading. diff --git a/gradle.properties b/gradle.properties index 2b5241b5de..669fdc5a4b 100644 --- a/gradle.properties +++ b/gradle.properties @@ -28,3 +28,7 @@ android.suppressUnsupportedCompileSdk=UpsideDownCakePrivacySandbox # Signals to our own plugin that we are building within the repo. app.cash.paparazzi.internal=true + +# Dokka +org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled +org.jetbrains.dokka.experimental.gradle.pluginMode.noWarn=true diff --git a/paparazzi/build.gradle b/paparazzi/build.gradle index 6f532d9ed0..bf799ff8d2 100644 --- a/paparazzi/build.gradle +++ b/paparazzi/build.gradle @@ -73,18 +73,19 @@ dependencies { testImplementation libs.truth } -tasks.named("dokkaGfm").configure { - outputDirectory = rootProject.file("docs/1.x") +dokka { + dokkaPublications.configureEach { + outputDirectory.set(rootProject.file("docs/1.x")) + } + + dokkaSourceSets.main { + reportUndocumented = false + skipDeprecated = true + jdkVersion = 17 - dokkaSourceSets.named("main") { - configureEach { - reportUndocumented = false - skipDeprecated = true - jdkVersion = 8 - perPackageOption { - prefix = "app.cash.paparazzi.internal" - suppress = true - } + perPackageOption { + matchingRegex = "app.cash.paparazzi.internal.*" + suppress = true } } }