Skip to content

Commit 2feb2da

Browse files
committed
docs: Dokka V2
1 parent 143c943 commit 2feb2da

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ jobs:
3535
build-scan-terms-of-use-url: "https://gradle.com/terms-of-service"
3636
build-scan-terms-of-use-agree: "yes"
3737
- name: Generate docs
38-
run: ./gradlew dokkaHtml
38+
run: ./gradlew dokkaGenerate
3939
- name: Upload artifact
4040
uses: actions/upload-pages-artifact@v3
4141
with:

build.gradle.kts

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
import org.gradle.jvm.tasks.Jar
2-
import org.jetbrains.dokka.gradle.DokkaTask
32
import org.jetbrains.kotlin.gradle.dsl.JvmTarget
43
import java.net.URI
54
import java.util.*
@@ -177,21 +176,21 @@ tasks.withType<AbstractArchiveTask>().configureEach {
177176
isReproducibleFileOrder = true
178177
}
179178

180-
tasks.withType<DokkaTask> {
179+
dokka {
180+
moduleName = "kotlinx-serialization-bencoding"
181181
dokkaSourceSets.configureEach {
182+
includes.from("module.md")
182183
sourceLink {
183184
localDirectory = project.layout.projectDirectory.dir("src").asFile
184185
val p =
185186
project.layout.projectDirectory.dir("src").asFile.relativeTo(rootProject.layout.projectDirectory.asFile)
186-
.toString()
187-
.replace('\\', '/')
188-
remoteUrl = URI.create("https://github.com/iseki0/kotlinx-serialization-bencoding/tree/master/$p").toURL()
187+
.toString().replace('\\', '/')
188+
remoteUrl = URI.create("https://github.com/iseki0/kotlinx-serialization-bencoding/tree/master/$p")
189189
remoteLineSuffix = "#L"
190190
}
191-
externalDocumentationLink {
192-
url = URI.create("https://kotlinlang.org/api/kotlinx.serialization/").toURL()
191+
externalDocumentationLinks.create("") {
192+
url = URI.create("https://kotlinlang.org/api/kotlinx.serialization/")
193193
}
194-
includes.from("module.md")
195194
}
196195
}
197196

gradle.properties

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
kotlin.code.style=official
2+
org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled

0 commit comments

Comments
 (0)