diff options
| -rw-r--r-- | examples/gradle/dokka-multimodule-example/parentProject/build.gradle.kts | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/examples/gradle/dokka-multimodule-example/parentProject/build.gradle.kts b/examples/gradle/dokka-multimodule-example/parentProject/build.gradle.kts index da7b382e..7fb7c115 100644 --- a/examples/gradle/dokka-multimodule-example/parentProject/build.gradle.kts +++ b/examples/gradle/dokka-multimodule-example/parentProject/build.gradle.kts @@ -1,5 +1,6 @@ import org.jetbrains.dokka.DokkaConfiguration.Visibility import org.jetbrains.dokka.gradle.DokkaTaskPartial +import java.net.URL plugins { kotlin("jvm") @@ -17,6 +18,21 @@ subprojects { Visibility.PUBLIC, Visibility.PROTECTED )) + + // In multi-project builds, `remoteUrl` must point to that project's dir specifically, so if you + // want to configure sourceLinks at once in `subprojects {}`, you have to find the relative path. + // Alternatively, you can move this configuration up into subproject build scripts, + // and just hardcode the exact paths as demonstrated in the basic dokka-gradle-example. + // + // Read docs for more details: https://kotlinlang.org/docs/dokka-gradle.html#source-link-configuration + sourceLink { + val exampleDir = "https://github.com/Kotlin/dokka/tree/master/examples/gradle/dokka-multimodule-example" + val projectRelativePath = rootProject.projectDir.toPath().relativize(projectDir.toPath()) + + localDirectory.set(projectDir.resolve("src")) + remoteUrl.set(URL("$exampleDir/$projectRelativePath/src")) + remoteLineSuffix.set("#L") + } } } } |