Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

configure dokka to use generated samples #1143

Merged
merged 2 commits into from
Dec 20, 2023
Merged

configure dokka to use generated samples #1143

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
58d0130
configure dokka to use generated samples
aajtodd Dec 1, 2023
0819b23
changelog and disable playground run button
aajtodd Dec 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changes/93140368-5000-4614-9f21-e9f1cf76f2ee.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"
]
}
4 changes: 4 additions & 0 deletions build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 8 additions & 0 deletions docs/dokka-presets/css/aws-styles.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
Loading