ktl-695 chore: support Dokka HTML customization (Kotlin#3388)

pablobaxter · Sep 14, 2022 · 43ff6bb · 43ff6bb
1 parent 541a179
commit 43ff6bb
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/build.gradle b/build.gradle
@@ -355,3 +355,7 @@ allprojects { subProject ->
                 }
             }
 }
+
+tasks.named("dokkaHtmlMultiModule") {
+    pluginsMapConfiguration.set(["org.jetbrains.dokka.base.DokkaBase": """{ "templatesDir": "${projectDir.toString().replace('\\', '/')}/dokka-templates" }"""])
+}
diff --git a/dokka-templates/README.md b/dokka-templates/README.md
@@ -0,0 +1,4 @@
+# Customize Dokka's HTML. 
+To customize Dokka's HTML output, place a file in this folder.
+Dokka will find a template file there. If the file is not found, a default one will be used.
+This folder is defined by the templatesDir property.
diff --git a/gradle/dokka.gradle.kts b/gradle/dokka.gradle.kts
@@ -27,6 +27,8 @@ tasks.withType(DokkaTaskPartial::class).configureEach {
 
 tasks.withType(DokkaTaskPartial::class).configureEach {
     suppressInheritedMembers.set(true)
+    pluginsMapConfiguration.set(mapOf("org.jetbrains.dokka.base.DokkaBase" to """{ "templatesDir" : "${rootProject.projectDir.toString().replace('\\', '/')}/dokka-templates" }"""))
+
     dokkaSourceSets.configureEach {
         jdkVersion.set(11)
         includes.from("README.md")
-Original file line number
+Diff line change
@@ Expand Up / @@ -355,3 +355,7 @@ allprojects { subProject -> @@
                     }
                 }
     }
+    tasks.named("dokkaHtmlMultiModule") {
+        pluginsMapConfiguration.set(["org.jetbrains.dokka.base.DokkaBase": """{ "templatesDir": "${projectDir.toString().replace('\\', '/')}/dokka-templates" }"""])
+    }