Update to Dokka 2.0.0 #4257
Update to Dokka 2.0.0 #4257
Conversation
Otherwise, fails with "Cannot run Project.afterEvaluate(Action) when the project is already evaluated."
NB: not tested, waits for KT-71784
| // Workaround for https://github.com/Kotlin/dokka/issues/1833: make implicit dependency explicit | ||
| tasks.named("dokkaHtmlPartial") { | ||
| tasks.withType<DokkaBaseTask>() { | ||
| dependsOn(jvmJar) | ||
| } |
There was a problem hiding this comment.
Please could you try removing this workaround? It shouldn't be necessary in DGPv2.
If ./gradlew :dokkaGenerate still complains, then please raise an issue.
Co-authored-by: Adam <[email protected]>
| knitTask.dependsOn(dokkaTasks) | ||
| } | ||
| tasks.named("knitPrepare") { | ||
| dependsOn("dokka") |
There was a problem hiding this comment.
Does the coroutines Gradle config have a task named dokka? Or should this be dokkaGenerate?
| dokkaPlugin("org.jetbrains.kotlinx:dokka-pathsaver-plugin:$knit_version") | ||
|
|
||
| subprojects.forEach { | ||
| if (it.name !in projetsWithoutDokka) { |
There was a problem hiding this comment.
Minor typo.
| if (it.name !in projetsWithoutDokka) { | |
| if (it.name !in projectsWithoutDokka) { |
(I made a suggestion to make it easier to see the typo, but maybe other places in the code should be updated.)
| ) | ||
| private fun DokkaExtension.setupDokkaTemplatesDir() { | ||
| pluginsConfiguration.html { | ||
| templatesDir = file(rootDir.toString().replace('\\', '/') + "/dokka-templates") |
There was a problem hiding this comment.
rootDir.resolve("dokka-templates")
|
BTW, references to classes/functions from |
|
|
||
| // TODO: WA for KT-71784 | ||
| dokkaSourceSets.matching { it.name == "commonMain" }.configureEach { | ||
| suppress.set(true) | ||
| } |
There was a problem hiding this comment.
This workaround could be removed after update to Dokka 2.0.0.
| } | ||
| } | ||
|
|
||
| private fun Project.configureExternalLinks() { | ||
| tasks.withType<DokkaTaskPartial>() { | ||
| dokka { |
There was a problem hiding this comment.
Q: what is the reason why this manual linking to core artifact exists here at all?
| @@ -2,19 +2,14 @@ plugins { | |||
| id("kotlinx-knit") | |||
| } | |||
|
|
|||
| // TODO check that roots are correct | |||
| knit { | |||
| siteRoot = "https://kotlinlang.org/api/kotlinx.coroutines" | |||
| moduleRoots = listOf(".", "integration", "reactive", "ui") | |||
| moduleDocs = "build/dokka/htmlPartial" | |||
| dokkaMultiModuleRoot = "build/dokka/htmlMultiModule/" | |||
There was a problem hiding this comment.
| dokkaMultiModuleRoot = "build/dokka/htmlMultiModule/" | |
| dokkaMultiModuleRoot = "build/dokka/html/" |
| @@ -2,19 +2,14 @@ plugins { | |||
| id("kotlinx-knit") | |||
| } | |||
|
|
|||
| // TODO check that roots are correct | |||
| knit { | |||
| siteRoot = "https://kotlinlang.org/api/kotlinx.coroutines" | |||
| moduleRoots = listOf(".", "integration", "reactive", "ui") | |||
| moduleDocs = "build/dokka/htmlPartial" | |||
There was a problem hiding this comment.
| moduleDocs = "build/dokka/htmlPartial" | |
| moduleDocs = "build/dokka-module/html/module" |
No description provided.