Skip to content

Commit

Permalink
ktl-695 chore: support Dokka HTML customization
Browse files Browse the repository at this point in the history
  • Loading branch information
nikpachoo committed Aug 9, 2022
1 parent 16a85df commit 1ebcca4
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 0 deletions.
4 changes: 4 additions & 0 deletions build.gradle
Expand Up @@ -188,3 +188,7 @@ subprojects {
apply from: rootProject.file('gradle/compiler-version.gradle')
apply from: rootProject.file("gradle/dokka.gradle")
apply from: rootProject.file("gradle/benchmark-parsing.gradle")

tasks.named("dokkaHtmlMultiModule") {
pluginsMapConfiguration.set(["org.jetbrains.dokka.base.DokkaBase": """{ "templatesDir": "${projectDir.toString().replace('\\', '/')}/dokka-templates" }"""])
}
4 changes: 4 additions & 0 deletions 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.
2 changes: 2 additions & 0 deletions gradle/dokka.gradle
Expand Up @@ -20,6 +20,8 @@ subprojects {

tasks.named('dokkaHtmlPartial') {
outputDirectory = file("build/dokka")
pluginsMapConfiguration.set(["org.jetbrains.dokka.base.DokkaBase": """{ "templatesDir": "${rootProject.projectDir.toString().replace('\\', '/')}/dokka-templates" }"""])

dokkaSourceSets {
configureEach {
includes.from(rootProject.file('dokka/moduledoc.md').path)
Expand Down

0 comments on commit 1ebcca4

Please sign in to comment.