From 466fadaad8229b7a7538bced00ce417ce6ee611b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Enrique=20Lo=CC=81pez=20Man=CC=83as?= Date: Thu, 20 Nov 2025 20:29:48 +0100 Subject: [PATCH] docs: updated dokka --- .github/workflows/docs.yml | 4 ++-- .gitignore | 1 + .../src/main/kotlin/dokka-convention.gradle.kts | 15 +++++++++++++++ build.gradle.kts | 2 +- docs/build.gradle.kts | 14 ++++++++++++++ maps-compose-utils/build.gradle.kts | 1 + maps-compose-widgets/build.gradle.kts | 1 + maps-compose/build.gradle.kts | 7 +++++++ settings.gradle.kts | 3 ++- 9 files changed, 44 insertions(+), 4 deletions(-) create mode 100644 build-logic/convention/src/main/kotlin/dokka-convention.gradle.kts create mode 100644 docs/build.gradle.kts diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 49542c60..1c376e61 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -43,10 +43,10 @@ jobs: # Run dokka and create tar - name: Generate documentation run: | - ./gradlew dokkaHtmlMultiModule + ./gradlew docs:dokkaGenerate echo "Creating tar for generated docs" - cd $GITHUB_WORKSPACE/build/dokka/htmlMultiModule && tar cvf ~/maps-compose-docs.tar . + cd $GITHUB_WORKSPACE/docs/build/dokka/html && tar cvf ~/maps-compose-docs.tar . echo "Unpacking tar into gh-pages branch" git fetch --no-tags --prune --depth=1 origin +refs/heads/*:refs/remotes/origin/* diff --git a/.gitignore b/.gitignore index fb7923f0..fc045a29 100644 --- a/.gitignore +++ b/.gitignore @@ -11,6 +11,7 @@ /.idea/assetWizardSettings.xml .DS_Store /build +build/ /captures .externalNativeBuild .cxx diff --git a/build-logic/convention/src/main/kotlin/dokka-convention.gradle.kts b/build-logic/convention/src/main/kotlin/dokka-convention.gradle.kts new file mode 100644 index 00000000..04446396 --- /dev/null +++ b/build-logic/convention/src/main/kotlin/dokka-convention.gradle.kts @@ -0,0 +1,15 @@ +/** + * Common conventions for generating documentation with Dokka. + */ + +plugins { + id("org.jetbrains.dokka") +} + +dokka { + dokkaSourceSets.configureEach { + sourceLink { + localDirectory.set(rootDir) + } + } +} \ No newline at end of file diff --git a/build.gradle.kts b/build.gradle.kts index fba9afd0..099c6381 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -14,7 +14,7 @@ buildscript { } plugins { - alias(libs.plugins.dokka) apply true + id("org.jetbrains.dokka") version "2.1.0" alias(libs.plugins.compose.compiler) apply false id("com.autonomousapps.dependency-analysis") version "3.4.1" alias(libs.plugins.android.application) apply false diff --git a/docs/build.gradle.kts b/docs/build.gradle.kts new file mode 100644 index 00000000..c0727f4f --- /dev/null +++ b/docs/build.gradle.kts @@ -0,0 +1,14 @@ +plugins { + kotlin("jvm") apply false + id("org.jetbrains.dokka") +} + +dependencies { + dokka(project(":maps-compose")) + dokka(project(":maps-compose-utils")) + dokka(project(":maps-compose-widgets")) +} + +dokka { + moduleName.set("Android Maps Compose") +} \ No newline at end of file diff --git a/maps-compose-utils/build.gradle.kts b/maps-compose-utils/build.gradle.kts index d0583c13..158c025e 100644 --- a/maps-compose-utils/build.gradle.kts +++ b/maps-compose-utils/build.gradle.kts @@ -4,6 +4,7 @@ plugins { id("kotlin-android") alias(libs.plugins.compose.compiler) id("android.maps.compose.PublishingConventionPlugin") + id("org.jetbrains.dokka") } android { diff --git a/maps-compose-widgets/build.gradle.kts b/maps-compose-widgets/build.gradle.kts index 726f8c53..4a7f3b1e 100644 --- a/maps-compose-widgets/build.gradle.kts +++ b/maps-compose-widgets/build.gradle.kts @@ -4,6 +4,7 @@ plugins { id("kotlin-android") alias (libs.plugins.compose.compiler) id("android.maps.compose.PublishingConventionPlugin") + id("org.jetbrains.dokka") } android { diff --git a/maps-compose/build.gradle.kts b/maps-compose/build.gradle.kts index a5a9ff11..a4043f3e 100644 --- a/maps-compose/build.gradle.kts +++ b/maps-compose/build.gradle.kts @@ -3,6 +3,7 @@ import org.jetbrains.kotlin.gradle.dsl.JvmTarget plugins { id("org.jetbrains.kotlin.android") alias(libs.plugins.compose.compiler) + id("org.jetbrains.dokka") id("android.maps.compose.PublishingConventionPlugin") } @@ -98,3 +99,9 @@ val generateArtifactIdFile = tasks.register("generateArtifactIdFile") { tasks.named("preBuild") { dependsOn(generateArtifactIdFile) } + +dokka { + dokkaSourceSets.configureEach { + + } +} \ No newline at end of file diff --git a/settings.gradle.kts b/settings.gradle.kts index d35121d1..3366f3c6 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -18,4 +18,5 @@ rootProject.name = "android-maps-compose" include(":maps-app") include(":maps-compose") include(":maps-compose-widgets") -include(":maps-compose-utils") \ No newline at end of file +include(":maps-compose-utils") +include(":docs") \ No newline at end of file