Skip to content

Commit f2d5d21

Browse files
committed
docs: generate docs by dokka
1 parent 2504e4d commit f2d5d21

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

build.gradle.kts

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
11
import org.gradle.jvm.tasks.Jar
2+
import org.jetbrains.dokka.gradle.DokkaTask
23
import org.jetbrains.kotlin.gradle.dsl.JvmTarget
4+
import java.net.URI
5+
import java.net.URL
36
import java.util.*
47

58
plugins {
69
alias(libs.plugins.kotlin)
710
alias(libs.plugins.kotlin.serialization)
811
alias(libs.plugins.kotlinx.kover)
912
alias(libs.plugins.kotlinx.binary.compatibility.validator)
13+
alias(libs.plugins.dokka)
1014
`maven-publish`
1115
signing
1216
}
@@ -172,3 +176,20 @@ tasks.withType<AbstractArchiveTask>().configureEach {
172176
isReproducibleFileOrder = true
173177
}
174178

179+
tasks.withType<DokkaTask> {
180+
dokkaSourceSets.configureEach {
181+
sourceLink {
182+
localDirectory = project.layout.projectDirectory.dir("src").asFile
183+
val p =
184+
project.layout.projectDirectory.dir("src").asFile.relativeTo(rootProject.layout.projectDirectory.asFile)
185+
.toString()
186+
.replace('\\', '/')
187+
remoteUrl = URI.create("https://github.com/iseki0/kotlinx-serialization-bencoding/tree/master/$p").toURL()
188+
remoteLineSuffix = "#L"
189+
}
190+
externalDocumentationLink {
191+
url = URI.create("https://kotlinlang.org/api/kotlinx.serialization/").toURL()
192+
}
193+
}
194+
}
195+

gradle/libs.versions.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,4 @@ kotlin = { id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin" }
1111
kotlin-serialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin" }
1212
kotlinx-kover = { id = "org.jetbrains.kotlinx.kover", version = "0.7.6" }
1313
kotlinx-binary-compatibility-validator = "org.jetbrains.kotlinx.binary-compatibility-validator:0.17.0"
14+
dokka = { id = "org.jetbrains.dokka", version = "2.0.0" }

0 commit comments

Comments
 (0)