Skip to content

Commit

Permalink
Migrate to Dokka2
Browse files Browse the repository at this point in the history
  • Loading branch information
geoff-powell committed Jan 8, 2025
1 parent 7fb4c54 commit a298e0e
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 12 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/prepare_mkdocs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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 <title> tags.
# Assign metadata to the file's first Markdown heading.
Expand Down
4 changes: 4 additions & 0 deletions gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -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
23 changes: 12 additions & 11 deletions paparazzi/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
}
}
Expand Down

0 comments on commit a298e0e

Please sign in to comment.