Skip to content

Commit 8097e55

Browse files
committed
Add ability to add extra documentation pages
This CL adds a new homepage for the kmp docs that gets included in the main page. In a followup CL, i'll add the ability to have package docs. Bug: 249096220 Test: prod :o Change-Id: If23ec47d882835a5284477c140520fe08a35d935
1 parent 0f88057 commit 8097e55

File tree

3 files changed

+18
-3
lines changed

3 files changed

+18
-3
lines changed

buildSrc/private/src/main/kotlin/androidx/build/dokka/kmpDocs/DokkaCombinedDocsTask.kt

+10-2
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,10 @@ internal abstract class DokkaCombinedDocsTask @Inject constructor(
7979
@get:OutputDirectory
8080
abstract val outputDir: DirectoryProperty
8181

82+
@get:InputFiles
83+
@get:PathSensitive(PathSensitivity.RELATIVE)
84+
abstract val additionalDocumentation: Property<FileCollection>
85+
8286
@TaskAction
8387
fun buildCombinedDocs() {
8488
// create output dir before calling dokka to make sure relative links work.
@@ -114,7 +118,7 @@ internal abstract class DokkaCombinedDocsTask @Inject constructor(
114118
metadata to exportDir
115119
}
116120
val input = MergeDocsInputs(
117-
moduleName = "AndroidX KMP EAP Docs",
121+
moduleName = "Jetpack Multiplatform Preview Reference Documentation",
118122
outputDir = outputDir,
119123
pluginsClasspath = pluginsClasspath.get(),
120124
modules = partialModules.map { (module, docsDir) ->
@@ -127,7 +131,8 @@ internal abstract class DokkaCombinedDocsTask @Inject constructor(
127131
},
128132
pluginsConfiguration = listOf(
129133
PluginsConfiguration.ANDROIDX_COPYRIGHT
130-
)
134+
),
135+
includes = additionalDocumentation.get().files
131136
)
132137
docsJsonOutput.get().asFile.let {
133138
it.parentFile.mkdirs()
@@ -177,6 +182,9 @@ internal abstract class DokkaCombinedDocsTask @Inject constructor(
177182
it.dokkaCliClasspath.set(
178183
DokkaUtils.createCliJarConfiguration(project)
179184
)
185+
it.additionalDocumentation.set(
186+
project.files("homepage.md")
187+
)
180188
}
181189
}
182190
}

buildSrc/private/src/main/kotlin/androidx/build/dokka/kmpDocs/DokkaInputModels.kt

+2-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@ internal object DokkaInputModels {
4242
val moduleName: String,
4343
val pluginsClasspath: FileCollection,
4444
val modules: List<Module>,
45-
val pluginsConfiguration: List<PluginsConfiguration>
45+
val pluginsConfiguration: List<PluginsConfiguration>,
46+
val includes: Set<File>
4647
)
4748

4849
class Module(

docs-kmp/homepage.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Jetpack Multiplatform Preview Reference Documentation
2+
3+
This repository contains the reference documentation for the experimental Jetpack [Kotlin Multiplatform](https://kotlinlang.org/docs/multiplatform.html) preview libraries.
4+
5+
* [Announcement Blog Post](https://android-developers.googleblog.com/2022/10/announcing-experimental-preview-of-jetpack-multiplatform-libraries.html)
6+
* [Sample Application](https://github.com/android/kotlin-multiplatform-samples/tree/main/DiceRoller)

0 commit comments

Comments
 (0)