Merge remote-tracking branch 'origin/master' into develop

Author: fzhinkin

build-logic/src/main/kotlin/kotlinx/io/conventions/kotlinx-io-dokka.gradle.kts

@@ -3,13 +3,24 @@
  * Use of this source code is governed by the Apache 2.0 license that can be found in the LICENCE file.
  */
 
-import org.jetbrains.dokka.gradle.DokkaTaskPartial
+import org.jetbrains.dokka.gradle.*
 import java.net.URL
 
 plugins {
     id("org.jetbrains.dokka")
 }
 
+// shared configuration for all dokka tasks (both partial and multi-module)
+tasks.withType<AbstractDokkaTask>().configureEach {
+    pluginsMapConfiguration.set(
+        mapOf(
+            "org.jetbrains.dokka.base.DokkaBase" to """{ "templatesDir" : "${
+                rootDir.resolve("dokka-templates")
+            }"""
+        )
+    )
+}
+
 tasks.withType<DokkaTaskPartial>().configureEach {
     dokkaSourceSets.configureEach {
         includes.from("Module.md")

build.gradle.kts

@@ -8,10 +8,10 @@ import kotlinx.validation.ExperimentalBCVApi
 
 plugins {
     id("kotlinx-io-publish") apply false
+    id("kotlinx-io-dokka")
 
     alias(libs.plugins.kover)
     alias(libs.plugins.bcv)
-    alias(libs.plugins.dokka)
 }
 
 allprojects {

dokka-templates/README.md

@@ -0,0 +1,12 @@
+# Dokka's template customization
+To provide unified navigation for all parts of [kotlinlang.org](https://kotlinlang.org/),
+the Kotlin Website Team uses this directory to place custom templates in this folder
+during the website build time on TeamCity.
+
+It is not practical to place these templates in the kotlinx.metadata repository because they change from time to time
+and aren't related to the library's release cycle.
+
+The folder is defined as a source for custom templates by the templatesDir property through Dokka's plugin configuration.
+
+[Here](https://kotlinlang.org/docs/dokka-html.html#templates), you can
+find more about the customization of Dokka's HTML output.