fix: enable intra-repo links in API ref docs (#711)

Author: ianbotsf

.changes/2ae86281-8a85-4470-bb85-618d857cb21b.json

@@ -0,0 +1,8 @@
+{
+    "id": "2ae86281-8a85-4470-bb85-618d857cb21b",
+    "type": "bugfix",
+    "description": "Enable intra-repo links in API ref docs",
+    "issues": [
+        "awslabs/aws-sdk-kotlin#715"
+    ]
+}

build.gradle.kts

@@ -84,6 +84,12 @@ if (project.prop("kotlinWarningsAsErrors")?.toString()?.toBoolean() == true) {
 tasks.dokkaHtmlMultiModule.configure {
     moduleName.set("Smithy Kotlin")
 
+    // Output subprojects' docs to <docs-base>/project-name/* instead of <docs-base>/path/to/project-name/*
+    // This is especially important for inter-repo linking (e.g., via externalDocumentationLink) because the
+    // package-list doesn't contain enough project path information to indicate where modules' documentation are
+    // located.
+    fileLayout.set { parent, child -> parent.outputDirectory.get().resolve(child.project.name) }
+
     includes.from(
         // NOTE: these get concatenated
         rootProject.file("docs/dokka-presets/README.md"),

gradle.properties

@@ -3,10 +3,7 @@ kotlin.incremental.js=true
 kotlin.incremental.multiplatform=true
 kotlin.mpp.stability.nowarn=true
 kotlin.native.ignoreDisabledTargets=true
-
-
-# FIXME - see https://youtrack.jetbrains.com/issue/KTIJ-21583/HMPP-1-6-20-breaks-autocomplete-in-multiplatform-composite-build
-#kotlin.mpp.hierarchicalStructureSupport=false
+kotlin.mpp.enableCompatibilityMetadataVariant=true
 
 # SDK
 sdkVersion=0.12.9-SNAPSHOT
@@ -46,4 +43,4 @@ kotlinLoggingVersion=2.1.21
 slf4jVersion=1.7.36
 
 # crt
-crtKotlinVersion=0.6.4
+crtKotlinVersion=0.6.5-SNAPSHOT