Channels
#dokka
Title
a
Adrian Landborn
05/31/2022, 11:28 AMHi,
Is there a way to not overwrite the CSS files or index.html when I run
./gradlew dokkaHtmlMultiModuleThis is how my project level task looks like.
Copy code
pluginManager.withPlugin("org.jetbrains.dokka") {
afterEvaluate {
this.tasks.withType(org.jetbrains.dokka.gradle.DokkaMultiModuleTask::class) {
outputDirectory.set(file("documentation/html"))
includes.from("documentation/packages.md")
}
dependencies {
"dokkaHtmlPlugin"("org.jetbrains.dokka:android-documentation-plugin:1.6.21")
}
}
}i
Ignat Beresnev
05/31/2022, 12:07 PMHi! Not 100% sure what exactly you're trying to do, but if you want to set a custom logo, it's available in Dokka's configuration
Documentation is not very good atm, but there are some examples: https://kotlin.github.io/dokka/1.6.21/user_guide/gradle/usage/#configuration-options
The name for the logo should be
logo-icon.svg Copy code
pluginConfiguration<DokkaBase, DokkaBaseConfiguration> {
customAssets = listOf(file("logo-icon.svg"))
}a
Adrian Landborn
05/31/2022, 12:34 PMI have looked through the docs but do not understand where this “pluginConfiguration” should go.
I just want to replace the icon basically.
I managed to get this working. Does not look good but it works…
Copy code
pluginManager.withPlugin("org.jetbrains.dokka") {
afterEvaluate {
this.tasks.withType(org.jetbrains.dokka.gradle.DokkaMultiModuleTask::class) {
pluginsMapConfiguration.set(mapOf("org.jetbrains.dokka.base.DokkaBase" to """{ "customAssets": ["${file("documentation/logo-icon.svg")}"] }"""))
outputDirectory.set(file("documentation/html"))
includes.from("documentation/packages.md")
}
dependencies {
"dokkaHtmlPlugin"("org.jetbrains.dokka:android-documentation-plugin:1.6.21")
}
}
}The conversion from Groovy to Kotlin however does not look that nice
i
Ignat Beresnev
05/31/2022, 1:11 PMIt should be like this: https://gist.github.com/IgnatBeresnev/ed9b88d20f5d48322f313b53232790e9
^ but that's for
.ktspluginsMapConfigurationa
Adrian Landborn
05/31/2022, 1:14 PMIsn’t that the other way around. We do use Kotlin DSL
i
Ignat Beresnev
05/31/2022, 1:17 PMNope,
pluginsMapConfigurationdokka-basea
Adrian Landborn
05/31/2022, 1:21 PMWhy do you have the code in “DokkaTaskPartial” I want this in the main gradle file.
i
Ignat Beresnev
05/31/2022, 1:25 PMYou can put it in your main gradle file, it's not related 🙂
It's not that code is in
DokkaTaskPartialDokkaTaskPartialDokkaTaska
Adrian Landborn
05/31/2022, 1:29 PMThen we should be able to use this in the project level gradle file for DokkaMultiModuleTask.
Not sure why the imports does not resolve though. 🤔
image.png
i
Ignat Beresnev
05/31/2022, 1:30 PMDid you add a dependency to
dokka-base Copy code
buildscript {
dependencies {
classpath("org.jetbrains.dokka:dokka-base:1.6.21")
}
}🙏 2
a
Adrian Landborn
05/31/2022, 1:30 PMahh 😄
13 Views