File tree Expand file tree Collapse file tree 4 files changed +44
-0
lines changed Expand file tree Collapse file tree 4 files changed +44
-0
lines changed Original file line number Diff line number Diff line change @@ -6,6 +6,7 @@ import org.jetbrains.kotlin.gradle.dsl.JvmTarget
6
6
7
7
plugins {
8
8
id(" kotlin-multiplatform" )
9
+ id(" org.jetbrains.dokka" )
9
10
`maven- publish`
10
11
}
11
12
@@ -140,6 +141,29 @@ kotlin {
140
141
}
141
142
}
142
143
144
+ dokka {
145
+ pluginsConfiguration.html {
146
+ templatesDir.set(projectDir.resolve(" dokka-templates" ))
147
+ }
148
+
149
+ dokkaPublications.html {
150
+ failOnWarning.set(true )
151
+ // Enum members and undocumented toString()
152
+ suppressInheritedMembers.set(true )
153
+ }
154
+
155
+ dokkaSourceSets.configureEach {
156
+ val platform = name.dropLast(4 )
157
+ samples.from(" $platform /test" )
158
+ skipDeprecated.set(true )
159
+ sourceLink {
160
+ localDirectory.set(rootDir)
161
+ remoteUrl(" https://github.com/Kotlin/kotlinx.collections.immutable/tree/v0.4.0" )
162
+ remoteLineSuffix.set(" #L" )
163
+ }
164
+ }
165
+ }
166
+
143
167
tasks {
144
168
named(" jvmTest" , Test ::class ) {
145
169
maxHeapSize = " 1024m"
Original file line number Diff line number Diff line change
1
+ # Dokka's template customization
2
+ To provide unified navigation for all parts of [ kotlinlang.org] ( https://kotlinlang.org/ ) ,
3
+ the Kotlin Website Team uses this directory to place custom templates in this folder
4
+ during the website build time on TeamCity.
5
+
6
+ It is not practical to place these templates in the kotlinx.collections.immutable repository because they change from time to time
7
+ and aren't related to the library's release cycle.
8
+
9
+ The folder is defined as a source for custom templates by the templatesDir property through Dokka's plugin configuration.
10
+
11
+ [ Here] ( https://kotlinlang.org/docs/dokka-html.html#templates ) , you can
12
+ find more about the customization of Dokka's HTML output.
Original file line number Diff line number Diff line change @@ -3,5 +3,9 @@ version=0.4
3
3
versionSuffix =SNAPSHOT
4
4
5
5
kotlin_version =2.1.20
6
+ dokkaVersion =2.0.0
6
7
7
8
org.gradle.jvmargs =-Xmx2g -XX:MaxMetaspaceSize =2048m -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding =UTF-8
9
+
10
+ org.jetbrains.dokka.experimental.gradle.pluginMode =V2Enabled
11
+ org.jetbrains.dokka.experimental.gradle.pluginMode.nowarn =true
Original file line number Diff line number Diff line change @@ -8,6 +8,10 @@ pluginManagement {
8
8
maven(kotlinRepoUrl)
9
9
}
10
10
}
11
+ val dokkaVersion: String by settings
12
+ plugins {
13
+ id(" org.jetbrains.dokka" ) version dokkaVersion
14
+ }
11
15
}
12
16
13
17
rootProject.name = " Kotlin-Immutable-Collections" // TODO: Make readable name when it's not used in js module names
You can’t perform that action at this time.
0 commit comments