Skip to content

Commit

Permalink
Configure dokka multi module
Browse files Browse the repository at this point in the history
  • Loading branch information
ajalt committed May 18, 2024
1 parent 8122c02 commit 7ec1281
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 33 deletions.
45 changes: 23 additions & 22 deletions build.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
import com.vanniktech.maven.publish.JavadocJar
import com.vanniktech.maven.publish.KotlinMultiplatform
import org.jetbrains.dokka.gradle.DokkaMultiModuleTask
import org.jetbrains.dokka.gradle.DokkaTask
import org.jetbrains.dokka.gradle.DokkaTaskPartial
import org.jetbrains.kotlin.gradle.dsl.JvmTarget
import org.jetbrains.kotlin.gradle.tasks.KotlinJvmCompile


plugins {
kotlin("multiplatform").version(libs.versions.kotlin).apply(false)
alias(libs.plugins.dokka).apply(false)
alias(libs.plugins.publish).apply(false)
alias(libs.plugins.dokka)
alias(libs.plugins.kotlinBinaryCompatibilityValidator)
}

Expand All @@ -24,6 +28,11 @@ fun getPublishVersion(): String {
}


private val dokkaConfig = mapOf(
"org.jetbrains.dokka.base.DokkaBase" to """{
"footerMessage": "Copyright © 2018 AJ Alt"
}"""
)

subprojects {
project.setProperty("VERSION_NAME", getPublishVersion())
Expand All @@ -36,29 +45,21 @@ subprojects {
tasks.withType<JavaCompile>().configureEach {
options.release.set(8)
}

pluginManager.withPlugin("com.vanniktech.maven.publish") {
apply(plugin = "org.jetbrains.dokka")

tasks.named<DokkaTask>("dokkaHtml") {
outputDirectory.set(rootProject.rootDir.resolve("docs/api"))
val rootPath = rootProject.rootDir.toPath()
val logoCss = rootPath.resolve("docs/css/logo-styles.css").toString().replace('\\', '/')
val paletteSvg = rootPath.resolve("docs/img/wordmark_small_dark.svg").toString()
.replace('\\', '/')
pluginsMapConfiguration.set(
mapOf(
"org.jetbrains.dokka.base.DokkaBase" to """{
"customStyleSheets": ["$logoCss"],
"customAssets": ["$paletteSvg"],
"footerMessage": "Copyright &copy; 2021 AJ Alt"
}"""
)
)
dokkaSourceSets.configureEach {
reportUndocumented.set(false)
skipDeprecated.set(true)
}
}
tasks.withType<DokkaTask>().configureEach {
dokkaSourceSets.configureEach {
reportUndocumented.set(false)
skipDeprecated.set(false)
}
}
tasks.withType<DokkaTaskPartial>().configureEach {
pluginsMapConfiguration.set(dokkaConfig)
}
}

tasks.named<DokkaMultiModuleTask>("dokkaHtmlMultiModule") {
outputDirectory.set(rootProject.rootDir.resolve("docs/api"))
pluginsMapConfiguration.set(dokkaConfig)
}
2 changes: 1 addition & 1 deletion deploy_website.sh
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
set -ex

# Generate API docs
./gradlew cleanDokkaHtml dokkaHtml
./gradlew cleanDokkaHtmlMultiModule dokkaHtmlMultiModule

# Copy the changelog into the site, omitting the unreleased section
cat CHANGELOG.md \
Expand Down
10 changes: 0 additions & 10 deletions docs/css/logo-styles.css

This file was deleted.

0 comments on commit 7ec1281

Please sign in to comment.