configure dokka to use generated samples (#1143)

awslabs · Dec 20, 2023 · 605dc26 · 605dc26
1 parent 705662f
commit 605dc26
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 0 deletions.
diff --git a/.changes/93140368-5000-4614-9f21-e9f1cf76f2ee.json b/.changes/93140368-5000-4614-9f21-e9f1cf76f2ee.json
@@ -0,0 +1,8 @@
+{
+    "id": "93140368-5000-4614-9f21-e9f1cf76f2ee",
+    "type": "feature",
+    "description": "Generate KDoc samples from modeled examples",
+    "issues": [
+        "awslabs/aws-sdk-kotlin#239"
+    ]
+}
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -72,6 +72,10 @@ allprojects {
             }
         }
 
+        dokkaSourceSets.configureEach {
+            samples.from(project.file("samples").path, project.file("generated-src/samples").path)
+        }
+
         val smithyKotlinPackageListUrl: String? by project
         val smithyKotlinDocBaseUrl: String? by project
 

diff --git a/docs/dokka-presets/css/aws-styles.css b/docs/dokka-presets/css/aws-styles.css
@@ -55,3 +55,11 @@
 .symbol {
     overflow-wrap: break-word;
 }
+
+/*
+    Disable the playground run button for generated samples
+    https://github.com/Kotlin/dokka/issues/3041
+*/
+div .compiler-info, .fold-button, .run-button {
+    display: none;
+}