Update Gradle Dokka configuration to make sure "source" button is visible in all API docs #244
Conversation
…ible in all API docs
| @@ -8,9 +8,9 @@ import org.jetbrains.dokka.gradle.DokkaTaskPartial | |||
| plugins { | |||
| id("kotlinx-io-multiplatform") | |||
| id("kotlinx-io-publish") | |||
| id("kotlinx-io-dokka") | |||
There was a problem hiding this comment.
Just in case: can we also replace alias(libs.plugins.dokka) with id("kotlinx-io-dokka") in the root build.gradle.kts? It seems like everything works fine afterward, but maybe I'm missing something.
There was a problem hiding this comment.
Not really, as root module doesn't have any sources, and so those changes have no affect for root module, also only one task from root module is executed from Dokka - dokkaHtmlMultimodule and it's just an aggregate task
So I would suggest to leave this as is:
kotlinx-io-dokkafor subprojects, wheredocumentation buildingcan be customised consistently- plain
dokkain root (aggregate) project, wheredocumentation aggregationcan be customised
It's similar to how kover works - there are leaf projects and there is an aggregate project (only that Dokka DSL isn't that good, yet :) )
There was a problem hiding this comment.
Thanks for the explanation!
|
@whyoleg thanks for the patch! ❤️ |
For context: Kotlin/kotlinx.coroutines#3929 and Kotlin/kotlinx.coroutines#3960